SCIM または Lucene のフィルター構文を使用してクライアントを検索する

SCIM または Lucene のフィルター構文を使用して、低レイテンシでクライアントを検索します。結果は結果整合性に基づいて返されます。 parser パラメータを使用して、“scim” または “lucene” 構文を指定します（デフォルト: “lucene”）。 このエンドポイントは、複雑なクエリに対してより優れたパフォーマンスを提供する、標準の GET /clients エンドポイントの代替手段です。 結果には最近の更新がすぐに反映されない場合があります。

• このエンドポイントでサポートされるのは、read:clients および read:client_summary スコープのみです。read:client_keys および read:client_credentials スコープはサポートされていません。
• 次のフィールドは、このエンドポイントからは返されません。
  • client_secret
  • encryption_key
  • signing_keys
  • owners
  • addons

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

TypeScript

TypeScript

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.clients.search({
        q: "q",
        parser: "scim",
        fields: "fields",
        include_fields: true,
        take: 1,
        from: "from",
        sort: "name",
    });
}
main();

200

{
  "clients": [
    {
      "client_id": "AaiyAPdpYdesoKnqjj8HJqRn4T5titww",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "tenant": "",
      "name": "My application",
      "description": "",
      "global": false,
      "app_type": "native",
      "logo_uri": "<string>",
      "is_first_party": false,
      "oidc_conformant": false,
      "callbacks": [
        "<string>"
      ],
      "allowed_origins": [
        "<string>"
      ],
      "web_origins": [
        "<string>"
      ],
      "client_aliases": [
        "<string>"
      ],
      "allowed_clients": [
        "<string>"
      ],
      "allowed_logout_urls": [
        "<string>"
      ],
      "session_transfer": {
        "can_create_session_transfer_token": false,
        "enforce_cascade_revocation": true,
        "allowed_authentication_methods": [
          "cookie"
        ],
        "enforce_device_binding": "ip",
        "allow_refresh_token": false,
        "enforce_online_refresh_tokens": true,
        "delegation": {
          "allow_delegated_access": false,
          "enforce_device_binding": "ip"
        }
      },
      "oidc_logout": {
        "backchannel_logout_urls": [
          "<string>"
        ],
        "backchannel_logout_initiators": {
          "mode": "custom",
          "selected_initiators": [
            "rp-logout"
          ]
        },
        "backchannel_logout_session_metadata": {
          "include": true
        }
      },
      "grant_types": [
        "<string>"
      ],
      "jwt_configuration": {
        "lifetime_in_seconds": 36000,
        "secret_encoded": true,
        "scopes": {},
        "alg": "HS256"
      },
      "sso": false,
      "sso_disabled": false,
      "cross_origin_authentication": true,
      "cross_origin_loc": "<string>",
      "custom_login_page_on": true,
      "custom_login_page": "",
      "custom_login_page_preview": "",
      "form_template": "",
      "token_endpoint_auth_method": "none",
      "is_token_endpoint_ip_header_trusted": false,
      "client_metadata": {},
      "mobile": {
        "android": {
          "app_package_name": "",
          "sha256_cert_fingerprints": [
            "<string>"
          ]
        },
        "ios": {
          "team_id": "",
          "app_bundle_identifier": ""
        }
      },
      "initiate_login_uri": "<string>",
      "native_social_login": {
        "apple": {
          "enabled": false
        },
        "facebook": {
          "enabled": false
        },
        "google": {
          "enabled": false
        }
      },
      "fedcm_login": {
        "google": {
          "is_enabled": false
        }
      },
      "refresh_token": {
        "rotation_type": "non-rotating",
        "expiration_type": "non-expiring",
        "leeway": 0,
        "token_lifetime": 78894000,
        "infinite_token_lifetime": true,
        "idle_token_lifetime": 2,
        "infinite_idle_token_lifetime": false,
        "policies": [
          {
            "audience": "<string>",
            "scope": [
              "<string>"
            ]
          }
        ]
      },
      "default_organization": {
        "organization_id": "<string>",
        "flows": [
          "client_credentials"
        ]
      },
      "organization_usage": "deny",
      "organization_require_behavior": "no_prompt",
      "organization_discovery_methods": [
        "email"
      ],
      "client_authentication_methods": {
        "private_key_jwt": {
          "credentials": [
            {
              "id": "<string>"
            }
          ]
        },
        "tls_client_auth": {
          "credentials": [
            {
              "id": "<string>"
            }
          ]
        },
        "self_signed_tls_client_auth": {
          "credentials": [
            {
              "id": "<string>"
            }
          ]
        }
      },
      "require_pushed_authorization_requests": false,
      "require_proof_of_possession": false,
      "signed_request_object": {
        "required": false,
        "credentials": [
          {
            "id": "<string>"
          }
        ]
      },
      "token_vault_privileged_access": {
        "credentials": [
          {
            "id": "<string>"
          }
        ],
        "ip_allowlist": [
          "127.0.0.1"
        ],
        "grants": [
          {
            "connection": "<string>",
            "scopes": [
              "<string>"
            ]
          }
        ]
      },
      "compliance_level": "none",
      "skip_non_verifiable_callback_uri_confirmation_prompt": true,
      "token_exchange": {
        "allow_any_profile_of_type": [
          "custom_authentication"
        ]
      },
      "par_request_expiry": 305,
      "token_quota": {
        "client_credentials": {
          "enforce": true,
          "per_day": 1073741824,
          "per_hour": 1073741824
        }
      },
      "express_configuration": {
        "initiate_login_uri_template": "<string>",
        "user_attribute_profile_id": "<string>",
        "connection_profile_id": "<string>",
        "enable_client": true,
        "enable_organization": true,
        "okta_oin_client_id": "<string>",
        "admin_login_domain": "<string>",
        "linked_clients": [
          {
            "client_id": "<string>"
          }
        ],
        "oin_submission_id": "<string>"
      },
      "b2b_integration_configuration": {
        "sso_profiles": [
          "<string>"
        ],
        "integration_type": "custom_auth_server"
      },
      "my_organization_configuration": {
        "allowed_strategies": [
          "pingfederate"
        ],
        "connection_deletion_behavior": "allow",
        "connection_profile_id": "<string>",
        "user_attribute_profile_id": "<string>",
        "third_party_client_access": {
          "default_value": "block",
          "allowed_values": [
            "allow"
          ]
        },
        "invitation_landing_client_id": "<string>",
        "enforce_permission_ceiling": false,
        "enforce_self_assignment_restriction": false
      },
      "identity_assertion_authorization_grant": {
        "active": false
      },
      "anonymous_sessions": {
        "active": false
      },
      "enforce_anon_session_transfer_network_binding": "ip",
      "third_party_security_mode": "strict",
      "oidc_support": {
        "is_allowed": true,
        "allow_all_scopes": true,
        "allowed_scopes": [
          "profile"
        ]
      },
      "redirection_policy": "allow_always",
      "resource_server_identifier": "<string>",
      "async_approval_notification_channels": [
        "guardian-push"
      ],
      "external_metadata_type": "cimd",
      "external_metadata_created_by": "admin",
      "external_metadata_status": "available",
      "external_client_id": "<string>",
      "jwks_uri": "<string>"
    }
  ],
  "next": "<string>"
}

