シークレットのローテーションを実行
クライアントシークレットをローテーションします。
このエンドポイントは、Private Key JWT 認証で構成されたクライアント(client_authentication_methods が private_key_jwt に設定されているもの)では使用できません。生成されるシークレットは base64 エンコードされません。
詳細については、クライアントシークレットのローテーションを参照してください。
承認
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
パスパラメータ
シークレットをローテーションするクライアントの ID。
レスポンス
シークレットが正常にローテーションされました。
このクライアントで有効になっているアドオンと、それぞれに関連付けられた設定。
デリゲーションリクエストを実行できるクライアントおよび API id の許可リスト。空の場合は、すべてのクライアントが許可されます。
Auth0 からログアウトした後のリダイレクト先として有効な URL のカンマ区切りリスト。サブドメインにはワイルドカードを使用できます。
JavaScript から Auth0 API へのリクエスト送信を許可する URL のカンマ区切りリスト(通常は CORS で使用)。デフォルトでは、すべてのコールバック URL が許可されます。このフィールドでは、必要に応じて他のオリジンを入力できます。サブドメインレベルのワイルドカード(例: https://*.contoso.com)も使用できます。これらの URL の検証時には、クエリ文字列とハッシュ情報は考慮されません。
このクライアントが表すアプリケーションの種類
native, spa, regular_web, non_interactive, resource_server, express_configuration, rms, box, cloudbees, concur, dropbox, mscrm, echosign, egnyte, newrelic, office365, salesforce, sentry, sharepoint, slack, springcm, zendesk, zoom, sso_integration, oag 承認が必要な場合にユーザーに通知するための通知チャネルの配列。有効な値は guardian-push、email です。
1guardian-push, email 認証後に Auth0 がクライアントへのコールバックに使用できるよう、許可リストに登録された URL のカンマ区切りリスト。
SAML プロトコル用のオーディエンス/レルムのリスト。wsfed アドオンで使用されます。
クライアント認証方法を定義します。
このクライアントのID。
クライアントに関連付けられたメタデータ。文字列値を持つオブジェクト形式です(最大255文字)。メタデータのプロパティは最大10件まで指定できます。フィールド名(最大255文字)は英数字で、使用できる特殊文字は次のとおりです: :,-+=_*?"/\()<>@\t[Tab] [Space]
クライアントシークレット(公開してはいけません)。
このクライアントの準拠レベルを定義します。これにより、機能が制限される場合があります。
none, fapi1_adv_pkj_par, fapi1_adv_mtls_par, fapi2_sp_pkj_mtls, fapi2_sp_mtls_mtls, null このクライアントがクロスオリジン認証リクエストを実行できる(true)か、そのようなリクエストの実行が許可されない(false)かを示します。
Auth0 のホスト型ログインページではなく独自ドメインで認証を実行する場合に、クロスオリジン認証フローでクロスオリジン検証を行うサイト上の URL です。
カスタムログインページのコンテンツ(HTML、CSS、JS)。
カスタムログインページを使用する(true)か、デフォルトのログインページを使用する(false)かを示します。
カスタムログインページのコンテンツ(HTML、CSS、JS)。(プレビューで使用)
デフォルトの組織 ID とフローを定義します。
このクライアントの自由記述の説明(最大長: 140 文字)。
このクライアントの WsFed レスポンスで使用される暗号化。
OIN Express Configuration 機能で使用するアプリケーション固有の設定。
認可フローで使用する代替クライアント識別子です。CIMD ベースのクライアント識別子のみをサポートします。
外部メタデータ クライアントを作成した主体を示します。値 admin は、クライアントが Management API 経由で登録されたことを示します。値 client は、クライアントが動的に登録されたことを示します。このフィールドは、external_metadata_type が設定されている場合にのみ存在します。
admin, client クライアントの登録に使用された外部メタデータの種類を示します。このフィールドは通常のクライアントでは省略されます。値 cimd は、Client ID Metadata Document 経由で登録されたクライアントを示します。値 dcr は、動的クライアント登録によって登録されたクライアントを示します。
cimd, dcr WS-Federation で使用する HTML フォームテンプレート。
これが、レガシーなテナント設定を表すグローバルな「All Applications」クライアント(true)か、通常のクライアント(false)かどうか。
このアプリケーションでサポート対象のグラントタイプのリスト。authorization_code、implicit、refresh_token、client_credentials、password、http://auth0.com/oauth/grant-type/password-realm、http://auth0.com/oauth/grant-type/mfa-oob、http://auth0.com/oauth/grant-type/mfa-otp、http://auth0.com/oauth/grant-type/mfa-recovery-code、urn:openid:params:grant-type:ciba、urn:ietf:params:oauth:grant-type:device_code、urn:auth0:params:oauth:grant-type:token-exchange:federated-connection-access-token を含めることができます。
ログイン開始 URI。https である必要があります
このクライアントがファーストパーティクライアント(true)かどうか(false)。
true の場合、トークンエンドポイントのブルートフォース対策で、auth0-forwarded-for ヘッダーで指定された IP をエンドユーザーの IP として信頼します。
private_key_jwt 認証で使用される公開鍵を含む JSON Web Key Set(JWKS)の URL。private_key_jwt 認証を使用する CIMD クライアントにのみ存在します。
クライアントのJWTに関連する設定。
このクライアントに表示するロゴの URL。推奨サイズは 150x150 ピクセルです。
ネイティブモバイルアプリ向けの追加設定。
クライアントの My Organization Configuration に関連する設定。
このクライアントの名前(最小長: 1 文字、< および > は使用できません)。
このクライアントが厳格な OIDC 仕様に準拠している(true)か、レガシー機能を使用している(false)かどうか。
OIDC バックチャネルログアウトの設定
pre_login_prompt での組織検出に使用できる方法を定義します。ユーザーは email、organization_name、またはその両方で自分の組織を見つけることができます。
1pre_login_prompt 中に組織を特定する方法。email では、ユーザーがメールアドレスを入力してドメイン照合を行うことで組織を見つけられます。一方、organization_name では、ユーザーが組織名を直接入力する必要があります。これらの方法は組み合わせて使用できます。
email, organization_name client.organization_usage: 'require' の場合に、認証トランザクション中の処理方法を定義します。no_prompt(デフォルト)、pre_login_prompt、post_login_prompt のいずれかを指定できます。post_login_prompt には oidc_conformant: true が必要です。
no_prompt, pre_login_prompt, post_login_prompt 組織に関して、認証トランザクション中にどのように処理を進めるかを定義します。deny(デフォルト)、allow、require のいずれかを指定できます。
deny, allow, require プッシュ型認可リクエスト URI が有効な期間を秒単位で指定します
10 <= x <= 600認証エラー時、またはメールアドレス確認フローで、Auth0 がユーザーをアプリケーションのコールバックURLにリダイレクトするかどうかを制御します。open_redirect_protection はリダイレクトの代わりにエラーページを表示し、メールテンプレートからコールバック ドメインを非表示にします。allow_always は標準のリダイレクト動作を有効にします。サードパーティ クライアントでは、デフォルトで open_redirect_protection が使用されます。これは is_first_party が false で、かつ third_party_security_mode が strict の場合にのみ適用されます。詳細は、Redirect protection を参照してください。
allow_always, open_redirect_protection リフレッシュトークンの設定
このクライアントでは、所有証明の使用を必須にします
このクライアントでは、プッシュ型認可リクエストの使用を必須にします
このクライアントにリンクされているリソースサーバーの識別子です。
ネイティブから Web への SSO の設定
JWT-Secured Authorization Requests(JAR)の設定。
このクライアントに関連付けられた署名証明書。
リダイレクト URI に、検証不可能なコールバック URI(たとえば myapp:// のようなカスタム URI スキーマや localhost)が使用されている場合に、ログインフロー中に確認プロンプトを表示するかどうかを制御します。
true に設定すると、確認プロンプトは表示されません。悪意のあるアプリからの保護を強化するため、この設定は false にすることを推奨します。
詳細は https://auth0.com/docs/secure/security-guidance/measures-against-app-impersonation を参照してください。
SSO クライアントにのみ適用され、Auth0 がシングルサインオンを処理するか(true)、IDプロバイダーが処理するか(false)を決定します。
シングルサインオンが無効(true)か有効(true)かを示します。デフォルトは true です。
このクライアントが属するテナントの名前。
サードパーティクライアントのセキュリティモード。strictは強化されたセキュリティ制御を適用します。これには、OAuth 2.1への準拠、明示的なAPI認可、サポート対象機能を厳選したセットが含まれます。permissiveは従来の動作を維持し、過去にサードパーティクライアントの使用実績があるテナントでのみ利用できます。作成時に設定し、後から変更することはできません。
strict, permissive トークンエンドポイントに対して要求する認証方法を定義します。none(クライアントシークレットを持たないパブリッククライアント)、client_secret_post(クライアントがHTTP POSTパラメーターを使用)、またはclient_secret_basic(クライアントがHTTP Basicを使用)を指定できます。
none, client_secret_post, client_secret_basic トークン交換の設定。
クロスオリジン認証、デバイスフロー、および web message response mode で使用する許可済みオリジンのリスト。