Criar pendingExternalUserProfile

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.

Crie um novo objeto pendingExternalUserProfile .

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) PendingExternalUserProfile.ReadWrite.All Indisponível.
Delegado (conta pessoal da Microsoft) Sem suporte. Sem suporte.
Application PendingExternalUserProfile.ReadWrite.All 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. Esta operação dá suporte às seguintes funções internas, que fornecem apenas o menor privilégio necessário:

  • Administrador de Usuário de Diretório Estendido
  • Administrador de Serviço do Teams

Solicitação HTTP

POST /directory/pendingExternalUserProfiles

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 de um pendingExternalUserProfile.

Propriedade Tipo Descrição
address physicalOfficeAddress O endereço do escritório do perfil de usuário externo pendente.
createdBy Cadeia de caracteres A ID de objeto do usuário que criou o perfil de usuário externo pendente. Somente leitura. Não anulável.
createdDateTime DateTimeOffset Data e hora em que este perfil de usuário externo pendente foi criado. Não anulável. Somente leitura.
CompanyName String O nome da empresa do perfil de usuário externo pendente.
deletedDateTime DateTimeOffset Data e hora em que o perfil de usuário externo pendente foi excluído. Sempre null quando o objeto não for excluído.
department String O departamento do perfil de usuário externo pendente.
displayName Cadeia de caracteres O nome de exibição do perfil de usuário externo pendente. Obrigatório.
época Int O número de versão do perfil de usuário externo pendente. Incrementado a cada atualização da entidade. Somente leitura. Não anulável.
id Cadeia de caracteres O identificador exclusivo para o perfil de usuário externo pendente. Por exemplo, 12345678-9abc-def0-1234-56789abcde. O valor da propriedade id é frequentemente, mas não exclusivamente, na forma de um GUID; trate-o como um identificador opaco e não confie que ele seja um GUID. Chave. Não anulável. Somente leitura.
isDiscoverable Booliano Representa se o perfil de usuário externo pendente é detectável no diretório.
isEnabled Booliano Representa se o perfil de usuário externo pendente está habilitado no diretório.
jobTitle String O cargo do perfil de usuário externo.
phoneNumber Cadeia de caracteres O número de telefone do perfil de usuário externo pendente. Deve estar no formato E164. Obrigatório.
supervisorId Cadeia de caracteres A ID do objeto do supervisor do perfil de usuário externo pendente.

Resposta

Se for bem-sucedido, esse método retornará um código de 201 Created resposta e um objeto pendingExternalUserProfile . Se não for bem-sucedido, um 4xx erro será retornado com detalhes específicos.

Exemplo

Solicitação

O exemplo a seguir mostra uma solicitação.

POST https://graph.microsoft.com/beta/directory/pendingExternalUserProfiles
Content-type: application/json

{
    "phoneNumber": "+15555555555",
    "displayName": "Bob Henry"
}

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

{
    "id":"1e4ba82a-5f0c-423c-83e1-fc8ad69d8f02",
    "isEnabled":true,
    "createdDateTime":"2020-11-12T17:53:48Z",
    "deletedDateTime":null,
    "department":null,
    "displayName":"Bob Henry",
    "isDiscoverable":true,
    "jobTitle":null,
    "phoneNumber":"4257034568",
    "address": {
        "city": null,
        "countryOrRegion": null,
        "officeLocation": null,
        "postalCode": null,
        "state": null,
        "street": null
    },
    "epoch":1,
    "createdBy":"67670e18-bf37-416c-b5c8-3bfdaad757cc",
    "supervisorId":null,
    "companyName":null
}