API Model
User Model
User Model
| Field | Type | Mandatory | Meaning |
|---|---|---|---|
| id | integer | yes | The user's id |
| username | string | yes | the user's new user name to log in in the application |
| password | string | yes | the user's password to log in in the application |
| string | false | the user's email address. Non personal accounts have no email | |
| roles | Set of Role | yes | the roles assigned to the user |
| attributes | List of user attributes | false | The user attributes |
| accountAccess | enum AccountAccess | true | Specifies if the user account is accesible. It can happen that the account is accesible but the user still needs to set the password to be able to access the account |
| passwordChangeRequestDigest | string | false | Only used when the user receives an email to set the password. This field identifies the change password request |
| forcePasswordChange | boolean | false | Forces the user to change his password next time he access his account |
| nonPersonalAccount | boolean | true | Specifies if an account is personal or non personal |
| deleted | boolean | true | Specifies if the user account is deleted |
| passwordExpired | boolean | true | Specifies if the password has expired |
| passwordChangeDate | Date | false | Specifies the last date when the user set his password |
| passwordChangeRequestTimestamp | Date | false | Specifies the last date when the user received the change password petition |
| isActive | boolean | true | If true then the user can access his account, otherwise he cannot access |
Example
{
"id": 10,
"username": "fran",
"email": "fran@email.com",
"roles": [
{
"id": 2,
"role": "USER",
"description": "Allows access to Match Web Player for consultation of all configured KBAs"
}
],
"attributes": [
{
"attribute": {
"id": 2,
"name": "AT1",
"description": "AT2",
"unique": false,
"mandatory": false
},
"value": null
},
{
"attribute": {
"id": 3,
"name": "Test",
"description": "Test attribtue",
"unique": true,
"mandatory": false
},
"value": null
},
{
"attribute": {
"id": 4,
"name": "Test 2",
"description": "Test attribtue 2",
"unique": true,
"mandatory": false
},
"value": null
},
{
"attribute": {
"id": 6,
"name": "AT3",
"description": "AT3",
"unique": true,
"mandatory": true
},
"value": null
},
{
"attribute": {
"id": 7,
"name": "AT4",
"description": "AT4",
"unique": true,
"mandatory": true
},
"value": null
}
],
"accountAccess": "ENABLED",
"nonPersonalAccount": false,
"deleted": false,
"passwordExpired": false,
"passwordChangeDate": null,
"isActive": false
}