API ReferenceDocumentation APIToken PortailUsers

Rechercher des utilisateurs

Afficher en MarkdownOuvrir dans Claude
Recherche dans tous les utilisateurs. <Note title="Rôle requis"> `userViewer` OU `userManager` Également autorisés sans rôle : les membres d'un groupe autorisé, le propriétaire. </Note>

Authentification

AuthorizationBearer

Authentification Bearer par jeton utilisateur ou jeton d’accès : Authorization: Bearer <token>.

Paramètres de requête

textstringOptionnel

Le texte à rechercher.

items.idstringOptionnel
La ou les valeurs de filtre du champ id.
items.tenantIdstringOptionnel
La ou les valeurs de filtre du champ tenantId.
items.groupIdstringOptionnel
La ou les valeurs de filtre du champ groupId.
items.viewAuthorizedGroupsstringOptionnel
La ou les valeurs de filtre du champ viewAuthorizedGroups.
items.lastLoginstringOptionnel
La ou les valeurs de filtre du champ lastLogin.
items.subjectstringOptionnel
La ou les valeurs de filtre du champ subject.
items.namestringOptionnel
La ou les valeurs de filtre du champ name.
items.emailstringOptionnel
La ou les valeurs de filtre du champ email.
items.firstNamestringOptionnel
La ou les valeurs de filtre du champ firstName.
items.lastNamestringOptionnel
La ou les valeurs de filtre du champ lastName.
items.countrystringOptionnel
La ou les valeurs de filtre du champ country.
items.signAllowedstringOptionnel
La ou les valeurs de filtre du champ signAllowed.
items.approveAllowedstringOptionnel
La ou les valeurs de filtre du champ approveAllowed.
items.organizationTitles.organizationIdstringOptionnel
La ou les valeurs de filtre du champ organizationTitles.organizationId.
items.isDisabledstringOptionnel
La ou les valeurs de filtre du champ isDisabled.
items.comanageAllowedstringOptionnel
La ou les valeurs de filtre du champ comanageAllowed.
items.jobOperationstringOptionnel
La ou les valeurs de filtre du champ jobOperation.
items.jobErrorCodestringOptionnel
La ou les valeurs de filtre du champ jobErrorCode.
items.createdstringOptionnel
La ou les valeurs de filtre du champ created.
items.updatedstringOptionnel
La ou les valeurs de filtre du champ updated.
items.userGroupedInvitationsModestringOptionnel
La ou les valeurs de filtre du champ userGroupedInvitationsMode.
sortBystringOptionnel

Le champ utilisé pour trier le résultat de la recherche.

sortOrderenumOptionnel

L’ordre de tri du résultat de la recherche.

Valeurs autorisées:
itemsPerPageintegerOptionnel1-50Par défaut 50

Le nombre d’éléments par page à renvoyer.

pageIndexintegerOptionnel>=0Par défaut 0

L’index de la page à renvoyer.

Réponse

Une page d’entités User.

pageIndexintegerOptionnel
L'index de la page.
itemsPerPageintegerOptionnel

Le nombre d’éléments par page.

totalItemsintegerOptionnel

Le nombre total d’éléments, toutes pages comprises.

itemslist of objectsOptionnel

Erreurs

400
Bad Request Error
403
Forbidden Error