User
Endpoints
Create new user
/users |
Get user list
/users |
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
page |
Page index |
integer (int32) |
Query |
size |
Entity count per page |
integer (int32) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Successfull |
< User > array |
400 |
Functionnal error |
No Content |
500 |
Internal server error |
No Content |
Import user list
/users/import |
Get one user
/users/{login} |
Parameters
Type | Name | Description | Schema | Business Rules |
---|---|---|---|---|
Path |
login |
User login |
string |
email address |
Data structure
User
User data structure.
Name | Description | Value | Business Rules |
---|---|---|---|
login |
login |
string |
email address |
lastName |
Last Name |
string |
|
firstName |
First Name |
string |
|
companyCode |
Company code |
string |
2 characters max |
establishmentCode |
Establishment code |
string |
2 characters max |
licenseType |
License type |
string |
IN(RW, OP) |
languageCode |
Language code |
string |
2 characters max (ISO-639) |
localeRegion |
Locale region |
string |
2 characters max (ISO-639) |
authorizations |
Authorization List |
List of Authorization |
If this attribute is null, keep the existing authorizations for the user. |
Authorization
Authorization data structure.
Name | Description | Value | Business Rules |
---|---|---|---|
roleCode |
Role Code |
string |
Existing role code in AdminHub |
companyCode |
Company code |
string |
2 characters max |
establishmentCode |
Establishment code |
string |
2 characters max |
ImportUserList
Name | Value |
---|---|
callback |
string |
data |
User list |