Compartilhar via

Create ou substituir declaraçõesPolicy

  • Artigo

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.

Create um novo objeto CustomClaimsPolicy se ele não existir ou substituir um existente.

Permissões

Escolha a permissão ou as permissões marcadas como menos privilegiadas para essa API. Use uma permissão ou permissões privilegiadas mais altas somente se o aplicativo exigir. Para obter detalhes sobre permissões delegadas e de aplicativo, consulte Tipos de permissão. Para saber mais sobre essas permissões, consulte a referência de permissões.

Tipo de permissão Permissões menos privilegiadas Permissões privilegiadas mais altas
Delegado (conta corporativa ou de estudante) Policy.Read.ApplicationConfiguration Policy.ReadWrite.ApplicationConfiguration
Delegado (conta pessoal da Microsoft) Sem suporte. Sem suporte.
Application Policy.Read.ApplicationConfiguration Policy.ReadWrite.ApplicationConfiguration

Para cenários delegados em que um administrador está agindo em outro usuário, o administrador precisa de pelo menos uma das seguintes funções Microsoft Entra.

  • Administrador de Aplicativos

Solicitação HTTP

PUT /servicePrincipals/{servicePrincipalsId}/claimsPolicy

Cabeçalhos de solicitação

Nome Descrição
Autorização {token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização.
Content-Type application/json. Obrigatório.

Corpo da solicitação

No corpo da solicitação, forneça uma representação JSON do objeto customClaimsPolicy .

Você pode especificar as propriedades a seguir ao criar um CustomClaimsPolicy.

Propriedade Tipo Descrição
includeBasicClaimSet Booliano Determina se o conjunto de declarações básicas está incluído em tokens afetados por essa política. Se definido como true, todas as declarações no conjunto de declarações básicas serão emitidas em tokens afetados pela política. Por padrão, o conjunto de declarações básicas não está nos tokens, a menos que estejam explicitamente configurados nesta política. Opcional.
includeApplicationIdInIssuer Booliano Indica se a ID do aplicativo é adicionada à declaração. Ele é relevante apenas para SAML2.0 e se uma chave de assinatura personalizada for usada. o valor padrão é true. Opcional.
audienceOverride Cadeia de caracteres Se especificado, ele substituirá o conteúdo da declaração de audiência para protocolos WS-Federation e SAML2. Uma chave de assinatura personalizada deve ser usada para que audienceOverride seja aplicado, caso contrário, o valor audienceOverride é ignorado. O valor fornecido deve estar no formato de um URI absoluto. Opcional.
Reivindicações coleção customClaimBase Define quais declarações estão presentes nos tokens afetados pela política, além da declaração básica e do conjunto de declarações principais. Opcional.

Resposta

Se for bem-sucedido, esse método retornará um 204 código de resposta e um objeto CustomClaimsPolicy no corpo da resposta.

Exemplos

Solicitação

O exemplo a seguir mostra uma solicitação.

PUT https://graph.microsoft.com/beta/servicePrincipals/{servicePrincipalsId}/claimsPolicy
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.customClaimsPolicy",
  "includeBasicClaimSet": "Boolean",
  "includeApplicationIdInIssuer": "Boolean",
  "audienceOverride": "String",
  "claims": [
    {
      "@odata.type": "microsoft.graph.customClaim"
    }
  ]
}

Resposta

O exemplo a seguir mostra a resposta.

Observação: o objeto de resposta mostrado aqui pode ser encurtado para legibilidade.

HTTP/1.1 201 Created
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.customClaimsPolicy",
  "id": "f914f36d-167e-3fa7-cfa2-355cc5a36689",
  "includeBasicClaimSet": "Boolean",
  "includeApplicationIdInIssuer": "Boolean",
  "audienceOverride": "String",
  "claims": [
    {
      "@odata.type": "microsoft.graph.customClaim"
    }
  ]
}