POST
/
v1
/
tenants
/
api-keys

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.

base39-external-client-id
string

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

Body

application/json
rules
required

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

Available options:
*
email
string
required

Email do desenvolvedor responsável.

name
string
required

Nome do desenvolvedor responsável.

allowedIps
object[]
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.

Response

201 - application/json
id
string

Identificador exclusivo para o objeto.

value
string

Este campo representa a chave necessária para autenticar e autorizar as requisições. Existem dois tipos de prefixos possíveis para esta chave: bs_sandbox_ e bs_live_. O prefixo bs_sandbox_ é usado para chaves associadas a tenants cujos nomes terminam com "-sandbox", enquanto o prefixo bs_live_ identifica chaves vinculadas a tenants que não terminam com "-sandbox". A escolha do prefixo determina o contexto e a finalidade da chave da API.