Ruby API: Authorization
This tutorial demonstrates how to add authentication and authorization to a Ruby API. We recommend you to Log in to follow this quickstart with examples configured for your account.
I want to integrate with my app15 minutes
I want to explore a sample app2 minutes
Get a sample configured with your account settings or check it out on Github.
Configure Auth0 APIs
Create an API
In the APIs section of the Auth0 dashboard, click Create API. Provide a name and an identifier for your API, for example
https://quickstarts/api. You will use the identifier as an
audience later, when you are configuring the Access Token verification. For Signing Algorithm, select RS256.
By default, your API uses RS256 as the algorithm for signing tokens. Since RS256 uses a private/public keypair, it verifies the tokens against the public key for your Auth0 account. The public key is in the JSON Web Key Set (JWKS) format, and can be accessed here.
Scopes let you define which resources can be accessed by the user with a given Access Token. For example, you might choose to grant read access to the
messages resource if users have the manager access level, and a write access to that resource if they have the administrator access level.
You can add the required scopes in the Scopes tab of the Auth0 Dashboard's APIs section.
This example demonstrates:
Validate Access Tokens
This tutorial performs Access Token validation using the jwt Gem within a custom
JsonWebToken class. An
authenticate! method is used to mark endpoints which require authentication through an incoming Access Token.
Install the jwt Gem.
Create a class called
JsonWebToken which decodes and verifies the incoming Access Token from the
Authorization header of the request. The public key for your Auth0 tenant can be fetched to verify the token.
JsonWebToken.verify method above verifies that the Access Token included in the request is valid; however, it doesn't yet include any mechanism for checking that the token has the sufficient
scope to access the requested resources.
To look for a particular
scope in an Access Token, provide an array of required scopes and check if they are present in the payload of the token.
In this example the
SCOPES array for the given key
/api/private-scoped is intersected with the
scopes contained in the payload of the Access Token to determine if it contains one or more items from the array.
authenticate! method to run before each endpoint which looks for the
access_token in the
Authorization header of an incoming request. If the token is present, it should be passed to
Protect API Endpoints
The routes shown below are available for the following requests:
GET /api/public: available for non-authenticated requests
GET /api/private: available for authenticated requests containing an Access Token with no additional scopes
GET /api/private-scoped: available for authenticated requests containing an Access Token with the
/public endpoint does not require to use the
The protected endpoints need to include the
authenticate! method. The scopes required for each one are defined in the code of the