claimsMappingPolicy resource type

Artigo
12/05/2024

Namespace: microsoft.graph

Importante

As APIs na versão /beta no Microsoft Graph estão sujeitas a alterações. Não há suporte para o uso dessas APIs em aplicativos de produção. Para determinar se uma API está disponível na v1.0, use o seletor Versão.

Representa as políticas de mapeamento de afirmações para os protocolos WS-Fed, SAML, OAuth 2.0 e OpenID Connect para tokens emitidos para uma aplicação específica. Pode utilizar políticas de mapeamento de afirmações para:

Selecionar as afirmações incluídas nos tokens
Criar tipos de afirmação que ainda não existem
Escolher ou alterar a origem de dados emitidos em afirmações específicas

O número de afirmações e transformações que podem ser adicionadas a uma política de mapeamento de afirmações está limitado para reduzir o tamanho do token. Todas as entradas de esquema de afirmações ou transformações encontradas após o limite ser atingido são ignoradas e não são incluídas no token emitido. Para obter mais informações sobre os limites, veja Propriedades de uma definição de política de mapeamento de afirmações

Para obter mais detalhes de cenário e configuração, veja Tipo de política de mapeamento de afirmações e Como: Personalizar afirmações emitidas em tokens para uma aplicação específica num inquilino.

Além disso, visite Personalização de afirmações através de uma política para saber a diferença entre esta política e a política de afirmações personalizadas.

Herda de stsPolicy.

Métodos

Método	Tipo de retorno	Descrição
List	claimsMappingPolicy	Leia as propriedades e as relações dos objetos claimsMappingPolicies.
Create	claimsMappingPolicy	Crie um objeto claimsMappingPolicy.
Get	claimsMappingPolicy	Ler propriedades e relações de um objeto claimsMappingPolicy.
Atualizar	Nenhum(a)	Atualizar um objeto claimsMappingPolicy.
Delete	Nenhum	Eliminar um objeto claimsMappingPolicy.
A lista aplica-se a	Coleção directoryObject	Obtenha a lista de directoryObjects aos quais esta política foi aplicada.
Atribuir ao principal de serviço	Nenhum	Atribua uma claimsMappingPolicy a um objeto servicePrincipal .
Lista atribuída ao principal de serviço	Conjunto claimsMappingPolicy	Liste os objetos claimsMappingPolicy atribuídos a um objeto servicePrincipal .
Anular a atribuição do principal de serviço	Nenhum	Remova uma claimsMappingPolicy de um objeto servicePrincipal .

Propriedades

Propriedade	Tipo	Descrição
id	Cadeia de caracteres	Identificador exclusivo para esta política. Somente leitura.
definição	String collection	Uma coleção de cadeias que contém uma cadeia JSON que define as regras e definições para esta política. Para obter mais informações sobre o esquema JSON para esta propriedade, veja Propriedades de uma definição de política de mapeamento de afirmações. Obrigatório.
displayName	Cadeia de caracteres	Nome a apresentar para esta política. Obrigatório.
isOrganizationDefault	Booliano	Ignore esta propriedade. A política de mapeamento de afirmações só pode ser aplicada aos principais de serviço e não pode ser definida globalmente para a organização.

Propriedades de uma definição de política de mapeamento de afirmações

O objeto JSON a ser inserido na propriedade de definição tem primeiro de ser convertido numa cadeia com aspas escapadas. Esta secção mostra alguns exemplos de definição.

Exemplo: definição para incluir EmployeeID e TenantCountry como afirmações em tokens

{
    "definition": [
        "{\"ClaimsMappingPolicy\":{\"Version\":1,\"IncludeBasicClaimSet\":\"true\",\"ClaimsSchema\": [{\"Source\":\"user\",\"ID\":\"employeeid\",\"SamlClaimType\":\"http://schemas.xmlsoap.org/ws/2005/05/identity/claims/name\",\"JwtClaimType\":\"name\"},{\"Source\":\"company\",\"ID\":\"tenantcountry\",\"SamlClaimType\":\"http://schemas.xmlsoap.org/ws/2005/05/identity/claims/country\",\"JwtClaimType\":\"country\"}]}}"
    ],
    "displayName": "Test1234"
}

