API ReferenceDocumentation APIToken PortailGroups

Rechercher des groupes

Afficher en MarkdownOuvrir dans Claude
Recherche dans tous les groupes. <Note title="Rôle requis"> Aucun. Autorisés : tout utilisateur du tenant. </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.isDefaultstringOptionnel
La ou les valeurs de filtre du champ isDefault.
items.namestringOptionnel
La ou les valeurs de filtre du champ name.
items.isDisabledstringOptionnel
La ou les valeurs de filtre du champ isDisabled.
items.userRolesstringOptionnel
La ou les valeurs de filtre du champ userRoles.
items.viewUserAuthorizedGroupsstringOptionnel
La ou les valeurs de filtre du champ viewUserAuthorizedGroups.
items.createUserAuthorizedGroupsstringOptionnel
La ou les valeurs de filtre du champ createUserAuthorizedGroups.
items.updateUserAuthorizedGroupsstringOptionnel
La ou les valeurs de filtre du champ updateUserAuthorizedGroups.
items.deleteUserAuthorizedGroupsstringOptionnel
La ou les valeurs de filtre du champ deleteUserAuthorizedGroups.
items.viewWorkflowAuthorizedGroupsstringOptionnel
La ou les valeurs de filtre du champ viewWorkflowAuthorizedGroups.
items.createWorkflowAuthorizedGroupsstringOptionnel
La ou les valeurs de filtre du champ createWorkflowAuthorizedGroups.
items.updateWorkflowAuthorizedGroupsstringOptionnel
La ou les valeurs de filtre du champ updateWorkflowAuthorizedGroups.
items.deleteWorkflowAuthorizedGroupsstringOptionnel
La ou les valeurs de filtre du champ deleteWorkflowAuthorizedGroups.
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.groupedInvitations.modestringOptionnel
La ou les valeurs de filtre du champ groupedInvitations.mode.
items.groupedInvitations.activeDaysstringOptionnel
La ou les valeurs de filtre du champ groupedInvitations.activeDays.
items.groupedInvitations.sendingSlotsstringOptionnel
La ou les valeurs de filtre du champ groupedInvitations.sendingSlots.
items.groupedInvitations.nextCheckstringOptionnel
La ou les valeurs de filtre du champ groupedInvitations.nextCheck.
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 Group.

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