Atualizar chave da api

POST 
/v1/tenants/api-keys/:api_key

Atualiza uma chave da API.

Request

Path Parameters

api_key stringrequired
ID da chave da API
Example: key_5f92f01728e009f403d8502e

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

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.

]

]

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.

]

Responses

202

Objeto atualizado com sucesso.

Loading...