GET /v1/metadata#twostepverification.roblox.com — openapi

Gets two step verification system metadata.

The metadata endpoint takes in optional request parameters to output additional context for when the user is unauthenticated but attempting to login with two step verification.

When supplied, all three request parameters must be sent and match up.

Endpoint

Method: GET

Path: /v1/metadata#twostepverification.roblox.com

Servers:

https://twostepverification.roblox.com

Parameters

Name	Location	Required	Description
userId	query	false	The user ID.
challengeId	query	false	The active two step verification challenge ID if there is one.
actionType	query	false	The Roblox.TwoStepVerification.Client.TwoStepVerificationActionType associated with the challenge.

[
  {
    "in": "query",
    "name": "userId",
    "description": "The user ID.",
    "schema": {
      "type": "integer",
      "format": "int64"
    }
  },
  {
    "in": "query",
    "name": "challengeId",
    "description": "The active two step verification challenge ID if there is one.",
    "schema": {
      "type": "string"
    }
  },
  {
    "in": "query",
    "name": "actionType",
    "description": "The Roblox.TwoStepVerification.Client.TwoStepVerificationActionType associated with the challenge.",
    "schema": {
      "type": "integer",
      "format": "int32",
      "enum": [
        0,
        1,
        2,
        3,
        4,
        5,
        6,
        7,
        8
      ]
    }
  }
]

Responses

Status	Description
200	OK

{
  "200": {
    "description": "OK",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Roblox.TwoStepVerification.Api.MetadataResponse"
        }
      },
      "text/json": {
        "schema": {
          "$ref": "#/components/schemas/Roblox.TwoStepVerification.Api.MetadataResponse"
        }
      }
    }
  }
}

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": {}
        }
      }
    }
  }
}

Roblox.TwoStepVerification.Api.MetadataResponse

Complete Operation Definition

{
  "tags": [
    "Accounts",
    "Metadata"
  ],
  "summary": "Gets two step verification system metadata.",
  "description": "The metadata endpoint takes in optional request parameters to output additional context\r\nfor when the user is unauthenticated but attempting to login with two step verification.\r\n\r\nWhen supplied, all three request parameters must be sent and match up.",
  "parameters": [
    {
      "in": "query",
      "name": "userId",
      "description": "The user ID.",
      "schema": {
        "type": "integer",
        "format": "int64"
      }
    },
    {
      "in": "query",
      "name": "challengeId",
      "description": "The active two step verification challenge ID if there is one.",
      "schema": {
        "type": "string"
      }
    },
    {
      "in": "query",
      "name": "actionType",
      "description": "The Roblox.TwoStepVerification.Client.TwoStepVerificationActionType associated with the challenge.",
      "schema": {
        "type": "integer",
        "format": "int32",
        "enum": [
          0,
          1,
          2,
          3,
          4,
          5,
          6,
          7,
          8
        ]
      }
    }
  ],
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Roblox.TwoStepVerification.Api.MetadataResponse"
          }
        },
        "text/json": {
          "schema": {
            "$ref": "#/components/schemas/Roblox.TwoStepVerification.Api.MetadataResponse"
          }
        }
      }
    }
  },
  "servers": [
    {
      "url": "https://twostepverification.roblox.com"
    }
  ],
  "x-roblox-engine-usability": {
    "apiKeyWithHttpService": false
  },
  "security": [
    {},
    {
      "roblox-legacy-cookie": []
    }
  ],
  "externalDocs": {
    "url": "https://create.roblox.com/docs/cloud/reference/features/accounts#twostepverification_get_v1_metadata"
  }
}