API ReferenceDocumentation APIToken PortailUsers

Exporter les utilisateurs

Afficher en Markdown
Exporte une 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:

Requête

This endpoint expects an object.
contentTypestringOptionnel
Le type de contenu de l'export.
beforeItemsstringOptionnel

Pour un export en fichier unique, le texte ajouté avant les éléments exportés.

afterItemsstringOptionnel

Pour un export en fichier unique, le texte ajouté après les éléments exportés.

betweenItemsstringOptionnel

Pour un export en fichier unique, le texte ajouté entre les éléments exportés.

itemTemplatestringOptionnel

Le modèle appliqué à chaque élément exporté. S’il est absent, chaque élément est sérialisé en JSON.

expiredlongOptionnel
La date d'expiration de l'export. Horodatage en millisecondes depuis l'epoch.

Réponse

La tâche Export créée.

createdlong

La date de création de l’entité.

exportOperationstring

Le nom de l’opération d’export.

idstring
L'identifiant de l'export.
searchQuerystring

La requête de recherche des éléments exportés.

sizelong
La taille de l'export.
tenantIdstring
L'identifiant du tenant auquel appartient l'export.
totalItemslong

Le nombre total d’éléments exportés.

updatedlong

La date de dernière modification de l’entité.

afterItemsstringOptionnel

Pour un export en fichier unique, le texte ajouté après les éléments exportés.

beforeItemsstringOptionnel

Pour un export en fichier unique, le texte ajouté avant les éléments exportés.

betweenItemsstringOptionnel

Pour un export en fichier unique, le texte ajouté entre les éléments exportés.

contentTypestringOptionnel
Le type de contenu de l'export.
expiredlongOptionnel
La date d'expiration de l'export. Horodatage en millisecondes depuis l'epoch.
itemTemplatestringOptionnel

Le modèle appliqué à chaque élément exporté. S’il est absent, chaque élément est sérialisé en JSON.

jobOperationstringOptionnel

L’opération de tâche en cours d’exécution.

userIdstringOptionnel

L’identifiant de l’utilisateur qui a créé l’export.

Erreurs

400
Bad Request Error
403
Forbidden Error