Pular para o conteúdo principal

Criar permissão

POST 
/v1/operators/:operator/permissions

Cria uma nova permissão para um operador.

Request​

Path Parameters

    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

Header Parameters

    Idempotency-Key string

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

    Example: 5f92f01728e009f403d8502e
    base39-external-client-id string

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

Body

    company stringrequired

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

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

Responses​

Retorna o objeto Permission se a criação for bem-sucedida; caso contrário, um erro.

Schema

    id string

    Identificador exclusivo para o objeto.

    Example: perm_62d9889bd3985729e5a048ef
    company stringrequired

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

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

    createdAt date-time

    Data de criação do objeto

    Example: 2023-08-25T22:38:41.134Z
    updatedAt date-time

    Data de alteração do objeto

    Example: 2023-08-25T22:38:41.134Z
    deleted boolean

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

    Default value: false
    Example: false

    createdBy

    object

    clientId string

    Identificador do cliente que criou a assinatura.

    Example: client_identifier
    externalClientId string

    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.

    app string

    Nome da aplicação que criou a assinatura.

    Example: backoffice

    updatedBy

    object

    clientId string

    Identificador do cliente que criou a assinatura.

    Example: client_identifier
    externalClientId string

    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.

    app string

    Nome da aplicação que criou a assinatura.

    Example: backoffice
Loading...