Rechercher des clients

Permet de rechercher des clients à l’aide de la syntaxe de filtre SCIM ou Lucene, avec des résultats à faible latence et à cohérence éventuelle. Utilisez le paramètre parser pour spécifier la syntaxe « scim » ou « lucene » (par défaut : « lucene »). Ce point de terminaison offre une alternative au point de terminaison GET /clients standard avec de meilleures performances pour les requêtes complexes. Les résultats peuvent ne pas refléter immédiatement les mises à jour récentes.

• Ce point de terminaison prend uniquement en charge les scopes read:clients et read:client_summary. Les scopes read:client_keys et read:client_credentials ne sont pas pris en charge.
• Les champs suivants ne sont jamais renvoyés par ce point de terminaison :
  • client_secret
  • encryption_key
  • signing_keys
  • owners
  • addons

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

Rechercher des clients à l’aide de la syntaxe de filtre SCIM ou Lucene

cURL

curl --request GET \
  --url https://{tenantDomain}/api/v2/clients/search \
  --header 'Authorization: Bearer <token>'

200

{
  "clients": [
    {
      "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": {},
      "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": "",
      "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
      },
      "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>"
      ]
    }
  ],
  "next": "<string>"
}

Autorisations

bearerAuthoAuth2ClientCredentials

Authorization · string · header · requis

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

Paramètres de requête

q · string

Expression de filtre en syntaxe SCIM ou Lucene (selon le paramètre parser). Exemples SCIM : name eq "Auth0", name sw "auth" and app_type eq "spa". Opérateurs SCIM : eq, ne, sw, ew, co, pr, gt, ge, lt, le, and, or.

Champs pris en charge :

• client_id - ID client Auth0 (sensible à la casse, correspondance exacte)
• external_client_id - URL du Client ID Metadata Document (CIMD) ; sensible à la casse, correspondance exacte
• name - Nom du client (prend en charge les opérateurs contains, starts-with et ends-with ; triable)
• app_type - Type d’application (p. ex. « spa », « native », « non_interactive »)
• is_first_party - Indique si le client est de première partie (booléen)
• updated_at - Horodatage de la dernière mise à jour (prend en charge les opérateurs de plage de dates ; triable)
• metadata.{key} - Filtrer selon les paires clé-valeur des métadonnées du client (profondeur maximale des clés de 2 niveaux, valeurs indexées jusqu’à 64 caractères)
• client_grant.organization_id - Filtrer selon l’ID d’organisation associé
• client_grant.allow_any_organization - Filtrer selon le paramètre autorisant toute organisation

Maximum de 5 opérations de filtre par requête. Les résultats sont à cohérence éventuelle et peuvent ne pas refléter les mises à jour récentes.

Maximum string length: 1000

parser · enum<string>

Analyseur de requêtes à utiliser pour l’expression de filtre. Utilisez « scim » pour la syntaxe de filtre SCIM ou « lucene » pour la syntaxe de requête Lucene (par défaut).

Options disponibles: scim, lucene

fields · string

Liste de champs séparés par des virgules à inclure ou à exclure dans la réponse. Fonctionne avec le paramètre include_fields pour contrôler le mode de projection. Maximum de 50 champs.

Maximum string length: 1000

include_fields · boolean

Détermine le mode de projection des champs. Définissez cette valeur sur true pour inclure uniquement les champs indiqués dans le paramètre fields. Définissez-la sur false pour exclure les champs indiqués dans le paramètre fields. La valeur par défaut est true si elle n’est pas précisée.

take · integer

Nombre maximal de résultats à renvoyer par page (1-100). La valeur par défaut est 50.

Plage requise: 1 <= x <= 100

from · string

Curseur pour la page de résultats suivante. Utilisez la valeur du champ next de la réponse précédente.

Maximum string length: 1000

sort · enum<string>

Champ utilisé pour trier les résultats par ordre croissant. Par défaut, les résultats sont triés selon l’ordre d’insertion (le plus ancien en premier) si ce champ n’est pas fourni. Nom du champ selon lequel trier les résultats en ordre croissant. Utilise par défaut l’ordre d’insertion (du plus ancien au plus récent) s’il n’est pas fourni.

Options disponibles: name, updated_at

Réponse

200

application/json

Clients récupérés avec succès.

clients · object[] · requis

Tableau d’objets clients correspondant aux critères de recherche.

Show child attributes

next · string

Curseur permettant de récupérer la page de résultats suivante. Absent lorsqu’il n’y a plus de résultats.