クライアントを取得

指定したフィルターに一致するクライアント（アプリケーションおよび 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_off、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。

GET https://{tenantDomain}/api/v2/clients

C#

C#

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

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.ListAsync(
            new ListClientsRequestParameters {
                Fields = "fields",
                IncludeFields = true,
                Page = 1,
                PerPage = 1,
                IncludeTotals = true,
                IsGlobal = true,
                IsFirstParty = true,
                AppType = "app_type",
                ExternalClientId = "external_client_id",
                Q = "q"
            }
        );
    }

}

200

[
  {
    "addons": {
      "aws": {
        "lifetime_in_seconds": 22050,
        "principal": "<string>",
        "role": "<string>"
      },
      "azure_blob": {
        "accountName": "<string>",
        "blobName": "<string>",
        "blob_delete": true,
        "blob_read": true,
        "blob_write": true,
        "containerName": "<string>",
        "container_delete": true,
        "container_list": true,
        "container_read": true,
        "container_write": true,
        "expiration": 1,
        "signedIdentifier": "<string>",
        "storageAccessKey": "<string>"
      },
      "azure_sb": {
        "entityPath": "<string>",
        "expiration": 123,
        "namespace": "<string>",
        "sasKey": "<string>",
        "sasKeyName": "<string>"
      },
      "box": {},
      "cloudbees": {},
      "concur": {},
      "dropbox": {},
      "echosign": {
        "domain": "<string>"
      },
      "egnyte": {
        "domain": "<string>"
      },
      "firebase": {
        "client_email": "<string>",
        "lifetime_in_seconds": 123,
        "private_key": "<string>",
        "private_key_id": "<string>",
        "secret": "<string>"
      },
      "layer": {
        "keyId": "<string>",
        "privateKey": "<string>",
        "providerId": "<string>",
        "expiration": 1,
        "principal": "<string>"
      },
      "mscrm": {
        "url": "<string>"
      },
      "newrelic": {
        "account": "<string>"
      },
      "oag": {},
      "office365": {
        "connection": "<string>",
        "domain": "<string>"
      },
      "rms": {
        "url": "<string>"
      },
      "salesforce": {
        "entity_id": "<string>"
      },
      "salesforce_api": {
        "clientid": "<string>",
        "communityName": "<string>",
        "community_url_section": "<string>",
        "principal": "<string>"
      },
      "salesforce_sandbox_api": {
        "clientid": "<string>",
        "communityName": "<string>",
        "community_url_section": "<string>",
        "principal": "<string>"
      },
      "samlp": {
        "audience": "<string>",
        "authnContextClassRef": "<string>",
        "createUpnClaim": true,
        "destination": "<string>",
        "digestAlgorithm": "<string>",
        "issuer": "<string>",
        "lifetimeInSeconds": 123,
        "mapIdentities": true,
        "mapUnknownClaimsAsIs": true,
        "mappings": {},
        "nameIdentifierFormat": "<string>",
        "nameIdentifierProbes": [
          "<string>"
        ],
        "passthroughClaimsWithNoMapping": true,
        "recipient": "<string>",
        "signResponse": true,
        "signatureAlgorithm": "<string>"
      },
      "sap_api": {
        "clientid": "<string>",
        "nameIdentifierFormat": "<string>",
        "scope": "<string>",
        "servicePassword": "<string>",
        "tokenEndpointUrl": "<string>",
        "usernameAttribute": "<string>"
      },
      "sentry": {
        "base_url": "<string>",
        "org_slug": "<string>"
      },
      "sharepoint": {
        "external_url": [
          "<string>"
        ],
        "url": "<string>"
      },
      "slack": {
        "team": "<string>"
      },
      "springcm": {
        "acsurl": "<string>"
      },
      "sso_integration": {
        "name": "<string>",
        "version": "<string>"
      },
      "wams": {
        "masterkey": "<string>"
      },
      "wsfed": {},
      "zendesk": {
        "accountName": "<string>"
      },
      "zoom": {
        "account": "<string>"
      }
    },
    "allowed_clients": [
      "<string>"
    ],
    "allowed_logout_urls": [
      "<string>"
    ],
    "allowed_origins": [
      "<string>"
    ],
    "async_approval_notification_channels": [],
    "b2b_integration_configuration": {
      "sso_profiles": [
        "<string>"
      ]
    },
    "callbacks": [
      "<string>"
    ],
    "client_aliases": [
      "<string>"
    ],
    "client_authentication_methods": {
      "private_key_jwt": {
        "credentials": [
          {
            "id": "<string>"
          }
        ]
      },
      "self_signed_tls_client_auth": {
        "credentials": [
          {
            "id": "<string>"
          }
        ]
      },
      "tls_client_auth": {
        "credentials": [
          {
            "id": "<string>"
          }
        ]
      }
    },
    "client_id": "AaiyAPdpYdesoKnqjj8HJqRn4T5titww",
    "client_metadata": {},
    "client_secret": "MG_TNT2ver-SylNat-_VeMmd-4m0Waba0jr1troztBniSChEw0glxEmgEi2Kw40H",
    "cross_origin_authentication": true,
    "cross_origin_loc": "<string>",
    "custom_login_page": "",
    "custom_login_page_on": true,
    "custom_login_page_preview": "",
    "default_organization": {
      "flows": [
        "client_credentials"
      ],
      "organization_id": "<string>"
    },
    "description": "",
    "encryption_key": {
      "cert": "<string>",
      "pub": "<string>",
      "subject": "<string>"
    },
    "express_configuration": {
      "admin_login_domain": "<string>",
      "connection_profile_id": "<string>",
      "enable_client": true,
      "enable_organization": true,
      "initiate_login_uri_template": "<string>",
      "okta_oin_client_id": "<string>",
      "user_attribute_profile_id": "<string>",
      "linked_clients": [
        {
          "client_id": "<string>"
        }
      ],
      "oin_submission_id": "<string>"
    },
    "external_client_id": "<string>",
    "fedcm_login": {
      "google": {
        "is_enabled": false
      }
    },
    "form_template": "",
    "global": false,
    "grant_types": [
      "<string>"
    ],
    "identity_assertion_authorization_grant": {
      "active": false
    },
    "initiate_login_uri": "<string>",
    "is_first_party": false,
    "is_token_endpoint_ip_header_trusted": false,
    "jwks_uri": "<string>",
    "jwt_configuration": {
      "alg": "HS256",
      "lifetime_in_seconds": 36000,
      "scopes": {},
      "secret_encoded": true
    },
    "logo_uri": "<string>",
    "mobile": {
      "android": {
        "app_package_name": "",
        "sha256_cert_fingerprints": [
          "<string>"
        ]
      },
      "ios": {
        "app_bundle_identifier": "",
        "team_id": ""
      }
    },
    "my_organization_configuration": {
      "allowed_strategies": [],
      "connection_deletion_behavior": "allow",
      "connection_profile_id": "<string>",
      "invitation_landing_client_id": "<string>",
      "user_attribute_profile_id": "<string>"
    },
    "name": "My application",
    "native_social_login": {
      "apple": {
        "enabled": false
      },
      "facebook": {
        "enabled": false
      },
      "google": {
        "enabled": false
      }
    },
    "oidc_conformant": false,
    "oidc_logout": {
      "backchannel_logout_initiators": {
        "selected_initiators": []
      },
      "backchannel_logout_session_metadata": {
        "include": true
      },
      "backchannel_logout_urls": [
        "<string>"
      ]
    },
    "organization_discovery_methods": [],
    "organization_require_behavior": "no_prompt",
    "organization_usage": "deny",
    "par_request_expiry": 305,
    "refresh_token": {
      "expiration_type": "non-expiring",
      "rotation_type": "non-rotating",
      "idle_token_lifetime": 2,
      "infinite_idle_token_lifetime": false,
      "infinite_token_lifetime": true,
      "leeway": 0,
      "policies": [
        {
          "audience": "<string>",
          "scope": [
            "<string>"
          ]
        }
      ],
      "token_lifetime": 78894000
    },
    "require_proof_of_possession": false,
    "require_pushed_authorization_requests": false,
    "resource_server_identifier": "<string>",
    "session_transfer": {
      "allow_refresh_token": false,
      "allowed_authentication_methods": [],
      "can_create_session_transfer_token": false,
      "delegation": {
        "allow_delegated_access": false,
        "enforce_device_binding": "ip"
      },
      "enforce_cascade_revocation": true,
      "enforce_device_binding": "ip",
      "enforce_online_refresh_tokens": true
    },
    "signed_request_object": {
      "credentials": [
        {
          "id": "<string>"
        }
      ],
      "required": false
    },
    "signing_keys": [
      {
        "cert": "",
        "pkcs7": "",
        "subject": ""
      }
    ],
    "skip_non_verifiable_callback_uri_confirmation_prompt": true,
    "sso": false,
    "sso_disabled": false,
    "tenant": "",
    "token_endpoint_auth_method": "none",
    "token_exchange": {
      "allow_any_profile_of_type": []
    },
    "token_quota": {
      "client_credentials": {
        "enforce": true,
        "per_day": 1073741824,
        "per_hour": 1073741824
      }
    },
    "token_vault_privileged_access": {
      "credentials": [
        {
          "id": "<string>"
        }
      ],
      "grants": [
        {
          "connection": "<string>",
          "scopes": [
            "<string>"
          ]
        }
      ],
      "ip_allowlist": [
        "127.0.0.1"
      ]
    },
    "web_origins": [
      "<string>"
    ]
  }
]

