メインコンテンツへスキップ
PATCH
Go

承認

Authorization
string
header
必須

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

パスパラメータ

id
string
必須

更新するクライアントの ID。

ボディ

addons
object

このクライアントで有効になっているアドオンと、それぞれに関連付けられた設定。

allowed_clients
string[]

デリゲーションリクエストの実行を許可するクライアントの id。一覧を指定しない場合は、デフォルトですべてのクライアントが許可されます。このフィールドを使用すると、特定のクライアントを指定できます。

Minimum string length: 1
allowed_logout_urls
string<url-with-placeholders>[]

Auth0 からログアウトした後のリダイレクト先として有効な URL

allowed_origins
string<url-with-placeholders>[]

CORS で有効なオリジンを表す URL のセット

app_type
enum<string>

このクライアントが表すアプリケーションの種類

利用可能なオプション:
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
async_approval_notification_channels
enum<string>[] | null

承認が必要な場合にユーザーに通知するための通知チャネルの配列。有効な値は guardian-pushemail です。

Minimum array length: 1
利用可能なオプション:
guardian-push,
email
callbacks
string<callback-url>[]

ユーザー認証時に Auth0 からコールバックできる有効な URL のセット

client_aliases
string[]

SAML プロトコルのオーディエンスの一覧

Minimum string length: 1
client_authentication_methods
object | null

クライアント認証方法を定義します。

client_metadata
object

クライアントに関連付けられたメタデータ。文字列値を持つオブジェクト形式です(最大255文字)。メタデータのプロパティは最大10件まで指定できます。フィールド名(最大255文字)は英数字で、使用できる特殊文字は次のとおりです: :,-+=_*?"/\()<>@\t[Tab] [Space]

client_secret
string

クライアントのトークン署名に使用するシークレット

Minimum string length: 1
compliance_level
enum<string> | null

このクライアントの準拠レベルを定義します。これにより、機能が制限される場合があります。

利用可能なオプション:
none,
fapi1_adv_pkj_par,
fapi1_adv_mtls_par,
fapi2_sp_pkj_mtls,
fapi2_sp_mtls_mtls,
null
cross_origin_authentication
boolean

このクライアントをクロスオリジン認証リクエストに使用できる場合は true、クロスオリジンが無効な場合は false

cross_origin_loc
string<url-or-null> | null

Auth0 のホスト型ログインページではなく独自ドメインで認証を実行する場合に、クロスオリジン認証フローでクロスオリジン検証を行うサイト上の場所の URL。

custom_login_page
string

カスタムログインページのコンテンツ(HTML、CSS、JS)

custom_login_page_on
boolean

カスタムログインページを使用する場合は true、それ以外の場合は false

custom_login_page_preview
string
default_organization
object | null

デフォルトの組織 ID とフローを定義します。

description
string

