Listar chaves da API

GET 
/v1/tenants/api-keys

Lista as chaves da API da sua conta.

Request

Query Parameters

starting_after string
Um cursor para uso na paginação. starting_after é um ID de objeto que define seu lugar na lista. Por exemplo, se você fizer uma solicitação de lista e receber 100 objetos, terminando com obj_foo, sua chamada subsequente poderá incluir starting_after=obj_foo para buscar a próxima página da lista.
Example: obj_5f92f01728e009f403d8502e
ending_before string
Um cursor para uso na paginação. starting_after é um ID de objeto que define seu lugar na lista. Por exemplo, se você fizer uma solicitação de lista e receber 100 objetos, terminando com obj_foo, sua chamada subsequente poderá incluir starting_after=obj_foo para buscar a próxima página da lista.
Example: obj_5f92f01728e009f403d8502e
limit integer
Um limite no número de objetos a serem retornados. O limite pode variar entre 1 e 100, e o padrão é 10.
Default value: 10
Example: 10

Responses

200

Um objeto com data contendo um array de invoiceItem após starting_after. Se vazio, não há mais itens. Nunca falha.

application/json

Schema

Schema

hasMore boolean
Informa se existem mais itens. Os próximos itens podem ser obtidos informando o ID do último item no startingAfter.
Example: true

data

object[]

Uma lista de chaves da API

Array [

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

]

Example (from schema)

{
  "hasMore": true,
  "data": [
    {
      "id": "key_6352a35384c95868100e226c",
      "rules": "*",
      "email": "string",
      "name": "string",
      "isFineGrained": true,
      "allowedIps": [
        {
          "ip": "200.50.0.0/8",
          "description": "string"
        }
      ],
      "revokedIn": "2024-07-29",
      "apiKey": "****************************1544",
      "createdBy": {
        "clientId": "client_identifier",
        "externalClientId": "string",
        "app": "backoffice"
      },
      "updatedBy": {
        "clientId": "client_identifier",
        "externalClientId": "string",
        "app": "backoffice"
      }
    }
  ]
}

Loading...