承認

bearerAuthoAuth2ClientCredentials

Authorization · string · header · 必須

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

クエリパラメータ

fields · string

結果に含める、または除外するフィールド（include_fields に指定した値に応じた）のカンマ区切り一覧です。すべてのフィールドを取得するには空のままにしてください。

include_fields · boolean

指定したフィールドを含める（true）か、除外する（false）かを指定します。

page · integer

返される結果のページ index です。最初のページは 0 です。

必須範囲: x >= 0

per_page · integer

1 ページあたりの結果数。デフォルト値は 50、最大値は 100 です

必須範囲: 0 <= x <= 100

include_totals · boolean

結果を、総件数を含むオブジェクト内に返すか（true）、結果の配列を直接返すか（false、デフォルト）を指定します。

from · string

選択を開始する位置を示す省略可能な ID。

take · integer

1 ページあたりの結果数。デフォルトは 50 です。

必須範囲: 1 <= x <= 100

is_global · boolean

global クライアントパラメーターに対する省略可能なフィルター。

is_first_party · boolean

クライアントがファーストパーティ クライアントかどうかを指定する省略可能なフィルター。

app_type · string

アプリケーションの種類をカンマ区切りで指定する省略可能なフィルター。

external_client_id · string

CIMD に登録されたクライアントの Client ID Metadata Document URI で絞り込む省略可能なフィルター。

