ApiKeyCreate

Criar chave da API

rules objectrequired

oneOf

MOD1

string

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

Possible values: [*]

Example: *

MOD2

Array [

resourcestringrequired

Caminho base que define o recurso permitido.

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

rulestringrequired

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 [

fieldstringrequired

Campo que será validado.

searchInstringrequired

Local em que o campo será procurado.

Possible values: [body, header, query]

allowedValuesstring[]required

Valor que será comparado com o campo.

]

]

emailstringrequired

Email do desenvolvedor responsável.

namestringrequired

Nome do desenvolvedor responsável.

allowedIps object[]

Array [

ipstringrequired

IPv4 ou CIDR habilitado para utilizar a api-key.

Example: 200.50.0.0/8

descriptionstringrequired

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

]

isFineGrainedboolean

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

ApiKeyCreate

{
  "rules": "*",
  "email": "string",
  "name": "string",
  "allowedIps": [
    {
      "ip": "200.50.0.0/8",
      "description": "string"
    }
  ],
  "isFineGrained": true
}