POST /v1/users/{userId}/configuration/security-key/enable-verify — openapi

Finishes security key registration and stores credential. Enables security key as a 2sv media type if it is a user's first key.

Endpoint

Method: POST

Path: /v1/users/{userId}/configuration/security-key/enable-verify

Servers:

https://twostepverification.roblox.com

Parameters

Name	Location	Required	Description
userId	path	true	The user ID.

[
  {
    "in": "path",
    "name": "userId",
    "description": "The user ID.",
    "required": true,
    "schema": {
      "type": "integer",
      "format": "int64"
    }
  }
]

Request Body

The request body.Roblox.TwoStepVerification.Api.EnableVerifySecurityKeyRequest.

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/Roblox.TwoStepVerification.Api.EnableVerifySecurityKeyRequest"
      }
    },
    "text/json": {
      "schema": {
        "$ref": "#/components/schemas/Roblox.TwoStepVerification.Api.EnableVerifySecurityKeyRequest"
      }
    }
  },
  "description": "The request body.Roblox.TwoStepVerification.Api.EnableVerifySecurityKeyRequest.",
  "required": true
}

Responses

Status	Description
200	OK
400	2: The user ID is invalid. 17: Invalid security key nickname.
401	0: Authorization has been denied for this request.
403	0: Token Validation Failed 17: Invalid security key nickname.
503	7: Two step verification is currently under maintenance.

{
  "200": {
    "description": "OK",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Roblox.Web.WebAPI.ApiEmptyResponseModel"
        }
      },
      "text/json": {
        "schema": {
          "$ref": "#/components/schemas/Roblox.Web.WebAPI.ApiEmptyResponseModel"
        }
      }
    }
  },
  "400": {
    "description": "2: The user ID is invalid.\r\n17: Invalid security key nickname."
  },
  "401": {
    "description": "0: Authorization has been denied for this request."
  },
  "403": {
    "description": "0: Token Validation Failed\r\n17: Invalid security key nickname."
  },
  "503": {
    "description": "7: Two step verification is currently under maintenance."
  }
}

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": "Finishes security key registration and stores credential. Enables security key as a 2sv media type if it is a user's first key.",
  "parameters": [
    {
      "in": "path",
      "name": "userId",
      "description": "The user ID.",
      "required": true,
      "schema": {
        "type": "integer",
        "format": "int64"
      }
    }
  ],
  "requestBody": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Roblox.TwoStepVerification.Api.EnableVerifySecurityKeyRequest"
        }
      },
      "text/json": {
        "schema": {
          "$ref": "#/components/schemas/Roblox.TwoStepVerification.Api.EnableVerifySecurityKeyRequest"
        }
      }
    },
    "description": "The request body.Roblox.TwoStepVerification.Api.EnableVerifySecurityKeyRequest.",
    "required": true
  },
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Roblox.Web.WebAPI.ApiEmptyResponseModel"
          }
        },
        "text/json": {
          "schema": {
            "$ref": "#/components/schemas/Roblox.Web.WebAPI.ApiEmptyResponseModel"
          }
        }
      }
    },
    "400": {
      "description": "2: The user ID is invalid.\r\n17: Invalid security key nickname."
    },
    "401": {
      "description": "0: Authorization has been denied for this request."
    },
    "403": {
      "description": "0: Token Validation Failed\r\n17: Invalid security key nickname."
    },
    "503": {
      "description": "7: Two step verification is currently under maintenance."
    }
  },
  "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_post_v1_users__userId__configuration_security_key_enable_verify"
  }
}