暗号化キーを取得する

テナントに関連付けられているすべての暗号化鍵の詳細を取得します。

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>"
  }
]

承認

bearerAuthoAuth2ClientCredentials

Authorization · string · header · 必須

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

クエリパラメータ

page · integer

返される結果のページ index です。最初のページは 0 です。

必須範囲: x >= 0

per_page · integer

1 ページあたりの結果数です。デフォルト値は 50、最大値は 100 です。

必須範囲: 1 <= x <= 100

include_totals · boolean

合計結果数を含むオブジェクト内に結果を返すか (true)、結果の配列を直接返すか (false、デフォルト) を指定します。

レスポンス

200

application/json

鍵を正常に取得しました。

object[]

object

暗号化キー

created_at · string<date-time> · 必須

キーの作成タイムスタンプ

kid · string · 必須

Key ID

state · enum<string> · 必須

キーの状態

利用可能なオプション: pre-activation, active, deactivated, destroyed

type · enum<string> · 必須

キーのタイプ

利用可能なオプション: customer-provided-root-key, environment-root-key, tenant-master-key, tenant-encryption-key

updated_at · string<date-time> · 必須

キーの更新タイムスタンプ

parent_kid · string | null

親ラッピングキーのID

public_key · string | null

PEM形式の公開鍵