Get the encryption key by its key id

Retrieve details of the encryption key with the given ID.

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

Go

Go

package example

import (
    context "context"

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

func do() {
    client := client.NewClient(
        option.WithToken(
            "<token>",
        ),
    )
    client.Keys.Encryption.Get(
        context.TODO(),
        "kid",
    )
}

200

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

Autorisations

bearerAuthoAuth2ClientCredentials

Authorization · string · header · requis

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

Paramètres de chemin

kid · string · requis

Encryption key ID

Réponse

200

application/json

The key was successfully retrieved.

Encryption key

kid · string · requis

Key ID

type · enum<string> · requis

Key type

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

state · enum<string> · requis

Key state

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

created_at · string<date-time> · requis

Key creation timestamp

updated_at · string<date-time> · requis

Key update timestamp

parent_kid · string | null

ID of parent wrapping key

public_key · string | null

Public key in PEM format