Obter permissão

GET 
/v1/operators/:operator/permissions/:permission

Retorna um objeto Permission

Request

Path Parameters

permission stringrequired
ID da permissão
Example: perm_5f92f01728e009f403d8502e
operator stringrequired
ID do operador
Example: oprt_5f92f01728e009f403d8502e

Query Parameters

expand string
Expande as referências.
Pode ser um valor único ou uma lista separada por vírgula (csv) de referências retornadas neste endpoint.
Example: data.loan

Responses

200

Retorna o objeto Permission para um ID válido. Se for excluído, incluirá deleted: true.

application/json

Schema

Schema

idstring
Identificador exclusivo para o objeto.
Example: perm_62d9889bd3985729e5a048ef
companystringrequired
O ID da companhia que o operador tem permissão para acessar. Para as roles do tipo financial, backoffice, backoffice_financial, backoffice_automation e administrator company pode assumir o valor * que representa todas as companhias.
Example: comp_62d9889bd3985729e5a048ef
rolesstring[]required

Possible values: [approver, financial, administrator, backoffice, backoffice_financial, backoffice_automation]

createdAtdate-time
Data de criação do objeto
Example: 2023-08-25T22:38:41.134Z
updatedAtdate-time
Data de alteração do objeto
Example: 2023-08-25T22:38:41.134Z
deletedboolean
Identifica se o objeto foi excluído. Se verdadeiro, o objeto foi excluído.
Default value: false
Example: false

createdBy

object

clientIdstring

Identificador do cliente que criou a assinatura.

Example: client_identifier

externalClientIdstring

Chave de identificação do cliente externo. Utilizada para identificar o cliente que está realizando a requisição. Populado pelo campo enviado no header base39-external-client-id.

appstring

Nome da aplicação que criou a assinatura.

Example: backoffice

updatedBy

object

clientIdstring

Identificador do cliente que criou a assinatura.

Example: client_identifier

externalClientIdstring

Chave de identificação do cliente externo. Utilizada para identificar o cliente que está realizando a requisição. Populado pelo campo enviado no header base39-external-client-id.

appstring

Nome da aplicação que criou a assinatura.

Example: backoffice

Example (from schema)

{
  "id": "perm_62d9889bd3985729e5a048ef",
  "company": "comp_62d9889bd3985729e5a048ef",
  "roles": [
    "approver"
  ],
  "createdAt": "2023-08-25T22:38:41.134Z",
  "updatedAt": "2023-08-25T22:38:41.134Z",
  "deleted": false,
  "createdBy": {
    "clientId": "client_identifier",
    "externalClientId": "string",
    "app": "backoffice"
  },
  "updatedBy": {
    "clientId": "client_identifier",
    "externalClientId": "string",
    "app": "backoffice"
  }
}