...
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
{ "statusFact" : { "success" : true }} |
Check User's Attribute Availability
Current Implementation
This operation can be used to check whether a specific value for a specific attribute of a User is already taken by any other user.
Info |
---|
This operation can be used with a temporal token. |
The supported attributes are:
- tagId
- username
- pin
Parameters
Base URL: /userAttributeAvailable/{attribute}
Parameters:
Name | Type | Mandatory | Description |
---|---|---|---|
{attribute} | ENUM | Yes | Possible values: ['tagId', 'email', 'username', 'pin']. The User's attribute we want to check. |
token | String | Yes | Security Token obtained before. |
userId | String | Only if 'token' is not a temporal token | The id of the logged in user. |
temporalSession | Boolean | No | DEFAULT: 'false'. Indicates whether the provided token is temporal or not. |
value | String | Yes | The value that we want to check. |
API Sample
Available attribute (email)
Code Block | ||||
---|---|---|---|---|
| ||||
{
"data":{
"available":true
},
"statusFact":{
"success":true
}
} |
Non Available Attribute (username)
Code Block | ||||
---|---|---|---|---|
| ||||
{
"data":{
"available":false,
"takenBy":"podb"
},
"statusFact":{
"success":true
}
} |