Obtener claves de cifrado

Recupere los detalles de todas las claves de cifrado asociadas con su inquilino.

GET https://{tenantDomain}/api/v2/keys/encryption

Go

Go

package example

import (
    context "context"

    management "github.com/auth0/go-auth0/management/management"
    client "github.com/auth0/go-auth0/management/management/client"
    keys "github.com/auth0/go-auth0/management/management/keys"
    option "github.com/auth0/go-auth0/management/management/option"
)

func do() {
    client := client.NewClient(
        option.WithToken(
            "<token>",
        ),
    )
    request := &keys.ListEncryptionKeysRequestParameters{
        Page: management.Int(
            1,
        ),
        PerPage: management.Int(
            1,
        ),
        IncludeTotals: management.Bool(
            true,
        ),
    }
    client.Keys.Encryption.List(
        context.TODO(),
        request,
    )
}

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.keys.encryption.list({
        page: 1,
        perPage: 1,
        includeTotals: true,
    });
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.keys.encryption.list({
        page: 1,
        perPage: 1,
        includeTotals: true,
    });
}
main();

curl --request GET \
  --url https://{tenantDomain}/api/v2/keys/encryption \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://{tenantDomain}/api/v2/keys/encryption"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenantDomain}/api/v2/keys/encryption",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

HttpResponse<String> response = Unirest.get("https://{tenantDomain}/api/v2/keys/encryption")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}/api/v2/keys/encryption")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

[
  {
    "created_at": "2023-11-07T05:31:56Z",
    "kid": "<string>",
    "updated_at": "2023-11-07T05:31:56Z",
    "parent_kid": "<string>",
    "public_key": "<string>"
  }
]

Autorizaciones

bearerAuthoAuth2ClientCredentials

Authorization · string · header · requerido

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Parámetros de consulta

page · integer

Índice de la página de resultados que se devolverá. La primera página es 0.

Rango requerido: x >= 0

per_page · integer

Número de resultados por página. El valor predeterminado es 50 y el valor máximo es 100.

Rango requerido: 1 <= x <= 100

include_totals · boolean

Devuelva los resultados dentro de un objeto que contenga el recuento total de resultados (true) o como una matriz directa de resultados (false, valor predeterminado).

Respuesta

200

application/json

Las claves se recuperaron correctamente.

object[]

object

Clave de cifrado

created_at · string<date-time> · requerido

Marca de tiempo de creación de la clave

kid · string · requerido

Key ID

state · enum<string> · requerido

Estado de la clave

Opciones disponibles: pre-activation, active, deactivated, destroyed

type · enum<string> · requerido

Tipo de clave

Opciones disponibles: customer-provided-root-key, environment-root-key, tenant-master-key, tenant-encryption-key

updated_at · string<date-time> · requerido

Marca de tiempo de actualización de la clave

parent_kid · string | null

ID de la clave de envoltura principal

public_key · string | null

Clave pública en formato PEM