承認

bearerAuthoAuth2ClientCredentials

Authorization · string · header · 必須

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

クエリパラメータ

q · string

SCIM または Lucene 構文によるフィルター式（parser パラメータに応じて異なります）。SCIM の例: name eq "Auth0"、name sw "auth" and app_type eq "spa"。SCIM 演算子: eq、ne、sw、ew、co、pr、gt、ge、lt、le、and、or。

サポート対象フィールド:

• client_id - Auth0 クライアント ID（大文字と小文字を区別、完全一致）
• external_client_id - Client ID Metadata Document（CIMD）の URL（大文字と小文字を区別、完全一致）
• name - クライアント名（含む、前方一致、後方一致の演算子をサポート。ソート可能）
• app_type - アプリケーションの種類（例: "spa"、"native"、"non_interactive"）
• is_first_party - クライアントがファーストパーティかどうか（ブール値）
• updated_at - 最終更新タイムスタンプ（日付範囲演算子をサポート。ソート可能）
• metadata.{key} - クライアントメタデータのキーと値のペアでフィルター（キーの階層は最大 2 レベル、値は最大 64 文字までインデックス化）
• client_grant.organization_id - 関連付けられた組織IDでフィルター
• client_grant.allow_any_organization - 任意の organization を許可する設定でフィルター

クエリあたりのフィルター操作は最大 5 件です。結果は結果整合性に基づくため、最近の更新が反映されない場合があります。

Maximum string length: 1000

parser · enum<string>

フィルター式に使用するクエリパーサー。SCIM フィルター構文には "scim"、Lucene クエリ構文には "lucene"（デフォルト）を使用します。 フィルター式に使用するクエリパーサー。SCIMフィルター構文には"scim"、Luceneクエリ構文には"lucene"（デフォルト）を使用します。

利用可能なオプション: scim, lucene

fields · string

レスポンスに含める、または除外するフィールドのカンマ区切りリスト。include_fields パラメータと併用して射影モードを制御します。最大 50 フィールド。

Maximum string length: 1000

include_fields · boolean

フィールドの射影モードを制御します。true に設定すると、fields パラメータで指定したフィールドのみを含めます。false に設定すると、fields パラメータで指定したフィールドを除外します。指定しない場合のデフォルトは true です。

take · integer

ページごとに返す結果の最大数（1～100）。デフォルトは 50 です。

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

from · string

結果の次ページのカーソル。前のレスポンスの next フィールドの値を使用します。

Maximum string length: 1000

sort · enum<string>

結果を昇順で並べ替えるフィールド名。指定しない場合は挿入順（古いものから）になります。 結果を昇順で並べ替えるフィールド名。指定しない場合は、挿入順（古いものから）が既定になります。

利用可能なオプション: name, updated_at

レスポンス

200

application/json

クライアントを正常に取得しました。

clients · object[] · 必須

検索条件に一致するクライアントオブジェクトの配列。

Show child attributes

next · string

結果の次ページを取得するためのカーソル。これ以上結果がない場合は含まれません。