POST
/
v1
/
permissions
curl --request POST \
  --url https://api.base39.io/v1/permissions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "company": "comp_62d9889bd3985729e5a048ef",
  "roles": [
    "approver"
  ]
}'
{
  "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"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Idempotency-Key
string

Chave única de idempotência para evitar duplicação de requisições.

​
base39-external-client-id
string

Chave de identificação do cliente externo. Utilizada para identificar o cliente que está realizando a requisição.

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.

​
fields
string

Permite especificar quais campos devem ser incluídos ou excluídos na resposta. Utilize o nome do campo para incluí-lo, ou prefixe o nome com um sinal de menos (-) para excluí-lo. Pode ser um valor único ou uma lista separada por vírgula(csv). Funciona para campos expandidos.

Esteja ciente de que especificar um campo para inclusão, terá o efeito que nenhum dos campos padrão seja retornado na resposta, a menos que seja explicitamente especificado.

Importante: Não é permitido combinar inclusões e exclusões na mesma requisição. Uma tentativa de fazê-lo resultará em um erro.

​
operator
string
required

ID do operador

Body

application/json

Criar uma permissão

​
company
string
required

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"

​
roles
enum<string>[]
required

Permissão do operador

Available options:
approver,
financial,
administrator,
backoffice,
backoffice_financial,
backoffice_automation

Response

201 - application/json
Retorna o objeto `Permission` se a criação for bem-sucedida; caso contrário, retorna um erro.

Este objeto representa uma permissão de um operador.

​
company
string
required

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"

​
roles
enum<string>[]
required

Permissão do operador

Available options:
approver,
financial,
administrator,
backoffice,
backoffice_financial,
backoffice_automation
​
id
string

Identificador exclusivo para o objeto.

Example:

"perm_62d9889bd3985729e5a048ef"

​
createdAt
string

Data de criação do objeto

Example:

"2023-08-25T22:38:41.134Z"

​
updatedAt
string

Data de alteração do objeto

Example:

"2023-08-25T22:38:41.134Z"

​
deleted
boolean
default:false

Identifica se o objeto foi excluído. Se verdadeiro, o objeto foi excluído.

Example:

false

​
createdBy
object
​
updatedBy
object