POST
/
v1
/
permissions

Authorizations

Authorization
string
headerrequired

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.

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[]

Uma lista separada por vírgulas de atributos a serem incluídos na resposta. Isso pode ser usado para solicitar campos que normalmente não são retornados em uma resposta padrão.

Esteja ciente de que especificar este parâmetro terá o efeito que nenhum dos campos padrão seja retornado na resposta, a menos que seja explicitamente especificado.

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 e administrator company pode assumir o valor * que representa todas as companhias.

roles
enum<string>[]
required
Available options:
approver,
financial,
administrator,
backoffice,
backoffice_financial

Response

201 - application/json

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 e administrator company pode assumir o valor * que representa todas as companhias.

roles
enum<string>[]
required
Available options:
approver,
financial,
administrator,
backoffice,
backoffice_financial
id
string

Identificador exclusivo para o objeto.

createdAt
string

Data de criação do objeto

updatedAt
string

Data de alteração do objeto

deleted
boolean
default: false

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