User Name Available #

username

How to check whether a user name is available #

Check whether a user name is available. A user name acts as an alternate handle for logging into the AppKey Auth system. Its only requirement is that it must be unique for each user. This function will only work if user names have been enabled for the application.

The userName is the user name that is being tested for availability

This function will return available true if the user name is available, false if it is not available.

URL #

    /api/appuser/userNameAvailable

Method #

GET

Headers #

    access-token: "<Access Token>"

Data Parameter #

    {
        userName: "<user name>"
    }

Response: #

Success: #

StatusCode: #

200 (OK)

Contents: #

    {
        "available": "true | false" 
    }

Error: #

StatusCode: #

    400 (BAD REQUEST)
    500 (INTERNAL SERVER ERROR)

Content: #

    {
        code: "<internal error code>",
        message: "<readable error description>"
    }

The internal codes are integers:

401 - app no longer exists
402 - app is suspended
403 - missing parameter
404 - user account is suspended
405 - invalid access token
413 - app is migrated
500 - internal server error
602 - invalid data
606 - app does not support user names