Aller au contenu

Lister les utilisateurs du tenant (paginé)

GET
/v1/users
curl --request GET \
--url 'https://example.com/v1/users?pageSize=20&page=1&status=Active' \
--header 'X-API-Key: <X-API-Key>'
pageSize
integer
>= 1 <= 100
Example
20
page
integer
>= 1
Example
1
status
string
Allowed values: Active Disabled

Page d’utilisateurs

Media type application/json
object
data
required
Array<object>
object
id
required
string format: uuid
email
required
string
status
required
string
Allowed values: Active Disabled
rolesCount
required
integer
meta
required
object
page
required
integer
>= 1
pageSize
required
integer
>= 1
total
required
integer
Example
{
"data": [
{
"status": "Active"
}
],
"meta": {
"page": 1,
"pageSize": 20,
"total": 42
}
}

Paramètres invalides

Media type application/json
object
code
required

Code machine de l’erreur

string
message
required

Message lisible

string
origin

Origine domaine de l’erreur (optionnel)

object
boundedContext
string
module
string
status
required
integer
traceId
required

Identifiant de corrélation pour le support

string
Example
{
"code": "RESERVATION_NOT_FOUND",
"message": "Réservation introuvable",
"status": 404
}

Non authentifié

Media type application/json
object
code
required

Code machine de l’erreur

string
message
required

Message lisible

string
origin

Origine domaine de l’erreur (optionnel)

object
boundedContext
string
module
string
status
required
integer
traceId
required

Identifiant de corrélation pour le support

string
Example
{
"code": "RESERVATION_NOT_FOUND",
"message": "Réservation introuvable",
"status": 404
}

Permission refusée

Media type application/json
object
code
required

Code machine de l’erreur

string
message
required

Message lisible

string
origin

Origine domaine de l’erreur (optionnel)

object
boundedContext
string
module
string
status
required
integer
traceId
required

Identifiant de corrélation pour le support

string
Example
{
"code": "RESERVATION_NOT_FOUND",
"message": "Réservation introuvable",
"status": 404
}