Get all encryption keys

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

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,
    )
}

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