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

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.Clients.Credentials.CreateAsync(
            clientId: "client_id",
            request: new PostClientCredentialRequestContent {
                CredentialType = ClientCredentialTypeEnum.PublicKey
            }
        );
    }

}

package example

import (
    context "context"

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

func do() {
    mgmt, err := client.New(
        "{YOUR_DOMAIN}",
        option.WithToken(
            "<token>",
        ),
    )
    if err != nil {
        return
    }
    request := &management.PostClientCredentialRequestContent{
        CredentialType: management.ClientCredentialTypeEnumPublicKey,
    }
    mgmt.Clients.Credentials.Create(
        context.TODO(),
        "client_id",
        request,
    )
}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.clients.types.PostClientCredentialRequestContent;
import com.auth0.client.mgmt.types.ClientCredentialTypeEnum;

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

        client.clients().credentials().create(
            "client_id",
            PostClientCredentialRequestContent
                .builder()
                .credentialType(ClientCredentialTypeEnum.PUBLIC_KEY)
                .build()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;
use Auth0\SDK\API\Management\Clients\Credentials\Requests\PostClientCredentialRequestContent;
use Auth0\SDK\API\Management\Types\ClientCredentialTypeEnum;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->clients->credentials->create(
    'client_id',
    new PostClientCredentialRequestContent([
        'credentialType' => ClientCredentialTypeEnum::PublicKey->value,
    ]),
);

from auth0.management import ManagementClient

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

client.clients.credentials.create(
    client_id="client_id",
    credential_type="public_key",
)

require "auth0"

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

client.clients.credentials.create(
  client_id: "client_id",
  credential_type: "public_key"
)

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.clients.credentials.create("client_id", {
        credentialType: "public_key",
    });
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.clients.credentials.create("client_id", {
        credentialType: "public_key",
    });
}
main();

curl --request POST \
  --url https://{tenantDomain}/api/v2/clients/{client_id}/credentials \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "alg": "RS256",
  "expires_at": "2023-02-07T12:40:17.807Z",
  "kid": "<string>",
  "name": "",
  "parse_expiry_from_cert": false,
  "pem": "-----BEGIN PUBLIC KEY-----\r\nMIIBIjANBg...\r\n-----END PUBLIC KEY-----\r\n",
  "subject_dn": "<string>"
}
'

{
  "alg": "RS256",
  "created_at": "2023-11-07T05:31:56Z",
  "expires_at": "2023-11-07T05:31:56Z",
  "id": "cred_1m7sfABoNTTKYwTQ8qt6tX",
  "kid": "IZSSTECp...",
  "name": "",
  "subject_dn": "<string>",
  "thumbprint_sha256": "<string>",
  "updated_at": "2023-11-07T05:31:56Z"
}

資格情報をPOST

アプリケーションに関連付けられたクライアント資格情報を作成します。資格情報は、Private Key JWT 認証方法や mTLS 認証方法の設定、および JWT で保護された認可リクエストに使用できます。

公開鍵

公開鍵資格情報は、Private Key JWT クライアント認証および JWT で保護された認可リクエストの設定に使用できます。

例:

{
  "credential_type": "public_key",
  "name": "string",
  "pem": "string",
  "alg": "RS256",
  "parse_expiry_from_cert": false,
  "expires_at": "2022-12-31T23:59:59Z"
}

証明書（CA署名付きおよび自己署名）

証明書資格情報は、mTLS クライアント認証の設定に使用できます。CA署名付き証明書は、署名済み証明書を使って設定することも、証明書の Subject DN のみを使って設定することもできます。

CA署名付き証明書の例（pem）:

{
  "credential_type": "x509_cert",
  "name": "string",
  "pem": "string"
}

CA署名付き証明書の例（subject_dn）:

{
  "credential_type": "cert_subject_dn",
  "name": "string",
  "subject_dn": "string"
}

自己署名証明書の例:

{
  "credential_type": "cert_subject_dn",
  "name": "string",
  "pem": "string"
}

資格情報は作成されますが、クライアントで対応するプロパティを設定するまでは、まだ有効になりません。

資格情報を Private Key JWT または mTLS の認証方法で有効にするには、クライアントの client_authentication_methods プロパティを設定します。詳細は、Configure Private Key JWT Authentication および Configure mTLS Authentication を参照してください。
資格情報を JWT で保護された認可リクエストで有効にするには、クライアントの signed_request_object プロパティを設定します。詳細は、Configure JWT-secured Authorization Requests (JAR) を参照してください。

POST

https://{tenantDomain}/api/v2

clients

{client_id}

credentials

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

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.Clients.Credentials.CreateAsync(
            clientId: "client_id",
            request: new PostClientCredentialRequestContent {
                CredentialType = ClientCredentialTypeEnum.PublicKey
            }
        );
    }

}

package example

