Skip to main content
GET
/
keys
/
encryption
TypeScript
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();
[
  {
    "kid": "<string>",
    "type": "customer-provided-root-key",
    "state": "pre-activation",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "parent_kid": "<string>",
    "public_key": "<string>"
  }
]

Authorizations

​
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

The keys were successfully retrieved.

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