認証情報を作成

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

Public Key

公開鍵認証情報は、Private Key JWT クライアント認証および JWT-Secured Authorization Requests の設定に使用できます。

サンプル:

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

Certificate (CA-signed & self-signed)

証明書認証情報は、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 プロパティを設定します。詳細は、Private Key JWT 認証の設定 および Configure mTLS Authentication を参照してください
• JWT-Secured Authorization Requests で認証情報を有効にするには、クライアントで signed_request_object プロパティを設定します。詳細は、Configure JWT-secured Authorization Requests (JAR) を参照してください

POST https://{tenantDomain}/api/v2/clients/{client_id}/credentials

Go

Go

package example

import (
    context "context"

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

func do() {
    client := client.NewClient(
        option.WithToken(
            "<token>",
        ),
    )
    request := &clients.PostClientCredentialRequestContent{
        CredentialType: management.ClientCredentialTypeEnumPublicKey,
    }
    client.Clients.Credentials.Create(
        context.TODO(),
        "client_id",
        request,
    )
}

201

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

承認

bearerAuthoAuth2ClientCredentials

Authorization · string · header · 必須

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

パスパラメータ

client_id · string · 必須

クライアントの ID。

ボディ

application/jsonapplication/x-www-form-urlencoded

credential_type · enum<string> · 必須

認証情報の種類。

利用可能なオプション: public_key, cert_subject_dn, x509_cert

alg · enum<string> · デフォルト: RS256

認証情報で使用するアルゴリズム。RS256、RS384、PS256 のいずれかを指定できます。指定しない場合は RS256 が使用されます。public_key 認証情報タイプに適用されます。

利用可能なオプション: 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

レスポンス

201

application/json

認証情報が正常に作成されました。

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形式の日付。

id · 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形式）。