| GET | /users | Get a list of users |
|---|
"use strict";
export class GetUserResponse {
/** @param {{userId?:string,emailAddress?:string,firstName?:string,lastName?:string,passwordExpirationDate?:string,passwordMustBeChanged?:boolean,userType?:string,culture?:string,accountLocked?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description Unique Identifier of a User */
userId;
/**
* @type {string}
* @description User's Email address */
emailAddress;
/**
* @type {string}
* @description First Name */
firstName;
/**
* @type {string}
* @description Last Name */
lastName;
/**
* @type {string}
* @description User's Password Expiration Date */
passwordExpirationDate;
/**
* @type {boolean}
* @description If the User must change the password */
passwordMustBeChanged;
/**
* @type {string}
* @description User Type of the User */
userType;
/**
* @type {string}
* @description Culture ID of the User */
culture;
/**
* @type {boolean}
* @description If the User account is locked */
accountLocked;
}
export class GetUsersResponse {
/** @param {{page?:number,items?:number,totalPages?:number,totalResults?:number,elements?:GetUserResponse[]}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {number}
* @description Index of the result set returnedr */
page;
/**
* @type {number}
* @description Size of the result set returned */
items;
/**
* @type {number}
* @description Total amount of pages / result sets */
totalPages;
/**
* @type {number}
* @description Total amount of results */
totalResults;
/**
* @type {GetUserResponse[]}
* @description List of Users */
elements;
}
export class GetUsers {
/** @param {{page?:number,items?:number,noCount?:boolean,sortBy?:string,email?:string,includeLockedAccounts?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {number}
* @description Index of the result set returned */
page;
/**
* @type {number}
* @description Size of the result set returned */
items;
/**
* @type {boolean}
* @description Omit precise record count - save on performance */
noCount;
/**
* @type {string}
* @description Sorting expression */
sortBy;
/**
* @type {string}
* @description Email address */
email;
/**
* @type {?boolean}
* @description Also retreive users with locked account */
includeLockedAccounts;
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /users HTTP/1.1 Host: dev-api-booster.richemont.com Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"page":0,"items":0,"totalPages":0,"totalResults":0}