Usuários
GET
/organizations/:organizationId/users
/organizations/:organizationId/users/:userId
Retorna os usuários cadastradas no sistema de acordo com os parâmetros da requisição.
Authorization
Authorization: Bearer <session_token>
Parâmetros
name
(Opcional): Nome do usuárioemail
(Opcional): Email do usuário
Os parâmetros de filtragem são enviados na query string.
Caso id
não seja passado na url, todas os usuários serão retornadas.
Resultado
O resultado de uma requisição bem sucedida será um 200 Ok
com o seguinte formato:
Array<{
"creationTimestamp": Date;
"email": string;
"id": number;
"lastAccessTimestamp": Date;
"name": string;
"organizationId": number;
"roles": {
"name": string;
"id": number;
"isSystem": boolean;
}
"status": "blocked" | "pending" | "normal";
}>
POST
/organizations/:organizationId/users
Cadastra um novo usuário no sistema.
Authorization
Authorization: Bearer <session_token>
Parâmetros
email
: Email do usuário.locale
: Língua na qual será enviado o convite para cadastro (en
,pt
).name
: Nome do usuário.roleIds
: IDs das roles na qual o usuário irá pertencer.
Os parâmetros do body da requisição tem o seguinte formato:
{
"email": string;
"locale": "en" | "pt";
"name": string;
"roleIds": Array<number>;
}
Resultado
O resultado para uma requisição bem sucedida será um 201 Created
com o seguinte formato:
{
"creationTimestamp": Date;
"id": number;
"name": string;
"status": "pending";
}
PATCH
/organizations/:organizationId/users/:userId
Authorization
Authorization: Bearer <session_token>
Atualiza os dados do usuário cuja o id
é aquele passado na url.
Parâmetros
newOrganizationId
(Opcional): Nova organização do usuário.roleIds
(Opcional): Novas roles do usuário.status
(Opcional): Status do usuário.
Os parâmetros do body da requisição tem o seguinte formato:
{
"newOrganizationId": nunmber;
"roleIds": Array<number>;
"status": "blocked" | "normal";
}
Resultado
O resultado para uma requisição bem sucedida será um 204 No Content
com body vazio.
DELETE
/organizations/:organizationId/users/:userId
Remove o usuário do sistema cuja o id
é aquele passado na url.
Authorization
Authorization: Bearer <session_token>
Parâmetros
Nessa rota não há parâmetros.
Resultado
O resultado de uma requisição bem sucedida será um 200 Ok
com body vazio.