Criar chave da api

POST 
/v1/tenants/api-keys

Cria uma nova chave da API.

Request

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.

application/json

Body

rules

object

required

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 stringrequired

Email do desenvolvedor responsável.

name stringrequired

Nome do desenvolvedor responsável.

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.

]

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

Responses

201

Retorna o objeto ApiKeyResponse se a criação for bem-sucedida; senão, um erro para parâmetros inválidos.

application/json

Schema

Schema

id string
Identificador exclusivo para o objeto.
Example: key_6352a35384c95868100e226c
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.
Example: bs_live_63cae5a4d27a39cc28301544

Example (from schema)

{
  "id": "key_6352a35384c95868100e226c",
  "value": "bs_live_63cae5a4d27a39cc28301544"
}

Loading...