O que esse endpoint de API faz

Com a API de usuários, você pode obter uma lista de todos os usuários em sua conta do Reach 360, bem como os detalhes de um único usuário. Você também pode excluir usuários do treinamento.

• Pontos finais
• Objeto do usuário
• Recuperando uma lista de usuários
• Recuperando detalhes específicos do usuário

Pontos finais

• GET /users- listar usuários
• GET /users/{userId}- obter detalhes de um usuário por ID de usuário
• DELETE /users/{userId}- excluir usuário por ID de usuário

Objeto do usuário

• id(string) - o identificador exclusivo do usuário
• email(string) - o endereço de e-mail do usuário
• groupsUrl(string) - URL para listar os grupos de usuários da API
• reportingGroupsUrl(string) - URL para listar grupos dos quais o usuário é relator da API (observação: definido apenas quando o usuário tem uma função) reporter
• managingGroupsUrl(string) - URL para listar grupos dos quais o usuário é gerente a partir da API (observação: definido apenas quando o usuário tem uma funçãomanager)
• role(string) - a função do usuário (uma das learnerauthor,reporter,manager, ouadmin)
• firstName(string) - o primeiro nome do usuário
• lastName(string) - o sobrenome do usuário
• lastActiveAt(string) - a data e a hora da última atividade do usuário em ascensão
• learnerReportUrl(string) - URL para buscar o relatório do aluno do usuário na API
• favoritesUrl(string) - URL para buscar a lista de favoritos do usuário na API
• url(string) - URL para buscar os detalhes do usuário na API
• articulate360User(boolean) - se o usuário é gerenciado ou não no Articulate 360

Recuperando uma lista de usuários

GET /users

Parâmetros de solicitação (sequência de caracteres de consulta)

• limit(inteiro, opcional) - o número máximo de resultados a serem retornados em uma única resposta (consulte Paginação); deve estar entre 1 e 100 (o padrão é 50)
• email(string, opcional) - se fornecido, retorne somente usuários com esse endereço de e-mail

Exemplo de resposta

{
“users”: [
{
“id”: “example-user-id-1", “email”: "foo@example.com 
 “, “groupsURL”: "https://api.reach360.com/users/example-user-id-1/groups “, “reportingGroupsURL”: null, 
 “
managingGroupsURL”: null, 
 “
role”: “aluno”, “FirstName”: “Exemplo de primeiro nome 1", “LastName”: “Exemplo de sobrenome” 1", “lastActiveAt”: “2021-10-28T 20:39:52.659 Z”, 
 “LearnerReportUrl”: "https://api.reach360.com/reports/learners/example-user-id-1 
 “, “FavoritesUrl”:” 
 
 
 https://api.reach360.com/users/example-user-id-1/favorites “, 
 “url”: "https://api.reach360.com/users/example-user-id-1" 
 “Articulate360User”: false
},... 
], 
 “NextURL”: "https://url-for-next-page-of-results"} 
 

Recuperando detalhes específicos do usuário

GET /users/{userId}

Exemplo de resposta

{
“id”: “example-user-id”, “email”: "example@example.com 
 “, “groupsURL”: "https://api.reach360.com/users/example-user-id-1/groups “, 
 “reportingGroupsURL”: null, “
managingGroupsURL”: null, 
 “
role”: “aluno”, “firstName”: “Exemplo de nome”, “sobrenome de exemplo”, “sobrenome de exemplo”, “lastActiveAt”: “2021-10-28T 20:39:52.659 Z”, 
 “LearnerReportUrl”: "https://api.reach360.com/reports/learners/example-user-id “, “FavoritesUrl”: "https://api.reach360.com/users/example-user-id/favorites 
 “, 
 
 
 
“url”: "https://api.reach360.com/users/example-user-id" 
 “Articulate360User”: false} 

Códigos de erro específicos do endpoint

• user_not_found- não é possível recuperar o usuário porque o usuário não existe

Excluindo usuários por ID

DELETE /users/{userId}

• Somente alunos que não são gerenciados com SSO e que não têm um Articulate ID podem ser excluídos com a API.

Exemplo de resposta de sucesso

204 Sem conteúdo

Exemplo de respostas de falha (somente alunos podem ser excluídos)

{
“errors”: [
{
“message”: “Você não pode excluir um usuário gerenciado pelo 360", 
 “code”: “validation_failed”}]} 
 
 

Exemplo de resposta de falha (usuários de SSO não podem ser excluídos)

{
“erros”: [
{
“mensagem”: “Nenhum usuário encontrado”, 
 “código”: “not_found”
}]} 
 

Exemplo de resposta de falha (os proprietários não podem ser excluídos)

{
“errors”: [
{
“message”: “Você não pode excluir um usuário que é o proprietário”, 
 “code”: “validation_failed”
}]} 
 

Exemplo de resposta de falha (usuários do Okta não podem ser excluídos)

{
“erros”: [
{
“mensagem”: “Nenhum usuário encontrado”, 
 “código”: “not_found”
}]}