Required string length: 1 - 120

q · string

Lucene 構文による高度なクエリ。
使用できるクエリ:

• client_grant.organization_id:{organization_id}
• client_grant.allow_any_organization:true

追加の制限:

• ほかのフィルターと組み合わせて使用することはできません
• from および take のページングパラメーター（checkpoint ページネーション）を使用する必要があります
• より厳しいレート制限が適用されます。レート制限の構成を参照してください

注: 最近の更新は、クエリ結果にすぐには反映されない場合があります

レスポンス

200

application/json

クライアントの取得に成功しました。

Option 1 · object[]

Option 2 · object

Option 3 · object

addons · object

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

Show child attributes

allowed_clients · string[]

委譲リクエストの実行を許可するクライアントおよび API ID のリスト。空の場合は、すべてのクライアントが許可されます。

allowed_logout_urls · string[]

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

allowed_origins · string[]

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

app_type · enum<string>

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

利用可能なオプション: native, spa, regular_web, non_interactive, resource_server, express_configuration, b2b_integration, 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-push、email です。

Minimum array length: 1

利用可能なオプション: guardian-push, email

b2b_integration_configuration · object · beta

B2B 連携クライアントの設定。

Show child attributes

callbacks · string[]

authentication 後に Auth0 がクライアントへのコールバックとして使用できる、許可リストに登録された URL のカンマ区切りリスト。

client_aliases · string[]

SAML プロトコル用の audience/レルム のリスト。wsfed addon で使用されます。

client_authentication_methods · object | null

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

Show child attributes

client_id · string · デフォルト: AaiyAPdpYdesoKnqjj8HJqRn4T5titww

このクライアントの ID。

client_metadata · object

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

このクライアントを cross-origin authentication リクエストに使用できるか（true）、またはそのようなリクエストの実行が許可されていないか（false）。

cross_origin_loc · string<url>

