Skip to main content
GET
Rechercher des organisations

Autorisations

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; Lucene par défaut). Exemples Lucene : name:acme*, display_name:*auth*. Exemples SCIM : name eq "Auth0", display_name sw "auth" and created_at gt "2024-01-01". Opérateurs SCIM : eq, ne, sw, ew, co, pr, gt, ge, lt, le, and, or.

Champs pris en charge:

  • id - ID de l’organisation (sensible à la casse, correspondance exacte)
  • name - Nom de l’organisation (prend en charge les opérateurs contains, starts-with et ends-with; triable)
  • display_name - Nom d’affichage de l’organisation (prend en charge les opérateurs contains, starts-with et ends-with; triable)
  • created_at - Horodatage de création (prend en charge les opérateurs de plage de dates; triable)
  • metadata.{key} - Filtrer selon les paires clé-valeur des métadonnées de l’organisation
Maximum de 5 opérations de filtrage par requête. Les résultats sont cohérents à terme et peuvent ne pas refléter les mises à jour récentes.

Maximum string length: 1000
parser
enum<string>

Analyseur de requête à 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). 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
take
integer

Nombre maximal de résultats à retourner 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>

Nom du champ selon lequel trier les résultats, uniquement en ordre croissant. Si ce champ n’est pas fourni, l’ordre d’insertion est utilisé par défaut (du plus ancien au plus récent). Nom du champ selon lequel trier les résultats, en ordre croissant seulement. Par défaut, l'ordre d'insertion est utilisé (le plus ancien en premier) s'il n'est pas fourni.

Options disponibles:
name,
display_name,
created_at

Réponse

Organizations récupérées avec succès.

organizations
object[]
requis

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

next
string

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