Skip to main content
GET
/
v1
/
users
/
username-available
Error
A valid request URL is required to generate request examples
{
  "available": true,
  "reason": "<string>"
}
{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}
{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

Authorizations

​
aura_session
string
cookie
required

HttpOnly session cookie set by POST /v1/auth/session. Mutating requests must also send the CSRF token (returned by that call) in the x-csrf-token header.

Query Parameters

​
name
string
required
Required string length: 1 - 40

Response

Default Response

​
available
boolean
required
​
reason
string

Human-renderable reason when unavailable.