クライアントの用途に関する自由記述の説明です。(最大文字数: 140

Maximum string length: 140
encryption_key
object | null

クライアントの暗号化キー

express_configuration
object | null

OIN Express Configuration 機能で使用するアプリケーション固有の設定。

fedcm_login
object | null
EA

New Universal Login の FedCM ログイン設定の構成

form_template
string

WS-Federation プロトコル用のフォームテンプレート

grant_types
string[]

クライアントが使用を許可されているグラントタイプのセット。authorization_codeimplicitrefresh_tokenclient_credentialspasswordhttp://auth0.com/oauth/grant-type/password-realmhttp://auth0.com/oauth/grant-type/mfa-oobhttp://auth0.com/oauth/grant-type/mfa-otphttp://auth0.com/oauth/grant-type/mfa-recovery-codeurn:openid:params:grant-type:cibaurn:ietf:params:oauth:grant-type:device_codeurn:auth0:params:oauth:grant-type:token-exchange:federated-connection-access-token を含めることができます。

Minimum string length: 1
initiate_login_uri
string<absolute-https-uri-with-placeholders-or-empty>

ログイン開始 URI。https である必要があります

is_first_party
boolean
デフォルト:true

このクライアントがファーストパーティクライアントかどうか

is_token_endpoint_ip_header_trusted
boolean
デフォルト:false

true の場合、トークンエンドポイントのブルートフォース対策において、auth0-forwarded-for ヘッダーで指定された IP をエンドユーザーの IP として信頼します。

jwt_configuration
object

JWT の作成方法に関する設定を保持するオブジェクト

logo_uri
string<absolute-uri-or-empty>

クライアントロゴの URL(推奨サイズ: 150x150)

mobile
object

ネイティブモバイルアプリに関する設定

my_organization_configuration
object | null
EA

クライアントの My Organization Configuration に関連する設定。

name
string

クライアントの名前。1 文字以上である必要があります。'<' または '>' は使用できません。

Pattern: ^[^<>]+$
native_social_login
object | null

ネイティブソーシャルの設定

oidc_backchannel_logout
object
deprecated

OIDC バックチャネルログアウトの設定(非推奨。代わりに oidc_logout を使用)

oidc_conformant
boolean
デフォルト:false

このクライアントが厳密な OIDC 仕様に準拠するかどうか

oidc_logout
object

OIDC バックチャネルログアウトの設定

organization_discovery_methods
enum<string>[] | null
EA

pre_login_prompt での組織検出に使用できる方法を定義します。ユーザーは emailorganization_name、またはその両方を使って自分の組織を検出できます。

Minimum array length: 1

pre_login_prompt 中に組織を特定する方法。email では、ユーザーがメールアドレスを入力してドメイン照合を行うことで組織を見つけられます。一方、organization_name では、ユーザーが組織名を直接入力する必要があります。これらの方法は組み合わせて使用できます。

利用可能なオプション:
email,
organization_name
organization_require_behavior
enum<string> | null
デフォルト:no_prompt

client.organization_usage: 'require' の場合に、認証トランザクション中の処理方法を定義します。no_prompt(デフォルト)、pre_login_promptpost_login_prompt のいずれかを指定できます。post_login_prompt には oidc_conformant: true が必要です。

利用可能なオプション:
no_prompt,
pre_login_prompt,
post_login_prompt,
null
organization_usage
enum<string> | null
デフォルト:deny

組織に関して、認証トランザクション中にどのように処理を進めるかを定義します。deny(デフォルト)、allowrequire のいずれかを指定できます。

利用可能なオプション:
deny,
allow,
require,
null
par_request_expiry
integer | null

プッシュ型認可リクエスト URI が有効な期間を秒単位で指定します

必須範囲: 10 <= x <= 600
redirection_policy
enum<string>
GA

認証エラー時、またはメールアドレス確認フローで、Auth0 がユーザーをアプリケーションのコールバックURLにリダイレクトするかどうかを制御します。open_redirect_protection はリダイレクトの代わりにエラーページを表示し、メールテンプレートからコールバック ドメインを非表示にします。allow_always は標準のリダイレクト動作を有効にします。サードパーティ クライアントでは、デフォルトで open_redirect_protection が使用されます。これは is_first_partyfalse で、かつ third_party_security_modestrict の場合にのみ適用されます。詳細は、Redirect protection を参照してください。

利用可能なオプション:
allow_always,
open_redirect_protection
refresh_token
object | null

リフレッシュトークンの設定

require_proof_of_possession
boolean
デフォルト:false

このクライアントでは所有証明の使用が必須です

require_pushed_authorization_requests
boolean
デフォルト:false

このクライアントでは、プッシュ型認可リクエストの使用が必須になります

session_transfer
object | null

ネイティブから Web への SSO の設定

signed_request_object
object

JWT-Secured Authorization Requests(JAR)の設定。

skip_non_verifiable_callback_uri_confirmation_prompt
boolean | null

リダイレクト URI に検証不能なコールバック URI(たとえば、myapp:// のようなカスタム URI スキームや localhost)が使用されている場合に、ログインフロー中に確認プロンプトを表示するかどうかを制御します。 true に設定すると、確認プロンプトは表示されません。悪意のあるアプリによるなりすましへの保護を強化するため、この設定は false にすることを推奨します。 詳細については、https://auth0.com/docs/secure/security-guidance/measures-against-app-impersonation を参照してください。

sso
boolean

シングルサインオンの実行に IdP ではなく Auth0 を使用する場合は true、それ以外の場合は false(デフォルト: false

sso_disabled
boolean

シングルサインオンを無効にする場合は true、それ以外の場合は false(デフォルト: false

third_party_security_mode
enum<string>
GA

サードパーティクライアントのセキュリティモード。strict強化されたセキュリティ制御を適用します。これには、OAuth 2.1への準拠、明示的なAPI認可、サポート対象機能を厳選したセットが含まれます。permissive従来の動作を維持し、過去にサードパーティクライアントの使用実績があるテナントでのみ利用できます。作成時に設定し、後から変更することはできません。

利用可能なオプション:
strict,
permissive
token_endpoint_auth_method
enum<string> | null
デフォルト:none

トークンエンドポイントに対して要求する認証方法を定義します。none(クライアントシークレットを持たないパブリッククライアント)、client_secret_post(クライアントがHTTP POSTパラメーターを使用)、またはclient_secret_basic(クライアントがHTTP Basicを使用)を指定できます。

利用可能なオプション:
none,
client_secret_post,
client_secret_basic,
null
token_exchange
object | null
GA

トークン交換の設定。

token_quota
object | null
EA
web_origins
string<url-with-placeholders>[]

web message response mode で使用する有効な Web オリジンを表す URL のセット

レスポンス

クライアントを正常に更新しました。

addons
object

このクライアントで有効になっているアドオンと、それぞれに関連付けられた設定。

allowed_clients
string[]

デリゲーションリクエストを実行できる許可済みクライアントおよび API id のリスト。空の場合は、すべてのクライアントが許可されます。

allowed_logout_urls
string[]

Auth0 からログアウトした後のリダイレクト先として有効な URL のカンマ区切りリスト。サブドメインにはワイルドカードを使用できます。

allowed_origins
string[]

JavaScript から Auth0 API へのリクエストを許可する URL のカンマ区切りリストです(通常は CORS で使用されます)。デフォルトでは、すべてのコールバック URL が許可されます。このフィールドでは、必要に応じて別のオリジンを入力できます。サブドメインレベルのワイルドカード(例: https://*.contoso.com)も使用できます。これらの URL の検証時には、クエリ文字列とハッシュ情報は考慮されません。

app_type
enum<string>

このクライアントが表すアプリケーションの種類

利用可能なオプション:
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
async_approval_notification_channels
enum<string>[]

承認が必要な場合にユーザーに通知するための通知チャネルの配列。有効な値は guardian-pushemail です。

Minimum array length: 1
利用可能なオプション:
guardian-push,
email
callbacks
string[]

認証後に Auth0 がクライアントへのコールバックとして使用できる、許可済み URL のカンマ区切りリスト。

client_aliases
string[]

SAML プロトコル用のオーディエンス / レルムのリスト。wsfed アドオンで使用されます。

client_authentication_methods
object | null

クライアント認証方法を定義します。

client_id
string
デフォルト:AaiyAPdpYdesoKnqjj8HJqRn4T5titww

このクライアントの ID。

client_metadata
object

クライアントに関連付けられたメタデータ。文字列値を持つオブジェクト形式です(最大255文字)。メタデータのプロパティは最大10件まで指定できます。フィールド名(最大255文字)は英数字で、使用できる特殊文字は次のとおりです: :,-+=_*?"/\()<>@\t[Tab] [Space]

client_secret
string
デフォルト:MG_TNT2ver-SylNat-_VeMmd-4m0Waba0jr1troztBniSChEw0glxEmgEi2Kw40H

クライアントシークレット(公開してはいけません)。

compliance_level
enum<string> | null

このクライアントの準拠レベルを定義します。これにより、機能が制限される場合があります。

利用可能なオプション:
none,
fapi1_adv_pkj_par,
fapi1_adv_mtls_par,
fapi2_sp_pkj_mtls,
fapi2_sp_mtls_mtls,
null
cross_origin_authentication
boolean

このクライアントをクロスオリジン認証リクエストに使用できるか(true)、そのようなリクエストが許可されていないか(false)を示します。

cross_origin_loc
string<url>

Auth0 のホスト型ログインページではなく独自のドメインで認証を実行する場合に、クロスオリジン認証フローでクロスオリジン検証を行うサイト上の場所の URL。

custom_login_page
string
デフォルト:""

カスタムログインページのコンテンツ(HTML、CSS、JS)。

custom_login_page_on
boolean
デフォルト:true

カスタムログインページを使用する(true)か、提供されるデフォルトのログインページを使用する(false)かを示します。

custom_login_page_preview
string
デフォルト:""

カスタムログインページのコンテンツ(HTML、CSS、JS)。(プレビューで使用)

default_organization
object | null

デフォルトの組織 ID とフローを定義します。

description
string
デフォルト:""

このクライアントの説明を自由記述で指定します(最大長: 140 文字)。

encryption_key
object | null

このクライアントの WsFed レスポンスで使用される暗号化。

express_configuration
object

OIN Express Configuration 機能で使用するアプリケーション固有の設定。

external_client_id
string<absolute-https-uri-or-empty>

認可フロー中に使用する代替クライアント識別子です。CIMD ベースのクライアント識別子のみサポートされます。

external_metadata_created_by
enum<string>

外部メタデータ クライアントを作成した主体を示します。値 admin は、クライアントが Management API 経由で登録されたことを示します。値 client は、クライアントが動的に登録されたことを示します。このフィールドは、external_metadata_type が設定されている場合にのみ存在します。

利用可能なオプション:
admin,
client
external_metadata_type
enum<string>

クライアントの登録に使用された外部メタデータの種類を示します。このフィールドは通常のクライアントでは省略されます。値 cimd は、Client ID Metadata Document 経由で登録されたクライアントを示します。値 dcr は、動的クライアント登録によって登録されたクライアントを示します。

利用可能なオプション:
cimd,
dcr
fedcm_login
object
EA

New Universal Login の FedCM ログイン設定を構成します

form_template
string
デフォルト:""

WS-Federation で使用する HTML フォームテンプレート。

global
boolean
デフォルト:false

これがレガシーなテナント設定を表すグローバルな「All Applications」クライアント(true)か、通常のクライアント(false)かを示します。

grant_types
string[]

このアプリケーションでサポートされるグラントタイプのリスト。authorization_codeimplicitrefresh_tokenclient_credentialspasswordhttp://auth0.com/oauth/grant-type/password-realmhttp://auth0.com/oauth/grant-type/mfa-oobhttp://auth0.com/oauth/grant-type/mfa-otphttp://auth0.com/oauth/grant-type/mfa-recovery-codeurn:openid:params:grant-type:cibaurn:ietf:params:oauth:grant-type:device_code、および urn:auth0:params:oauth:grant-type:token-exchange:federated-connection-access-token を含めることができます。

initiate_login_uri
string<absolute-https-uri-with-placeholders-or-empty>

ログイン開始 URI。https である必要があります

is_first_party
boolean
デフォルト:false

このクライアントがファーストパーティクライアント(true)かどうか(false)を示します。

is_token_endpoint_ip_header_trusted
boolean
デフォルト:false

true の場合、トークンエンドポイントでのブルートフォース対策のため、auth0-forwarded-for ヘッダーで指定された IP をエンドユーザーの IP として信頼します。

jwks_uri
string<absolute-https-uri-or-empty>

private_key_jwt 認証で使用される公開鍵を含む JSON Web Key Set(JWKS)の URL です。private_key_jwt 認証を使用する CIMD クライアントにのみ存在します。

jwt_configuration
object

クライアントのJWTに関連する設定。

logo_uri
string

このクライアントに表示するロゴの URL。推奨サイズは 150 x 150 ピクセルです。

mobile
object

ネイティブモバイルアプリ向けの追加設定。

my_organization_configuration
object
EA

クライアントの My Organization Configuration に関連する設定。

name
string
デフォルト:My application

このクライアントの名前(最小長: 1 文字。<> は使用できません)。

native_social_login
object

ネイティブソーシャル設定を構成

oidc_conformant
boolean
デフォルト:false

このクライアントが厳格な OIDC 仕様に準拠している(true)か、レガシー機能を使用する(false)かを示します。

oidc_logout
object

OIDC バックチャネルログアウトの設定

organization_discovery_methods
enum<string>[]
EA

pre_login_prompt での組織検出に使用できる方法を定義します。ユーザーは emailorganization_name、またはその両方で自分の組織を検出できます。

Minimum array length: 1

pre_login_prompt 中に組織を特定する方法。email では、ユーザーがメールアドレスを入力してドメイン照合を行うことで組織を見つけられます。一方、organization_name では、ユーザーが組織名を直接入力する必要があります。これらの方法は組み合わせて使用できます。

利用可能なオプション:
email,
organization_name
organization_require_behavior
enum<string>
デフォルト:no_prompt

client.organization_usage: 'require' の場合に、認証トランザクション中の処理方法を定義します。no_prompt(デフォルト)、pre_login_promptpost_login_prompt のいずれかを指定できます。post_login_prompt には oidc_conformant: true が必要です。

利用可能なオプション:
no_prompt,
pre_login_prompt,
post_login_prompt
organization_usage
enum<string>
デフォルト:deny

組織に関して、認証トランザクション中にどのように処理を進めるかを定義します。deny(デフォルト)、allowrequire のいずれかを指定できます。

利用可能なオプション:
deny,
allow,
require
par_request_expiry
integer | null

プッシュ型認可リクエスト URI が有効であり続ける期間を秒単位で指定します

必須範囲: 10 <= x <= 600
redirection_policy
enum<string>
GA

認証エラー時、またはメールアドレス確認フローで、Auth0 がユーザーをアプリケーションのコールバックURLにリダイレクトするかどうかを制御します。open_redirect_protection はリダイレクトの代わりにエラーページを表示し、メールテンプレートからコールバック ドメインを非表示にします。allow_always は標準のリダイレクト動作を有効にします。サードパーティ クライアントでは、デフォルトで open_redirect_protection が使用されます。これは is_first_partyfalse で、かつ third_party_security_modestrict の場合にのみ適用されます。詳細は、Redirect protection を参照してください。

利用可能なオプション:
allow_always,
open_redirect_protection
refresh_token
object | null

リフレッシュトークンの設定

require_proof_of_possession
boolean
デフォルト:false

このクライアントでは所有証明の使用が必須です

require_pushed_authorization_requests
boolean
デフォルト:false

このクライアントではプッシュ型認可リクエストの使用が必須です

resource_server_identifier
string

このクライアントが関連付けられているリソースサーバーの識別子です。

session_transfer
object | null

ネイティブから Web への SSO の設定

signed_request_object
object

JWT-Secured Authorization Requests(JAR)の設定。

signing_keys
object[] | null

このクライアントに関連付けられた署名証明書。

skip_non_verifiable_callback_uri_confirmation_prompt
boolean

リダイレクト URI で検証できないコールバック URI(たとえば、myapp:// のようなカスタム URI スキーマや localhost)を使用している場合に、Login フロー中に確認プロンプトを表示するかどうかを制御します。 true に設定すると、確認プロンプトは表示されません。悪意のあるアプリからの保護を強化するため、この設定は false にすることを推奨します。 詳細については、https://auth0.com/docs/secure/security-guidance/measures-against-app-impersonation を参照してください。

sso
boolean
デフォルト:false

SSO クライアントにのみ適用され、Auth0 がシングルサインオンを処理するか(true)、IDプロバイダーが処理するか(false)を決定します。

sso_disabled
boolean
デフォルト:false

シングルサインオンが無効(true)か有効(false)かを示します。デフォルトは true です。

tenant
string
デフォルト:""

このクライアントが属するテナントの名前。

third_party_security_mode
enum<string>
GA

サードパーティクライアントのセキュリティモード。strict強化されたセキュリティ制御を適用します。これには、OAuth 2.1への準拠、明示的なAPI認可、サポート対象機能を厳選したセットが含まれます。permissive従来の動作を維持し、過去にサードパーティクライアントの使用実績があるテナントでのみ利用できます。作成時に設定し、後から変更することはできません。

利用可能なオプション:
strict,
permissive
token_endpoint_auth_method
enum<string>
デフォルト:none

トークンエンドポイントに対して要求する認証方法を定義します。none(クライアントシークレットを持たないパブリッククライアント)、client_secret_post(クライアントがHTTP POSTパラメーターを使用)、またはclient_secret_basic(クライアントがHTTP Basicを使用)を指定できます。

利用可能なオプション:
none,
client_secret_post,
client_secret_basic
token_exchange
object
GA

トークン交換の設定。

token_quota
object
EA
web_origins
string[]

クロスオリジン認証デバイスフロー、および web message response mode で使用する許可済みオリジンのカンマ区切りリスト。