Checks whether a user name is in use.
Request
GET /GmaApi/identities/checkUsername
Example cURL request
# curl -v -X GET -H "Authorization: Bearer
644d0ac0-908f-485a-ac8d-b5bb99f200d7"
https://hostname/GmaApi/identities/checkUsername?username=chuck
Resource
URI
https://hostname/GmaApi/identities/checkUsername
Request parameters
Table 1. Query parameters
| Parameter |
Type |
Required |
Description |
| username |
String |
Yes |
The user name to check. |
Example response
{"status":{"success":true,"apiError":false,"message":"Success","errors":{}},
"available":false,"account":false}
Response parameters
Table 2. Response
parameters
| Parameter |
Description |
| status |
Returns whether the request was successful. Returns an error when the request
is unsuccessful. For more information about errors, see Errors. |
| available |
Indicates whether the user name is available for use. |
| account |
Indicates whether the user record is an account or not, if the user name is
not available. |