Partilhar via

servicePrincipal: addPassword

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.

Adicione uma palavra-passe segura ou um segredo a um objeto servicePrincipal .

Permissões

Escolha a permissão ou permissões marcadas como menos privilegiadas para esta API. Utilize uma permissão ou permissões com privilégios mais elevados apenas se a sua aplicação o exigir. Para obter detalhes sobre as permissões delegadas e de aplicação, veja Tipos de permissão. Para saber mais sobre estas permissões, veja a referência de permissões.

Tipo de permissão Permissões com menos privilégios Permissões com privilégios superiores
Delegado (conta corporativa ou de estudante) Application.ReadWrite.All Directory.ReadWrite.All
Delegado (conta pessoal da Microsoft) Sem suporte. Sem suporte.
Application Application.ReadWrite.OwnedBy Application.ReadWrite.All, Directory.ReadWrite.All

Importante

Em cenários delegados com contas escolares ou profissionais, o utilizador com sessão iniciada tem de ter uma função de Microsoft Entra suportada ou uma função personalizada com uma permissão de função suportada. As seguintes funções com menos privilégios são suportadas para esta operação.

  • Um utilizador membro não administrador com permissões de utilizador predefinidas – para aplicações que possui
  • Programador de Aplicações – para aplicações que possuem
  • Administrador de Aplicativos de Nuvem
  • Administrador de Aplicativos

Solicitação HTTP

Pode abordar o principal de serviço com o respetivo ID ou appId. O id e o appId são referidos como o ID do Objeto e o ID da Aplicação (Cliente), respetivamente, nos registos de aplicações no centro de administração do Microsoft Entra.

POST /servicePrincipals/{id}/addPassword
POST /servicePrincipals(appId='{appId}')/addPassword

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 do pedido, forneça um objeto passwordCredential vazio ou com as seguintes propriedades opcionais.

Propriedade Tipo Descrição
displayName Cadeia de caracteres Nome amigável para a palavra-passe. Opcional.
endDateTime DateTimeOffset A data e hora em que a palavra-passe expira é representada com o formato ISO 8601 e está sempre na hora UTC. Por exemplo, meia-noite UTC em 1 de janeiro de 2014 é 2014-01-01T00:00:00Z. Opcional. O valor predefinido é "startDateTime + 2 anos".
startDateTime DateTimeOffset A data e hora em que a palavra-passe se torna válida. O tipo Timestamp representa informações de data e hora usando o formato ISO 8601 e está sempre no horário UTC. Por exemplo, meia-noite UTC em 1 de janeiro de 2014 é 2014-01-01T00:00:00Z. Opcional. O valor predefinido é "now".

Resposta

Se for bem-sucedido, este método devolve um 200 OK código de resposta e um novo objeto passwordCredential no corpo da resposta. A propriedade secretText no objeto de resposta contém as palavras-passe fortes ou segredos gerados por Microsoft Entra ID com 16 a 64 carateres de comprimento. Não existe nenhuma forma de obter esta palavra-passe no futuro.

Exemplos

O exemplo a seguir mostra como chamar essa API.

Solicitação

O exemplo a seguir mostra uma solicitação.

POST https://graph.microsoft.com/beta/servicePrincipals/{id}/addPassword
Content-type: application/json

{
  "passwordCredential": {
    "displayName": "Password friendly name"
  }
}

Resposta

O exemplo a seguir mostra a resposta.

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

HTTP/1.1 200 OK
Content-type: application/json

{
    "customKeyIdentifier": null,
    "endDateTime": "2021-09-09T19:50:29.3086381Z",
    "keyId": "f0b0b335-1d71-4883-8f98-567911bfdca6",
    "startDateTime": "2019-09-09T19:50:29.3086381Z",
    "secretText": "[6gyXA5S20@MN+WRXAJ]I-TO7g1:h2P8",
    "hint": "[6g",
    "displayName": "Password friendly name"
}
  • Last updated on