ApiKey

Este objeto representa alguns dados chave da API do seu negócio. Com ela você pode realizar requisições às APIs da Base39.

id string
Identificador exclusivo para o objeto.
Example: key_6352a35384c95868100e226c

rules

object

oneOf

MOD1

Use esta opção caso seja necessária uma chave da api com permissão total (leitura e escrita) no sistema.

string

Possible values: [*]

MOD2

Use esta opção para definir de forma mais específica as permissões dadas à nova chave da api.

Array [

resource stringrequired

Caminho base que define o recurso permitido.

Possible values: Value must match regular expression (^\/v[1-9]\/.{3,}|\*)

rule stringrequired

Regra que será aplicada ao recurso descrito anteriormente.

Possible values: [readOnly, readWrite, writeOnly]

Example: readOnly

conditions

object[]

Condições que serão aplicadas ao recurso descrito anteriormente.

Array [

field stringrequired

Campo que será validado.

searchIn stringrequired

Local em que o campo será procurado.

Possible values: [body, header, query]

allowedValues string[]required

Valor que será comparado com o campo.

]

]

email string

Email do desenvolvedor responsável.

name string

Nome do desenvolvedor responsável.

isFineGrained boolean
Utilizado para ativar ou desativar o controle de acesso granular. Quando habilitado (true), é aplicado regras detalhadas definidas pelo autorizador para permitir ou negar acesso a recursos específicos com base em condições predefinidas.
Example: true

allowedIps

object[]

Array [

ip stringrequired

IPv4 ou CIDR habilitado para utilizar a api-key.

Example: 200.50.0.0/8

description stringrequired

Campo para descrever qual o sistema do referido IPv4 ou CIDR.

]

revokedIn date

Data de quando a api-key foi revogada.

apiKey string
Chave da API ofuscada, apresentando apenas os últimos 4 caracteres.
Example: ****************************1544

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