User Resource
The User resource includes properties that describe the current state of the specified User. You can see the User resource with a GET request to /api/v2/me.
Sample Data
{
"user":{
"id":"1e6def1758784546a610039f94bf254d",
"userName":"john123@genesys.com",
"password":"",
"firstName":"John",
"lastName":"Smith",
"emailAddress":"",
"roles":[
"ROLE_ADMIN"
],
"enabled":true,
"changePasswordOnFirstLogin":false,
"contactCenterId": "0851b5d7-1280-432c-9bb7-d22c2aeab2d5",
"uri":"http://198.51.100.23:8090/api/v2/users/1e6def1758784546a610039f94bf254d",
"path":"/users/1e6def1758784546a610039f94bf254d"
}
}
Resource Details
Field | Description |
---|---|
id | The unique identifier for the user. |
userName | The user's email address. |
password | The user's password (if allowed). |
firstName | The user's first name. |
lastName | The user's last name. |
emailAddress | The user's email address. |
roles | The user's role. There are currently four available user roles:
|
enabled | Specifies whether the user is enabled in the system. |
changePasswordOnFirstLogin | Specifies whether the user must change his or her password on the next login. The default value is false. |
contactCenterId | The ID for the user's contact center. |
uri | The user's resource identifier. |
path | The path to the user resource. |
This page was last edited on October 31, 2023, at 13:32.
Comments or questions about this documentation? Contact us for support!