Auth0 hosted login page ではなく独自ドメインで Auth を実行する際に、cross-origin auth フローで cross origin 検証を行うサイト上の URL。

custom_login_page · string · デフォルト: ""

カスタム login page の内容（HTML、CSS、JS）。

custom_login_page_on · boolean · デフォルト: true

カスタム login page を使用するか（true）、デフォルトの login page を使用するか（false）。

custom_login_page_preview · string · デフォルト: ""

カスタム login page の内容（HTML、CSS、JS）。（プレビューで使用）

default_organization · object | null

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

Show child attributes

description · string · デフォルト: ""

このクライアントの自由記述の説明（最大長: 140 文字）。

encryption_key · object | null

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

Show child attributes

express_configuration · object

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

Show child attributes

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 は、Dynamic Client Registration 経由で登録されたクライアントを示します。

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

fedcm_login · object · EA

新しい Universal Login の FedCM ログイン設定を構成

Show child attributes

form_template · string · デフォルト: ""

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

global · boolean · デフォルト: false

これが、レガシーな tenant 設定を表すグローバルな「All Applications」クライアント（true）か、通常のクライアント（false）かどうか。

grant_types · string[]

このアプリケーションでサポートされるグラントタイプのリスト。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 を含めることができます。

identity_assertion_authorization_grant · object · EA

クロスアプリアクセスにおける ID-JAG の使用に関する設定。

Show child attributes

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 の場合、token endpoint でのブルートフォース保護において、auth0-forwarded-for ヘッダーで指定された IP をエンドユーザーの IP として信頼します。

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

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

jwt_configuration · object

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

Show child attributes

logo_uri · string

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

mobile · object

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

Show child attributes

my_organization_configuration · object · EA

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

Show child attributes

name · string · デフォルト: My application

このクライアントの名前（最小長: 1 文字、< と > は使用不可）。

native_social_login · object

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

Show child attributes

oidc_conformant · boolean · デフォルト: false

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

oidc_logout · object

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

Show child attributes

organization_discovery_methods · enum<string>[] · EA

pre_login_prompt 中の organization 検出で利用可能な方法を定義します。ユーザーは email、organization_name、またはその両方で organization を検出できます。

Minimum array length: 1

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

利用可能なオプション: email, organization_name

organization_require_behavior · enum<string> · デフォルト: no_prompt

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

organization_usage · enum<string> · デフォルト: deny

organization に関して認証トランザクションをどのように進めるかを定義します。deny（デフォルト）、allow、または require を指定できます。

利用可能なオプション: 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_party が false で、third_party_security_mode が strict の場合にのみ適用されます。詳しくは、Redirect protection を参照してください。

利用可能なオプション: allow_always, open_redirect_protection

refresh_token · object | null

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

Show child attributes

require_proof_of_possession · boolean · デフォルト: false

このクライアントに対して Proof-of-Possession の使用を必須にします

require_pushed_authorization_requests · boolean · デフォルト: false

このクライアントに対してプッシュ型認可リクエストの使用を必須にします

resource_server_identifier · string

このクライアントがリンクされているリソースサーバーの identifier。

session_transfer · object | null

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

Show child attributes

signed_request_object · object

JWT で保護された認可リクエスト（JAR）の設定。

Show child attributes

signing_keys · object[] | null

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

Show child attributes

skip_non_verifiable_callback_uri_confirmation_prompt · boolean

リダイレクト URI が検証不能なコールバック URI（たとえば myapp:// のようなカスタム URI スキーマや localhost）を使用している場合に、ログインフロー中に confirmation prompt を表示するかどうかを制御します。 true に設定すると、confirmation prompt は表示されません。悪意のあるアプリからの保護を強化するため、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）、有効にするか（true）。デフォルトは true です。

tenant · string · デフォルト: ""

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

third_party_security_mode · enum<string> · GA

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

利用可能なオプション: strict, permissive

token_endpoint_auth_method · enum<string> · デフォルト: none

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

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

token_exchange · object · GA

トークン交換の設定。

Show child attributes

token_quota · object · EA

Show child attributes

token_vault_privileged_access · object · EA

Token Vault の特権アクセスに関する設定。

Show child attributes

web_origins · string[]

Cross-Origin Authentication、Device Flow、およびweb message response modeで使用する、許可されたオリジンのリスト。