Exemplo: definição que utiliza uma transformação de afirmações

{
    "definition": [
        "{\"ClaimsMappingPolicy\":{\"Version\":1,\"IncludeBasicClaimSet\":\"true\",\"ClaimsSchema\": [{\"Source\":\"user\",\"ID\":\"userprincipalname\",\"SamlClaimType\":\"http://schemas.xmlsoap.org/ws/2005/05/identity/claims/nameidentifier\"},{\"Source\":\"user\",\"ID\":\"givenname\",\"SamlClaimType\":\"http://schemas.xmlsoap.org/ws/2005/05/identity/claims/givenname\"},{\"Source\":\"user\",\"ID\":\"displayname\",\"SamlClaimType\":\"http://schemas.xmlsoap.org/ws/2005/05/identity/claims/name\"},{\"Source\":\"user\",\"ID\":\"surname\",\"SamlClaimType\":\"http://schemas.xmlsoap.org/ws/2005/05/identity/claims/surname\"},{\"Source\":\"user\",\"ID\":\"userprincipalname\",\"SamlClaimType\":\"username\"}],\"ClaimsTransformation\":[{\"ID\":\"CreateTermsOfService\",\"TransformationMethod\":\"CreateStringClaim\",\"InputParameters\": [{\"ID\":\"value\",\"DataType\":\"string\", \"Value\":\"sandbox\"}],\"OutputClaims\":[{\"ClaimTypeReferenceId\":\"TOS\",\"TransformationClaimType\":\"createdClaim\"}]}]}}"
    ],
    "displayName": "Test1234"
}

Propriedade	Tipo	Descrição
Versão	Número inteiro	Defina o valor de 1. Obrigatório.
IncludeBasicClaimSet	Booliano	Se definido como `true`, todas as afirmações no conjunto de afirmações básicas são emitidas em tokens afetados pela política. Se definido como `false`, as afirmações no conjunto de afirmações básicas não estão nos tokens, a menos que sejam adicionadas individualmente na propriedade ClaimsSchema da mesma política.
ClaimsSchema	Objeto JSON	Define que afirmações estão presentes nos tokens afetados pela política, além do conjunto de afirmações básico e do conjunto de afirmações principais. Para cada entrada de esquema de afirmação definida nesta propriedade, são necessárias determinadas informações. Especifique a origem dos dados (par Valor ou Origem/ID) e a afirmação de que os dados são emitidos como (Tipo de Afirmação). Um máximo de 50 afirmações estão incluídas no token através do objeto ClaimsSchema. Todas as entradas de esquema de afirmações encontradas após o limite ser atingido são ignoradas e não aparecem no token emitido. Estão disponíveis mais detalhes na definição ClaimsSchema.
ClaimsTransformation	Objeto JSON	Define transformações comuns que podem ser aplicadas aos dados de origem, para gerar os dados de saída para afirmações especificadas no ClaimsSchema. Um máximo de 50 transformações são incluídas no token através do objeto ClaimsTransformation. Todas as transformações encontradas após o limite ser atingido são ignoradas e não aparecem no token emitido. Para obter mais informações sobre ClaimsTransformation e as funções suportadas, veja Transformação de afirmações.

Relações

Relação	Tipo	Descrição
aplicaTo	Coleção directoryObject	A coleção directoryObject à qual esta política foi aplicada. Somente leitura.

Representação JSON

A representação JSON seguinte mostra o tipo de recurso.

{
  "definition": ["String"],
  "displayName": "String",
  "id": "String (identifier)",
  "isOrganizationDefault": false,
}

Partilhar via