Cloud

OAuth 2.0 Overview

You can build or authorize apps that use Open Cloud APIs to access Roblox resources. Open Cloud provides authentication for these apps using OAuth 2.0.

As an experience creator or group owner

You can securely use tools created by others to improve your creation productivity. The OAuth 2.0 authorization layer allows you to grant permissions to third-party apps to access your or your group's experiences without giving them your credentials and personal information. You select the access permissions of your specific Roblox resources, and Roblox handles the authorization process for you with the OAuth 2.0 framework.

As an app developer

You can create apps for yourself and others in the Roblox community. OAuth 2.0 defines the roles involved in the authorization process, the protocol of how roles interact with each other, and the authorization flows that you need to follow to develop secure and compatible apps.

Roles

The Open Cloud OAuth 2.0 protocol has the following roles. It's useful to understand the specific roles before learning about how they interact with one another in authorization flows.

  • Resource owner: An entity capable of granting access to a protected resource. For example, a creator who allows a third-party app to access their Roblox resources through Open Cloud Web APIs.

  • Resource server: A Roblox service that hosts protected resources and responds to requests from a resource owner.

  • Client: An app that accesses protected resources on behalf of the resource owner (with the owner's authorization).

  • Authorization server: The Roblox server that authenticates the identity of the resource owner and issues access tokens to the client.

Grant Types

Authorization flows, or grant types, are the steps of actions that roles perform during the authorization process. Roblox supports the OAuth 2.0 authorization code flow and its Proof Key for Code Exchange (PKCE) extension, with different implementation requirements for apps that are capable or incapable of storing client secrets.

Authorization Code Flow

Through the authorization code flow, a client exchanges an authorization code for an access token and a refresh token to complete the authorization process in the following steps:

  1. The client sends an authorization request to the Roblox authorization server.

  2. The authorization server verifies the identity of the resource owner.

  3. The authorization server receives permissions for accessing specific Roblox resources from the resource owner.

  4. The authorization server redirects the resource owner back to the client with an authorization code.

  5. The client requests an access token using the authorization code at the token endpoint.

  6. The client receives a response from the token endpoint containing an access token, an ID token, and a refresh token.

  7. The client retrieves the permitted resources after getting the access token.

The following figure describes the interactions between roles in the authorization code flow that you'll read in the following sections:

Authorization Code Flow with PKCE

The PKCE extension of the authorization code flow helps reduce risk of leaking the authorization code and prevent cross-site request forgery (CSRF), an attack that tricks users into submitting unintended web requests. This flow completes the authorization process with the following steps:

  1. The client generates a unique and cryptographically random key called a code verifier for every authorization request.

  2. The client runs a SHA-256 hash algorithm on the code verifier to generate a code challenge.

  3. If the client:

    • Is a public client, instead of using the client secret, it passes the client ID and the code challenge in the authorization request.

    • Is a confidential client, it adds the code challenge along with the client ID and secret in the request.

  4. The client sends an authorization request to the Roblox authorization server.

  5. The authorization server verifies the identity of the resource owner.

  6. The authorization server receives permissions for accessing specific Roblox resources from the resource owner.

  7. The authorization server redirects the resource owner back to the client with an authorization code.

  8. The client includes the authorization code and the original code verifier in the token request to the token endpoint.

  9. The authorization server verifies the authorization code and the associated code verifier.

  10. The client receives a response from the token endpoint containing an access token, an ID token, and a refresh token.

  11. The client retrieves the permitted resources after getting the access token.

OpenID Connect Support

Roblox uses OpenID Connect (OIDC) as an identity layer on top of the OAuth 2.0 protocol for authentication to protect sensitive account information. OIDC allows applications to verify the identity of users and obtain their basic public profile information, such as user ID, usernames, display names, and profile links.

Registration and Implementation

To implement a web or mobile app that uses authorization code flow, you need to:

  1. Register your app with Roblox. This lets you obtain a client ID and secret to register your app with Roblox and make calls to your endpoints.

  2. Implement the authorization code flow. For a complete reference of the OAuth 2.0 endpoints that you need to call, see the Authentication reference.

  3. Go through the review process to get more user quota.