Pular para o conteúdo principal

Permissões

GET​

  • /organizations/:organizationId/roles

Retorna todas as roles da organização de id passado na url.

Authorization​

  • Authorization: Bearer <session_token>

Parâmetros​

Nota

Nessa rota não há parâmetros de filtragem na query string.

Resultado​

O resultado de uma requisição bem sucedida será um 200 Ok com o seguinte formato:

{
 "creationTimestamp": Date;
 "id": number;
 "isSystem": boolean;
 "name": string;
}

POST​

  • /organizations/:organizationId/roles

Authorization​

  • Authorization: Bearer <session_token>

Cadastra uma nova role para a organização de id passado na url.

Parâmetros​

  • name: Nome da role

Os parâmetros do body da requisição tem o seguinte formato:

{
 "name": string;
}

Resultado​

O resultado para uma requisição bem sucedida será um 201 Created com o seguinte formato:

{
 "id": number;
}

PATCH​

  • /organizations/:organizationId/roles/:roleId

Atualiza os dados da role cuja o id é aquele passado na url.

Authorization​

  • Authorization: Bearer <session_token>

Parâmetros​

  • name: Nome da role

Os parâmetros do body da requisição tem o seguinte formato:

{
 "name": string;
}

Resultado​

O resultado para uma requisição bem sucedida será um 204 No Content com body vazio.

DELETE​

  • /organizations/:organizationId/roles/:roleId

Remove a role do sistema cuja o id é aquele passado na url.

Authorization​

  • Authorization: Bearer <session_token>

Parâmetros​

Nota

Nessa rota não há parâmetros.

Resultado​

O resultado de uma requisição bem sucedida será um 200 Ok com o seguinte formato:

{
 "id": number;
 "name": string;
}