Gerenciamento do Usuário

Funcionalidade disponível

As APIs de gerenciamento da plataforma expõem a seguinte funcionalidade da plataforma:

Cenários de gerenciamento	Métodos de autenticação do SQL
Gerenciamento de usuários — crie, atualize ou exclua usuários ou grupos, e gerencie as configurações da organização	Aplicativos Externos

URL base

Todas as chamadas de API de gerenciamento da plataforma são feitas usando métodos HTTP para a URL base.

Recomenda-se criptografar os dados que você envia por meio de chamadas de APIs, usando o protocolo https.

Observação:

Para implantações do Automation Cloud e do Automation Suite, todas as URLs do Identity Server contêm o segmento /identity_.
Para implantações autônomas, todas as URLs do Identity contêm o segmento /identity.

Lista de recursos

As APIs de gerenciamento da plataforma dão a seu aplicativo controle sobre os seguintes recursos:

Gerenciamento do Usuário

Auditar

GET {BaseURL}/identity/api/AuditQuery/{organizationId} - Recupera os logs de auditoria para o ID de organização especificado.
GET {BaseURL}/identity/api/AuditQuery/{organizationId}/download - baixa os logs de auditoria para o ID da organização específica.

Grupo

GET {BaseURL}/identity/api/Group/{partitionGlobalId} - Recupera todos os grupos locais e internos do ID de partição especificado (organização ou locatário).
GET {BaseURL}/identity/api/Group/{partitionGlobalId}/{groupId} - Recupera o grupo interno ou local especificado no ID de partição especificado.
POST {BaseURL}/identity/api/Group - Cria um novo grupo local.
PUT {BaseURL}/identity/api/Group/{groupId} - Atualiza as informações de um grupo local.
DELETE {BaseURL}/identity/api/Group/{partitionGlobalId} - Exclui todos os grupos locais do ID de partição especificado (organização ou locatário).
DELETE {BaseURL}/identity/api/Group/{partitionGlobalId}/{groupId} - Exclui o grupo local especificado.

Modelo de mensagem

GET {BaseURL}/identity/api/MessageTemplate - Recupera um modelo de mensagem usando o filtro fornecido.
GET {BaseURL}/identity/api/MessageTemplate/{templateId} - Recupera o modelo de mensagem especificado.
PUT {BaseURL}/identity/api/MessageTemplate/{templateId}- atualiza o modelo de mensagem especificado.

Conta de robô

GET {BaseURL}/identity/api/RobotAccount/{partitionGlobalId} - Recupera todas as contas de robô no ID de partição especificado (organização ou locatário).
GET {BaseURL}/identity/api/RobotAccount/{partitionGlobalId}/{robotAccountId} - Recupera a conta de robô especificada no ID de partição especificado.
POST {BaseURL}/identity/api/RobotAccount - Cria uma nova conta de robô.
PUT {BaseURL}/identity/api/RobotAccount/{robotAccountId} - Atualiza as informações da conta do robô especificada.
EXCLUIR {BaseURL}/identity/api/RobotAccount/{partitionGlobalId}/{robotAccountId} - exclui a conta de robô especificada.
DELETE {BaseURL}/identity/api/RobotAccount/{partitionGlobalId} - Exclui todas as contas de robô no ID de partição especificado.

Configuração

GET {BaseURL}/identity/api/Setting - Recupera as configurações de um aplicativo com base em uma lista de chaves para um inquilino específico.
PUT {BaseURL}/identity/api/Setting - Atualiza ou cria novas configurações em um locatário específico.

Usuário

GET {BaseURL}/identity/api/User/{userId} - Recupera informações sobre o usuário especificado.
POST {BaseURL}/identity/api/User - Cria um novo usuário. Este ponto de extremidade é idempotente: tentar substituir um usuário exclui o existente.
POST {BaseURL}/identity/api/User/BulkCreate - Cria usuários em massa.
POST {BaseURL}/identity/api/User/{userId}/changepassword - Atualiza a senha para o usuário especificado.
PUT {BaseURL}/identity/api/User/{userId} - Atualiza as informações específicas do usuário.
EXCLUIR {BaseURL}/identity/api/User - Exclui todos os usuários.
DELETE {BaseURL}/identity/api/User/{userId} - Exclui o usuário especificado.

UserLoginAttempt

GET {BaseURL}/identity/api/User/{userId}/loginAttempts - Recupera as tentativas de login do usuário especificado.

Escopos por recurso de API

Os escopos definem o nível de acesso de seu aplicativo aos recursos de gerenciamento da plataforma.

Por exemplo, para gerar um token de autenticação para seu aplicativo, você passa em vários escopos. Quando seu aplicativo faz uma chamada de API para acessar um recurso, o token é validado em relação aos escopos do recurso. Se o recurso estiver incluído nos escopos em que você passou na solicitação do token, a chamada será bem-sucedida e verificará ainda mais os permissões dos usuários por ponto de extremidade (permissões para Ler para solicitações GET e permissões para Escrever para solicitações POST, PUT ou DELETE). Caso contrário, o servidor rejeitará a chamada.

Permissões por endpoint

As permissões concedem aos usuários de seu aplicativo acesso a uma funcionalidade específica dentro de um recurso. Cada permissão está vinculada a um escopo. Após seu aplicativo acessar com sucesso o recurso, o servidor verificará se o usuário autenticado tem a permissão certa para o método correspondente do ponto de extremidade.

Por exemplo, você pode restringir alguns usuários de excluir ou atualizar grupos de usuários, mas ainda assim eles poderão visualizá-los.

Geralmente, os métodos GET exigem permissões para Ler, enquanto os métodos POST, PUT e DELETE exigem permissões para Escrever.

Lista de escopos e permissões

Gerenciamento do Usuário

A tabela abaixo resume os escopos e permissões necessários para executar uma ação específica:

Recurso	Escopos	Permissões
Consulta de auditoria	PM.Audit	PM.Audit.Read (para solicitações GET)
Grupo	PM.Group	PM. Group.Read (para solicitações GET) PM.Group.Write (para solicitações POST, PUT e DELETE)
Modelo de mensagem	PM.MessageTemplate	PM.MessageTemplate.Read (para solicitações GET) PM.MessageTemplate.Write (for PUT requests)
Conta de robô	PM.RobotAccount	PM.RobotAccount.Read (para solicitações GET) PM. RobotAccount.Write (para solicitações POST, PUT e DELETE)
Configuração	PM.Setting	PM. Setting.Read (para solicitações GET) PM. Setting.Write (para solicitações PUT)
Usuário	PM.User	PM. Usuário.Read (para solicitações GET) PM. Usuário.Write (para solicitações POST, PUT ou DELETE)
UserLoginAttempt	PM.UserLoginAttempt	PM.UserLoginAttempt.Read (para solicitações GET)