POST /v2/passwords/reset — openapi

Resets a password for a user that belongs to the password reset ticket.

This will log the user out of all sessions and re-authenticate.

Endpoint

Method: POST

Path: /v2/passwords/reset

Servers:

https://auth.roblox.com

Request Body

The request model including the target type, ticket, user id, and new password, Roblox.Authentication.Api.Models.PasswordResetModel

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/Roblox.Authentication.Api.Models.PasswordResetModel"
      }
    },
    "text/json": {
      "schema": {
        "$ref": "#/components/schemas/Roblox.Authentication.Api.Models.PasswordResetModel"
      }
    }
  },
  "description": "The request model including the target type, ticket, user id, and new password, Roblox.Authentication.Api.Models.PasswordResetModel",
  "required": true
}

Responses

Status	Description
200	OK
400	3: Request was empty. 11: The password reset ticket is invalid. 12: The user is invalid. 20: The password is invalid. 21: Passwords do not match.
403	0: Token Validation Failed 16: The ticket is expired. 17: The nonce is expired. 44: Login is unavailable in your country.
500	0: Unknown error occured.
503	1: Feature temporarily disabled. Please try again later.

{
  "200": {
    "description": "OK",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Roblox.Authentication.Api.Models.LoginResponse"
        }
      },
      "text/json": {
        "schema": {
          "$ref": "#/components/schemas/Roblox.Authentication.Api.Models.LoginResponse"
        }
      }
    }
  },
  "400": {
    "description": "3: Request was empty.\r\n11: The password reset ticket is invalid.\r\n12: The user is invalid.\r\n20: The password is invalid.\r\n21: Passwords do not match."
  },
  "403": {
    "description": "0: Token Validation Failed\r\n16: The ticket is expired.\r\n17: The nonce is expired.\r\n44: Login is unavailable in your country."
  },
  "500": {
    "description": "0: Unknown error occured."
  },
  "503": {
    "description": "1: Feature temporarily disabled. Please try again later."
  }
}

Authentication

{
  "security": [
    {},
    {
      "roblox-legacy-cookie": []
    }
  ],
  "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": "Resets a password for a user that belongs to the password reset ticket.",
  "description": "This will log the user out of all sessions and re-authenticate.",
  "requestBody": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Roblox.Authentication.Api.Models.PasswordResetModel"
        }
      },
      "text/json": {
        "schema": {
          "$ref": "#/components/schemas/Roblox.Authentication.Api.Models.PasswordResetModel"
        }
      }
    },
    "description": "The request model including the target type, ticket, user id, and new password, Roblox.Authentication.Api.Models.PasswordResetModel",
    "required": true
  },
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Roblox.Authentication.Api.Models.LoginResponse"
          }
        },
        "text/json": {
          "schema": {
            "$ref": "#/components/schemas/Roblox.Authentication.Api.Models.LoginResponse"
          }
        }
      }
    },
    "400": {
      "description": "3: Request was empty.\r\n11: The password reset ticket is invalid.\r\n12: The user is invalid.\r\n20: The password is invalid.\r\n21: Passwords do not match."
    },
    "403": {
      "description": "0: Token Validation Failed\r\n16: The ticket is expired.\r\n17: The nonce is expired.\r\n44: Login is unavailable in your country."
    },
    "500": {
      "description": "0: Unknown error occured."
    },
    "503": {
      "description": "1: Feature temporarily disabled. Please try again later."
    }
  },
  "servers": [
    {
      "url": "https://auth.roblox.com"
    }
  ],
  "x-roblox-engine-usability": {
    "apiKeyWithHttpService": false
  },
  "security": [
    {},
    {
      "roblox-legacy-cookie": []
    }
  ],
  "externalDocs": {
    "url": "https://create.roblox.com/docs/cloud/reference/features/accounts#auth_post_v2_passwords_reset"
  }
}