POST /v1/validators/recommendedUsernameFromDisplayName — openapi

Validates the given display name, and if valid, will convert it to a valid username and return suggested username(s) if available.

This is a POST request and explicitly does not receive the parameter values from the query

Endpoint

Method: POST

Path: /v1/validators/recommendedUsernameFromDisplayName

Servers:

https://auth.roblox.com

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/Roblox.Authentication.Api.Models.RecommendedUsernameFromDisplayNameRequest"
      }
    },
    "text/json": {
      "schema": {
        "$ref": "#/components/schemas/Roblox.Authentication.Api.Models.RecommendedUsernameFromDisplayNameRequest"
      }
    }
  },
  "required": true
}

Responses

Status	Description
200	OK
403	0: Token Validation Failed

{
  "200": {
    "description": "OK",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Roblox.Authentication.Api.Models.RecommendedUsernameResponse"
        }
      },
      "text/json": {
        "schema": {
          "$ref": "#/components/schemas/Roblox.Authentication.Api.Models.RecommendedUsernameResponse"
        }
      }
    }
  },
  "403": {
    "description": "0: Token Validation Failed"
  }
}

Authentication

{
  "security": [
    {}
  ],
  "securitySchemes": {
    "roblox-api-key": {
      "type": "apiKey",
      "description": "A configurable key that allows granular access to Roblox resources. See https://create.roblox.com/docs/cloud/auth/api-keys for more information.",
      "name": "x-api-key",
      "in": "header"
    },
    "roblox-legacy-cookie": {
      "type": "apiKey",
      "description": "A browser cookie that represents the identity of a Roblox user. DO NOT SHARE THIS. Sharing this will allow someone to log in as you and to steal your Robux and items. We do not recommend using cookies to call endpoints. When possible, use API keys with the x-api-key header or OAuth 2.0 instead for authentication.",
      "in": "cookie",
      "name": ".ROBLOSECURITY"
    },
    "roblox-oauth2": {
      "type": "oauth2",
      "description": "Build or authorize apps to access Roblox resources. See https://create.roblox.com/docs/cloud/auth/oauth2-overview for more information.",
      "flows": {
        "authorizationCode": {
          "authorizationUrl": "https://apis.roblox.com/oauth/v1/authorize",
          "tokenUrl": "https://apis.roblox.com/oauth/v1/token",
          "refreshUrl": "https://apis.roblox.com/oauth/v1/token",
          "scopes": {}
        }
      }
    }
  }
}

Complete Operation Definition

{
  "tags": [
    "Accounts"
  ],
  "summary": "Validates the given display name, and if valid, will convert it to a valid username and return suggested username(s) if available.\n            \nThis is a POST request and explicitly does not receive the parameter values from the query",
  "requestBody": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Roblox.Authentication.Api.Models.RecommendedUsernameFromDisplayNameRequest"
        }
      },
      "text/json": {
        "schema": {
          "$ref": "#/components/schemas/Roblox.Authentication.Api.Models.RecommendedUsernameFromDisplayNameRequest"
        }
      }
    },
    "required": true
  },
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Roblox.Authentication.Api.Models.RecommendedUsernameResponse"
          }
        },
        "text/json": {
          "schema": {
            "$ref": "#/components/schemas/Roblox.Authentication.Api.Models.RecommendedUsernameResponse"
          }
        }
      }
    },
    "403": {
      "description": "0: Token Validation Failed"
    }
  },
  "servers": [
    {
      "url": "https://auth.roblox.com"
    }
  ],
  "x-roblox-engine-usability": {
    "apiKeyWithHttpService": false
  },
  "security": [
    {}
  ],
  "externalDocs": {
    "url": "https://create.roblox.com/docs/cloud/reference/features/accounts#auth_post_v1_validators_recommendedUsernameFromDisplayName"
  }
}