claimsMappingPolicy tipo de recurso

Namespace: microsoft.graph

Representa as políticas de mapeamento de declaração para os protocolos WS-Fed, SAML, OAuth 2.0 e OpenID Connect, para tokens emitidos para um aplicativo específico. Você pode usar políticas de mapeamento de declarações para:

  • Selecione quais declarações estão incluídas nos tokens
  • Criar tipos de declaração que ainda não existem
  • Escolher ou alterar a fonte dos dados emitidos em declarações específicas

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

Herda de stsPolicy.

Para obter mais cenários e detalhes de configuração, consulte os seguintes artigos:

Métodos

Método Tipo de retorno Descrição
List claimsMappingPolicy Leia propriedades e relações de objetos claimsMappingPolicies.
Create claimsMappingPolicy Crie um objeto claimsMappingPolicy.
Get claimsMappingPolicy Leia as propriedades e as relações de um objeto claimsMappingPolicy.
Atualizar Nenhum(a) Atualize um objeto claimsMappingPolicy.
Delete Nenhum Exclua um objeto claimsMappingPolicy.
A lista se aplica a Coleção directoryObject Obtenha a lista de directoryObjects aos quais essa política se aplica.
Atribuir à entidade de serviço Nenhum Atribua um claimsMappingPolicy a um objeto servicePrincipal .
Lista atribuída à entidade de serviço Conjunto claimsMappingPolicy Liste os objetos claimsMappingPolicy atribuídos a um objeto servicePrincipal .
Cancelar atribuição da entidade de serviço Nenhum Remova um claimsMappingPolicy de um objeto servicePrincipal .

Propriedades

Propriedade Tipo Descrição
definição String collection Uma coleção de cadeias de caracteres que contém uma cadeia de caracteres JSON que define as regras e configurações dessa política. Para obter mais informações sobre o esquema JSON dessa propriedade, consulte Propriedades de uma definição de política de mapeamento de declarações. Obrigatório.
displayName Cadeia de caracteres Nome de exibição para esta política. Obrigatório.
id Cadeia de caracteres Identificador exclusivo dessa política. Somente leitura.
isOrganizationDefault Booliano Ignore essa propriedade. A política de mapeamento de declarações só pode ser aplicada a entidades 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 declarações

O objeto JSON a ser inserido na propriedade de definição deve primeiro ser convertido em uma cadeia de caracteres com aspas escapadas. Esta seção mostra alguns exemplos de definição.

Exemplo: definição para incluir EmployeeID e TenantCountry como declaraçõ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 usa uma transformação de declaraçõ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
ClaimsSchema Objeto JSON Define quais declarações estão presentes nos tokens afetados pela política, além do conjunto de declarações básicas e do conjunto de declarações principais. Para cada entrada de esquema de declaração definida nessa propriedade, certas informações são necessárias. Especifique de onde os dados são provenientes (valor ou par origem/ID) e qual declaração os dados são emitidos como (tipo de declaração). Um máximo de 50 declarações estão incluídas no token por meio do objeto ClaimsSchema. Todas as entradas de esquema de declarações encontradas após atingir o limite são ignoradas e não aparecem no token emitido. Mais detalhes estão disponíveis na definição e nas propriedades de ClaimsSchemada política usada para personalização de declarações.
ClaimsTransformation Objeto JSON Define transformações comuns que podem ser aplicadas aos dados de origem, para gerar os dados de saída para declarações especificadas no ClaimsSchema. Um máximo de 50 transformações são incluídas no token por meio do objeto ClaimsTransformation. Todas as transformações encontradas após atingir o limite são ignoradas e não aparecem no token emitido. Para obter mais informações sobre ClaimsTransformation e as funções com suporte, consulte Transformação de declarações.
IncludeBasicClaimSet Booliano Se definido como true, todas as declarações no conjunto de declarações básicas serão emitidas em tokens afetados pela política. Se definido como false, as declarações no conjunto de declarações básicas não estarão nos tokens, a menos que sejam adicionadas individualmente na propriedade ClaimsSchema da mesma política.
Versão Número inteiro Defina o valor de 1. Obrigatório.

Relações

Relação Tipo Descrição
appliesTo Coleção directoryObject A coleção directoryObject à qual essa política se aplica. Somente leitura.

Representação JSON

A representação JSON a seguir mostra o tipo de recurso.

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