Get all encryption keys

Retrieve details of all the encryption keys associated with your tenant.

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

C#

C#

using Auth0.ManagementApi;
using System.Threading.Tasks;
using Auth0.ManagementApi.Keys;

public partial class Examples
{
    public async Task Example() {
        var client = new ManagementApiClient(
            token: "<token>",
            clientOptions: new ClientOptions { BaseUrl = "https://{YOUR_DOMAIN}/api/v2" }
        );

        await client.Keys.Encryption.ListAsync(
            new ListEncryptionKeysRequestParameters {
                Page = 1,
                PerPage = 1,
                IncludeTotals = true
            }
        );
    }

}

package example

import (
    context "context"

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

func do() {
    mgmt, err := client.New(
        "{YOUR_DOMAIN}",
        option.WithToken(
            "<token>",
        ),
    )
    if err != nil {
        return
    }
    request := &keys.ListEncryptionKeysRequestParameters{
        Page: management.Int(
            1,
        ),
        PerPage: management.Int(
            1,
        ),
        IncludeTotals: management.Bool(
            true,
        ),
    }
    mgmt.Keys.Encryption.List(
        context.TODO(),
        request,
    )
}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.keys.types.ListEncryptionKeysRequestParameters;

public class Example {
    public static void main(String[] args) {
        ManagementApi client = ManagementApi
            .builder()
            .domain("{YOUR_DOMAIN}")
            .token("<token>")
            .build();

        client.keys().encryption().list(
            ListEncryptionKeysRequestParameters
                .builder()
                .page(1)
                .perPage(1)
                .includeTotals(true)
                .build()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;
use Auth0\SDK\API\Management\Keys\Encryption\Requests\ListEncryptionKeysRequestParameters;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->keys->encryption->list(
    new ListEncryptionKeysRequestParameters([
        'page' => 1,
        'perPage' => 1,
        'includeTotals' => true,
    ]),
);

from auth0.management import ManagementClient

client = ManagementClient(
    domain="{YOUR_DOMAIN}",
    token="<token>",
)

client.keys.encryption.list(
    page=1,
    per_page=1,
    include_totals=True,
)

require "auth0"

client = Auth0::Management.new(token: "<token>", base_url: "https://{YOUR_DOMAIN}/api/v2")

client.keys.encryption.list(
  page: 1,
  per_page: 1,
  include_totals: true
)

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        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({
        domain: "{YOUR_DOMAIN}",
        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>'

200

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

Authorizations

bearerAuthoAuth2ClientCredentials

Authorization · string · header · required

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

Query Parameters

page · integer

Page index of the results to return. First page is 0.

Required range: x >= 0

per_page · integer

Number of results per page. Default value is 50, maximum value is 100.

Required range: 1 <= x <= 100

include_totals · boolean

Return results inside an object that contains the total result count (true) or as a direct array of results (false, default).

Response

200

application/json

The keys were successfully retrieved.

object[]

object

Encryption key

kid · string · required

Key ID

type · enum<string> · required

Key type

Available options: customer-provided-root-key, environment-root-key, tenant-master-key, tenant-encryption-key

state · enum<string> · required

Key state

Available options: pre-activation, active, deactivated, destroyed

created_at · string<date-time> · required

Key creation timestamp

updated_at · string<date-time> · required

Key update timestamp

parent_kid · string | null

ID of parent wrapping key

public_key · string | null

Public key in PEM format