クライアント一覧を取得
指定したフィルターに一致するクライアント(アプリケーションおよび SSO 連携)を取得します。含めるフィールドまたは除外するフィールドのリストも指定できます。 詳細については、Auth0 のアプリケーションおよびシングルサインオンを参照してください。
- 次の項目は、任意のスコープで取得できます。
client_id、app_type、name、description。 - 次のプロパティは、
read:clientsまたはread:client_keysスコープでのみ取得できます。callbacks、oidc_logout、allowed_origins、web_origins、tenant、global、config_route、callback_url_template、jwt_configuration、jwt_configuration.lifetime_in_seconds、jwt_configuration.secret_encoded、jwt_configuration.scopes、jwt_configuration.alg、api_type、logo_uri、allowed_clients、owners、custom_login_page、custom_login_page_on、sso、addons、form_template、custom_login_page_codeview、resource_servers、client_metadata、mobile、mobile.android、mobile.ios、allowed_logout_urls、token_endpoint_auth_method、is_first_party、oidc_conformant、is_token_endpoint_ip_header_trusted、initiate_login_uri、grant_types、refresh_token、refresh_token.rotation_type、refresh_token.expiration_type、refresh_token.leeway、refresh_token.token_lifetime、refresh_token.policies、organization_usage、organization_require_behavior。 - 次のプロパティは、
read:client_keysまたはread:client_credentialsスコープでのみ取得できます。encryption_key、encryption_key.pub、encryption_key.cert、client_secret、client_authentication_methods、signing_key。
承認
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
クエリパラメータ
結果に含める、または除外するフィールド(include_fields に指定した値に応じた)のカンマ区切り一覧です。すべてのフィールドを取得するには空のままにしてください。
指定したフィールドを含める(true)か、除外する(false)かを指定します。
返される結果のページ index です。最初のページは 0 です。
x >= 01 ページあたりの結果数。デフォルト値は 50、最大値は 100 です
0 <= x <= 100結果を、総件数を含むオブジェクト内に返すか(true)、結果の配列を直接返すか(false、デフォルト)を指定します。
選択を開始する位置を示す省略可能な ID。
1 ページあたりの結果数。デフォルトは 50 です。
1 <= x <= 100global クライアントパラメーターに対する省略可能なフィルター。
クライアントがファーストパーティ クライアントかどうかを指定する省略可能なフィルター。
アプリケーションの種類をカンマ区切りで指定する省略可能なフィルター。
CIMD に登録されたクライアントの Client ID Metadata Document URI で絞り込む省略可能なフィルター。
1 - 120レスポンス
クライアントの取得に成功しました。
- Option 1 · object[]
- Option 2 · object
- Option 3 · object
このクライアントの ID。
このクライアントが作成された日時の ISO 8601 タイムスタンプ。
このクライアントが最後に更新された日時の ISO 8601 タイムスタンプ。
このクライアントが属する tenant の名前。
このクライアントの名前(最小長: 1 文字、< と > は使用不可)。
このクライアントの自由記述の説明(最大長: 140 文字)。
これが、レガシーな tenant 設定を表すグローバルな「All Applications」クライアント(true)か、通常のクライアント(false)かどうか。
クライアントシークレット(公開してはいけません)。
このクライアントが表すアプリケーションの種類
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 このクライアントに表示するロゴの URL。推奨サイズは 150x150 ピクセルです。
このクライアントがファーストパーティクライアントかどうか(true)、またはそうでないかどうか(false)。
このクライアントが厳格な OIDC 仕様に準拠しているか(true)、またはレガシー機能を使用するか(false)。
authentication 後に Auth0 がクライアントへのコールバックとして使用できる、許可リストに登録された URL のカンマ区切りリスト。
JavaScript から Auth0 API へのリクエストを許可する URL のカンマ区切りリスト(通常は CORS で使用)。デフォルトでは、すべてのコールバック URL が許可されます。このフィールドでは、必要に応じて他のオリジンを指定できます。サブドメインレベルの wildcard(例: https://*.contoso.com)も使用できます。これらの URL を検証する際、query string とハッシュ情報は考慮されません。
Cross-Origin Authentication、Device Flow、およびweb message response modeで使用する、許可されたオリジンのリスト。
SAML プロトコル用の audience/レルム のリスト。wsfed addon で使用されます。
委譲リクエストの実行を許可するクライアントおよび API ID のリスト。空の場合は、すべてのクライアントが許可されます。
Auth0 からのログアウト後のリダイレクト先として有効な URL のカンマ区切りリスト。サブドメインには wildcard を使用できます。
ネイティブからWebへのSSO の設定
OIDCバックチャネルログアウトの設定
このアプリケーションでサポートされるグラントタイプのリスト。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 を含めることができます。
クライアントのJWTに関する設定。
このクライアントに関連付けられた署名証明書。
このクライアントの WS-Fed レスポンスで使用される暗号化。
SSO クライアントにのみ適用され、シングルサインオンを Auth0 が処理するか(true)、IDプロバイダーが処理するか(false)を決定します。
シングルサインオンを無効にするか(true)、有効にするか(true)。デフォルトは true です。
このクライアントを cross-origin authentication リクエストに使用できるか(true)、またはそのようなリクエストの実行が許可されていないか(false)。
Auth0 hosted login page ではなく独自ドメインで Auth を実行する際に、cross-origin auth フローで cross origin 検証を行うサイト上の URL。
カスタム login page を使用するか(true)、デフォルトの login page を使用するか(false)。
カスタム login page の内容(HTML、CSS、JS)。
カスタム login page の内容(HTML、CSS、JS)。(プレビューで使用)
WS-Federation で使用する HTML フォームテンプレート。
このクライアントで有効になっているアドオンと、その関連設定。
トークンエンドポイントに対して要求される認証方法を定義します。none(client secret を持たないパブリッククライアント)、client_secret_post(クライアントは HTTP POST パラメーターを使用)、または client_secret_basic(クライアントは HTTP Basic を使用)を指定できます。
none, client_secret_post, client_secret_basic true の場合、token endpoint でのブルートフォース保護において、auth0-forwarded-for ヘッダーで指定された IP をエンドユーザーの IP として信頼します。
クライアントに関連付けられたメタデータ。文字列値を持つオブジェクト形式です(最大255文字)。メタデータプロパティは最大10個まで使用できます。フィールド名(最大255文字)は英数字で、使用できる特殊文字は次のとおりです: :,-+=_*?"/()<>@ [Tab] [Space]
ネイティブモバイルアプリ向けの追加設定。
ログイン開始 URI。https である必要があります
ネイティブソーシャルの設定
新しい Universal Login の FedCM ログイン設定を構成
リフレッシュトークンの設定
デフォルトの組織IDとフローを定義します。
organization に関して認証トランザクションをどのように進めるかを定義します。deny(デフォルト)、allow、または require を指定できます。
deny, allow, require 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 pre_login_prompt 中の organization 検出で利用可能な方法を定義します。ユーザーは email、organization_name、またはその両方で organization を検出できます。
1pre_login_prompt 中に組織を検出する方法。email では、ユーザーはメールアドレスを入力してドメイン照合を行うことで自分の組織を見つけられます。一方、organization_name では、ユーザーが organization名 を直接入力する必要があります。これらの方法は組み合わせて使用できます。
email, organization_name クライアント認証方法を定義します。
このクライアントに対してプッシュ型認可リクエストの使用を必須にします
このクライアントに対して Proof-of-Possession の使用を必須にします
JWT で保護された認可リクエスト(JAR)の設定。
Token Vault の特権アクセスに関する設定。
このクライアントの準拠レベルを定義します。これにより、機能が制限される場合があります。
none, fapi1_adv_pkj_par, fapi1_adv_mtls_par, fapi2_sp_pkj_mtls, fapi2_sp_mtls_mtls, null リダイレクト URI が検証不能なコールバック URI(たとえば myapp:// のようなカスタム URI スキーマや localhost)を使用している場合に、ログインフロー中に confirmation prompt を表示するかどうかを制御します。
true に設定すると、confirmation prompt は表示されません。悪意のあるアプリからの保護を強化するため、false に設定することを推奨します。
詳細は https://auth0.com/docs/secure/security-guidance/measures-against-app-impersonation を参照してください。
トークン交換の設定。
プッシュ型認可リクエスト URI の有効期間を秒単位で指定します
10 <= x <= 600OIN Express Configuration機能で使用するアプリケーション固有の設定。
B2B 連携クライアントの設定。
クライアントの My Organization Configuration に関連する設定。
クロスアプリアクセスにおける ID-JAG の使用に関する設定。
このクライアントの匿名セッション設定。
匿名セッション転送トークンの使用時にネットワークへの紐付けを強制するかどうかを示します。'ip' に設定すると、発行者と同じ IP アドレスから使用する必要があります。'asn' に設定すると、発行者と同じ ASN から使用する必要があります。'none' に設定すると、紐付けは強制されません。既定値は ip です。
ip, asn, none サードパーティ クライアントのセキュリティモード。strict は、強化されたセキュリティ制御を適用します。これには、OAuth 2.1 への準拠、明示的な API 認可、サポート対象機能を厳選したセットが含まれます。permissive は既存の動作を維持し、以前からサードパーティ クライアントを使用している tenant でのみ利用できます。作成時に設定され、後から変更することはできません。
strict, permissive 認証エラー時またはメール認証フローにおいて、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 このクライアントがリンクされているリソースサーバーの identifier。
承認が必要な場合にユーザーへ通知するための通知チャネルの配列。有効な値は guardian-push、email、my-account です。
1guardian-push, email, my-account クライアントの登録に使用された外部メタデータの種類を示します。このフィールドは通常のクライアントでは省略されます。値 cimd は、Client ID Metadata Document 経由で登録されたクライアントを示します。値 dcr は、Dynamic Client Registration 経由で登録されたクライアントを示します。
cimd, dcr 外部メタデータ クライアントを作成した主体を示します。値 admin は、クライアントが Management API 経由で登録されたことを示します。値 client は、クライアントが動的に登録されたことを示します。このフィールドは、external_metadata_type が設定されている場合にのみ存在します。
admin, client 認可フロー中に使用する代替のクライアント識別子。CIMD ベースのクライアント識別子のみをサポートします。
private_key_jwt authentication に使用される公開鍵を含む JSON Web Key Set(JWKS)の URL。private_key_jwt authentication を使用する CIMD クライアントにのみ存在します。