---
updatedAt: 2026-05-12T09:59:47.000Z
---

# Check username availability

This operation indicates whether or not a given username is available.
Each username must be unique within each organization.

# OpenAPI definition

```json
{
  "components": {
    "responses": {
      "BadRequestResponse": {
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ErrorMessage"
            }
          }
        },
        "description": "BadRequestResponse indicates a request with invalid parameters"
      },
      "ForbiddenResponse": {
        "description": "ForbiddenResponse signals a request for a resource that does not exist or is not authorized"
      },
      "GenericError": {
        "description": "GenericError generic error"
      },
      "UnauthorizedResponse": {
        "description": "UnauthorizedResponse signals an unauthorized API access"
      },
      "UsernameAvailableResponse": {
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/usernameAvailable"
            }
          }
        },
        "description": "UsernameAvailableResponse provides whether or not a username is available"
      }
    },
    "schemas": {
      "ErrorMessage": {
        "description": "ErrorMessage describes the error",
        "properties": {
          "code": {
            "format": "int64",
            "type": "integer"
          },
          "reason": {
            "type": "string"
          }
        },
        "type": "object"
      },
      "usernameAvailable": {
        "properties": {
          "available": {
            "type": "boolean"
          }
        },
        "type": "object"
      }
    }
  },
  "info": {
    "license": {
      "name": "(c) Copyright 2022 WhiteHat Security"
    },
    "title": "Access Control Management API",
    "version": "2.0.0"
  },
  "openapi": "3.0.1",
  "paths": {
    "/api/users/available/{userName}": {
      "get": {
        "description": "This operation indicates whether or not a given username is available.\nEach username must be unique within each organization.",
        "operationId": "usernameAvailableSwagger",
        "parameters": [
          {
            "description": "User Name",
            "in": "path",
            "name": "userName",
            "required": true,
            "schema": {
              "type": "string"
            },
            "x-go-name": "UserName"
          }
        ],
        "responses": {
          "200": {
            "$ref": "#/components/responses/UsernameAvailableResponse"
          },
          "400": {
            "$ref": "#/components/responses/BadRequestResponse"
          },
          "401": {
            "$ref": "#/components/responses/UnauthorizedResponse"
          },
          "403": {
            "$ref": "#/components/responses/ForbiddenResponse"
          },
          "500": {
            "$ref": "#/components/responses/GenericError"
          }
        },
        "summary": "Check username availability",
        "tags": [
          "Access Control Management API v2.0"
        ]
      }
    }
  },
  "servers": [
    {
      "url": "https://sentinel.whitehatsec.com/"
    }
  ],
  "tags": [
    {
      "name": "Access Control Management API v2.0"
    }
  ],
  "x-explorer-enabled": false,
  "x-readme": {
    "proxy-enabled": true
  }
}
```