import (
    context "context"

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

func do() {
    mgmt, err := client.New(
        "{YOUR_DOMAIN}",
        option.WithToken(
            "<token>",
        ),
    )
    if err != nil {
        return
    }
    request := &management.PostClientCredentialRequestContent{
        CredentialType: management.ClientCredentialTypeEnumPublicKey,
    }
    mgmt.Clients.Credentials.Create(
        context.TODO(),
        "client_id",
        request,
    )
}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.clients.types.PostClientCredentialRequestContent;
import com.auth0.client.mgmt.types.ClientCredentialTypeEnum;

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

        client.clients().credentials().create(
            "client_id",
            PostClientCredentialRequestContent
                .builder()
                .credentialType(ClientCredentialTypeEnum.PUBLIC_KEY)
                .build()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;
use Auth0\SDK\API\Management\Clients\Credentials\Requests\PostClientCredentialRequestContent;
use Auth0\SDK\API\Management\Types\ClientCredentialTypeEnum;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->clients->credentials->create(
    'client_id',
    new PostClientCredentialRequestContent([
        'credentialType' => ClientCredentialTypeEnum::PublicKey->value,
    ]),
);

from auth0.management import ManagementClient

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

client.clients.credentials.create(
    client_id="client_id",
    credential_type="public_key",
)

require "auth0"

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

client.clients.credentials.create(
  client_id: "client_id",
  credential_type: "public_key"
)

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.clients.credentials.create("client_id", {
        credentialType: "public_key",
    });
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.clients.credentials.create("client_id", {
        credentialType: "public_key",
    });
}
main();

curl --request POST \
  --url https://{tenantDomain}/api/v2/clients/{client_id}/credentials \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "alg": "RS256",
  "expires_at": "2023-02-07T12:40:17.807Z",
  "kid": "<string>",
  "name": "",
  "parse_expiry_from_cert": false,
  "pem": "-----BEGIN PUBLIC KEY-----\r\nMIIBIjANBg...\r\n-----END PUBLIC KEY-----\r\n",
  "subject_dn": "<string>"
}
'

{
  "alg": "RS256",
  "created_at": "2023-11-07T05:31:56Z",
  "expires_at": "2023-11-07T05:31:56Z",
  "id": "cred_1m7sfABoNTTKYwTQ8qt6tX",
  "kid": "IZSSTECp...",
  "name": "",
  "subject_dn": "<string>",
  "thumbprint_sha256": "<string>",
  "updated_at": "2023-11-07T05:31:56Z"
}

承認

Authorization

string

header

必須

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

パスパラメータ

client_id

string

必須

クライアントの ID。

ボディ

credential_type

enum<string>

必須

資格情報の種類。

利用可能なオプション:

public_key,

cert_subject_dn,

x509_cert

alg

enum<string>

デフォルト:RS256

credential で使用するアルゴリズム。指定できる値は RS256、RS384、PS256 のいずれかです。指定しない場合は RS256 が使用されます。public_key credential type に適用されます。

利用可能なオプション:

RS256,

RS384,

PS256

expires_at

string<date-time>

デフォルト:2023-02-07T12:40:17.807Z

認証情報の有効期限を表す ISO 8601 形式の日付。指定しない場合（非推奨）、認証情報の有効期限は無期限になります。public_key 認証情報タイプに適用されます。

kid

string

認証情報を一意に識別するために使用される任意の kid（Key ID）。指定しない場合、kid 値は自動生成されます。クライアントから送信される JWT の kid ヘッダーパラメーターは、この値と一致している必要があります。有効な形式は [0-9a-zA-Z-_]{10,64} です

Required string length: 10 - 64

Pattern: ^([0-9a-zA-Z-_]{10,64})$

name

string

デフォルト:""

認証情報の表示名。

Maximum string length: 128

parse_expiry_from_cert

boolean

デフォルト:false

x509証明書から有効期限を解析します。true の場合、指定された PEM から有効期限の解析を試みます。public_key 認証情報タイプに適用されます。

pem

string

デフォルト:-----BEGIN PUBLIC KEY----- MIIBIjANBg... -----END PUBLIC KEY-----

PEM形式の公開鍵（SPKIおよびPKCS1）またはX509証明書。JSONエスケープされている必要があります。

subject_dn

string

サブジェクト識別名。pemプロパティとは相互排他です。cert_subject_dn 認証情報タイプに適用されます。

Required string length: 1 - 256

レスポンス

資格情報が正常に作成されました。

alg

enum<string>

デフォルト:RS256

この資格情報で使用されるアルゴリズム。サポート対象のアルゴリズム: RS256,RS384,PS256

利用可能なオプション:

RS256,

RS384,

PS256

created_at

string<date-time>

認証情報の作成日時を表す ISO 8601 形式の日付。

credential_type

enum<string>

資格情報の種類。

利用可能なオプション:

public_key,

cert_subject_dn,

x509_cert

expires_at

string<date-time>

認証情報の有効期限を表す ISO 8601 形式の日付。

string

デフォルト:cred_1m7sfABoNTTKYwTQ8qt6tX

認証情報の ID。作成時に生成されます。

kid

string

デフォルト:IZSSTECp...

認証情報のキー識別子。作成時に生成されます。

name

string

デフォルト:""

ユーザーが認証情報に付けた名前。

subject_dn

string

X509証明書のサブジェクト識別名

thumbprint_sha256

string

X509証明書のSHA256サムプリント

updated_at

string<date-time>

認証情報の更新日時を表す ISO 8601 形式の日付。