tipo de recurso claimsMappingPolicy

Artigo
03/26/2023

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 declarações para protocolos WS-Fed, SAML, OAuth 2.0 e OpenID Connect, para tokens emitidos em um aplicativo específico. Você pode usar políticas de mapeamento de declarações para:

Selecione quais declarações estão incluídas em tokens
Criar tipos de declaração que ainda não existem
Escolha ou altere a origem 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 o limite ter sido atingido são ignoradas e 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

Para obter mais detalhes de cenário e configuração, consulte Tipo de política de mapeamento de declarações e Como personalizar declarações emitidas em tokens para um aplicativo específico em um locatário.

Herda de stsPolicy.

Métodos

Método	Tipo de retorno	Descrição
Criar claimsMappingPolicy	claimsMappingPolicy	Crie um objeto claimsMappingPolicy.
Obter declaraçõesMappingPolicy	claimsMappingPolicy	Leia propriedades e relações de um objeto claimsMappingPolicy.
Listar claimsMappingPolicies	claimsMappingPolicy	Leia propriedades e relações de objetos claimsMappingPolicies.
Atualizar declaraçõesMappingPolicy	Nenhum	Atualize um objeto claimsMappingPolicy.
Excluir declaraçõesMappingPolicy	Nenhum	Exclua um objeto claimsMappingPolicy.
Objetos de diretório
Lista appliesTo	Coleção directoryObject	Obtenha a lista de diretórios aos quais essa política foi aplicada.
Atribuir claimsMappingPolicy	Nenhum	Atribua uma claimsMappingPolicy a um objeto servicePrincipal .
Listar declarações atribuídasMappingPolicy	Conjunto claimsMappingPolicy	Liste os objetos claimsMappingPolicy atribuídos a um objeto servicePrincipal .
Remover claimsMappingPolicy	Nenhum	Remova uma claimsMappingPolicy de um objeto servicePrincipal .

Propriedades

Propriedade	Tipo	Descrição
id	Cadeia de caracteres	Identificador exclusivo para essa política. Somente leitura.
Definição	Coleção de cadeias de caracteres	Uma coleção de cadeias de caracteres que contém uma cadeia de caracteres JSON que define as regras e as configurações dessa política. Confira abaixo mais detalhes sobre o esquema JSON desta propriedade. Obrigatório.
displayName	Cadeia de caracteres	Nome de exibição para essa política. Obrigatório.
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

As propriedades abaixo formam o objeto JSON que representa uma política de mapeamento de declarações. Este objeto JSON deve ser convertido em uma cadeia de caracteres com aspas escapadas para serem inseridas na propriedade de definição . Alguns exemplos de definição são mostrados abaixo:

Exemplo: definição para incluir o EmployeeID e o 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
Versão	Número inteiro	Defina o valor de 1. Obrigatório.
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 estão nos tokens, a menos que sejam adicionadas individualmente na propriedade ClaimsSchema da mesma política.
ClaimsSchema	Objeto JSON	Define quais declarações estão presentes nos tokens afetados pela política, além do conjunto básico de declarações e do conjunto de declarações principais. Para cada entrada de esquema de declaração definida nesta propriedade, determinadas informações são necessárias. Especifique de onde os dados são provenientes (par Valor ou Origem/ID) e qual declaração os dados são emitidos como (Tipo de Declaração). No máximo 50 declarações são incluídas no token por meio do objeto ClaimsSchema. Todas as entradas de esquema de declarações encontradas após o limite ter sido atingido serão ignoradas e não aparecerão no token emitido. Mais detalhes estão disponíveis 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 declarações especificadas no ClaimsSchema. No máximo 50 transformações são incluídas no token por meio do objeto ClaimsTransformation. Todas as transformações encontradas após o limite ter sido atingido serão ignoradas e não aparecerão no token emitido. Para obter mais informações sobre ClaimsTransformation e as funções com suporte, confira Transformação de declarações.

Relações

Relação	Tipo	Descrição
Appliesto	Coleção directoryObject	A coleção directoryObject à qual essa política foi aplicada. 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,
}