Atualizar customClaimsPolicy

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.

Atualizar um objeto customClaimsPolicy .

Essa API está disponível nas seguintes implantações de nuvem nacional.

Serviço global Governo dos EUA L4 US Government L5 (DOD) China operada pela 21Vianet

Permissões

Escolha a(s) permissão(s) marcada(s) como menos privilegiada(s) para essa API. Use uma permissão ou permissões com privilégios mais altos 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 com privilégios mais elevados
Delegado (conta corporativa ou de estudante) Policy.ReadWrite.ApplicationConfiguration Indisponível.
Delegado (conta pessoal da Microsoft) Sem suporte. Sem suporte.
Application Policy.ReadWrite.ApplicationConfiguration Indisponível.

Importante

Para acesso delegado usando contas corporativas ou de estudante, o usuário conectado deve receber uma função do Microsoft Entra com suporte ou uma função personalizada que conceda as permissões necessárias para esta operação. Administrador de Aplicativos é a função com menos privilégios com suporte para esta operação.

Solicitação HTTP

PATCH /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ásico está incluído nos 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 eles 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 substitui o conteúdo da reivindicaçã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 será ignorado. O valor fornecido deve estar no formato de um URI absoluto. Opcional.
de sinistros 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 código de 201 Created resposta e um objeto customClaimsPolicy no corpo da resposta.

Exemplos

Solicitação

O exemplo a seguir mostra uma solicitação.

PATCH 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"
    }
  ]
}