Excluir usuários

Exclui vários usuários de uma organização, com base nas IDs dos usuários.

Ponto de Extremidade da API

DELETE https://{yourDomain}/{organizationName}/identity_/api/User

Escopos

Requer os seguintes escopos:

• PM.User
• PM.User.Write

Cabeçalhos de solicitação.

--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'

Observação:

Para obter o {access_token}, certifique-se de se autenticar por meio de um dos métodos descritos em Métodos de autenticação.

Parâmetros do caminho

Parâmetro do caminho	Tipo de dados	Description
partitionGlobalId (obrigatório)	String	A ID da organização da qual você deseja recuperar as contas de Robots.

Corpo da Solicitação

O solicitar corpo contém a lista de IDs usuário que você deseja excluir em massa do organização.

{
  "partitionGlobalId": "string",
  "userIds": [
    "string"
  ]
}

Resposta

204 Success

As contas de robô indicadas são excluídas da organização.

Exemplo de solicitação

Digamos que você reuniu todas as informações necessárias para criar a chamada de API.

• Seu {baseURL} é: https://{yourDomain}/{organizationName}/identity_
• Seu {access_token} é: 1234 (para considerações de comprimento).
• O {partitionGlobalId} é: 3fa85f64-5717-4562-b3fc-2c963f66afa6
• Os usuários que você deseja excluir têm as seguintes IDs:
  • Dolores Umbridge: dol-2908
  • Quirinus Quirrell: qui-2609

A chamada deve ser semelhante ao seguinte exemplo (cURL):

curl --location --request DELETE 'https://{yourDomain}/{organizationName}/identity_/api/User' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json'
--data-raw '{
    "partitionGlobalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "userIds": [
        "dol-2908", "qui-2609"
    ]
}'