3 min read

Source: Roblox Creator Hub · CC BY 4.0 · View source · Code samples: MIT Imported 2026-10-03. Formatting adapted for this site.

GET /v1/users/{userId}/configuration — openapi

Gets two step verification configuration for the specified user.

Endpoint

Method: GET

Path: /v1/users/{userId}/configuration

Servers:

• https://twostepverification.roblox.com

Parameters

[
  {
    "in": "path",
    "name": "userId",
    "description": "The Id of the user to get the configuration for.",
    "required": true,
    "schema": {
      "type": "integer",
      "format": "int64"
    }
  },
  {
    "in": "query",
    "name": "challengeId",
    "description": "The active challenge for the user (as an alternative when the user is unauthenticated).",
    "schema": {
      "type": "string"
    }
  },
  {
    "in": "query",
    "name": "actionType",
    "description": "The action type the challengeId is associated with.",
    "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.UserConfiguration"
        }
      },
      "text/json": {
        "schema": {
          "$ref": "#/components/schemas/Roblox.TwoStepVerification.Api.UserConfiguration"
        }
      }
    }
  },
  "400": {
    "description": "1: Invalid challenge ID."
  },
  "403": {
    "description": "2: The user ID is invalid."
  }
}

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

Related Schemas

• Roblox.TwoStepVerification.Api.UserConfiguration

Complete Operation Definition

{
  "tags": [
    "Accounts"
  ],
  "summary": "Gets two step verification configuration for the specified user.",
  "parameters": [
    {
      "in": "path",
      "name": "userId",
      "description": "The Id of the user to get the configuration for.",
      "required": true,
      "schema": {
        "type": "integer",
        "format": "int64"
      }
    },
    {
      "in": "query",
      "name": "challengeId",
      "description": "The active challenge for the user (as an alternative when the user is unauthenticated).",
      "schema": {
        "type": "string"
      }
    },
    {
      "in": "query",
      "name": "actionType",
      "description": "The action type the challengeId is associated with.",
      "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.UserConfiguration"
          }
        },
        "text/json": {
          "schema": {
            "$ref": "#/components/schemas/Roblox.TwoStepVerification.Api.UserConfiguration"
          }
        }
      }
    },
    "400": {
      "description": "1: Invalid challenge ID."
    },
    "403": {
      "description": "2: The user ID is invalid."
    }
  },
  "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_users__userId__configuration"
  }
}