Skip to main content

Authorization

Follow this guide to create a new Oura Ring credential that will allow Nexla to authenticate to and exchange data with your Oura Ring account.
ouraring_api_auth.png

Oura Ring

Prerequisites​

Before creating an Oura Ring credential, you need to obtain your OAuth2 Client ID and Client Secret from your Oura Ring account. Oura Ring uses OAuth2 3-legged authentication, which allows Nexla to access your Oura Ring account on your behalf.

To prepare for OAuth2 authentication, ensure you have the following:

  1. Oura Ring Account: You must have an active Oura Ring account with a registered Oura Ring device.

  2. OAuth2 Client Application: You must have an OAuth2 client application registered in your Oura Ring account. If you don't have one, you'll need to create it in your Oura Ring account settings or developer portal.

  3. Client ID and Client Secret: You need to obtain the Client ID and Client Secret from your OAuth2 client application settings in your Oura Ring account.

  4. Account Access: You must have administrative access or appropriate permissions to register OAuth2 applications and authorize access to your Oura Ring account.

  5. OAuth Authorization: During the credential creation process, you will be redirected to Oura Ring's authorization page to grant Nexla permission to access your Oura Ring account. You will need to sign in with your Oura Ring account and approve the authorization request.

The OAuth2 flow uses your OAuth2 client application to authenticate with Oura Ring. When you authorize Nexla, you grant permission for Nexla to access your Oura Ring account data based on the requested scope. The authorization includes access to read health and wellness data from your Oura Ring device, including sleep, activity, and recovery metrics. For detailed information about OAuth2 authentication, available scopes, and API access, refer to the Oura Ring API documentation.

Create an Oura Ring Credential​

  • To create a new Oura Ring credential, after selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

New Credential Overlay – Oura Ring

OuraRingCred.png

Credential Name & Description​

  1. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

    Resource descriptions are recommended but are not required. They should be used provide information about the resource purpose, data freshness, etc. that can help the owner and other users efficiently understand and utilize the resource.

OAuth2 Client Configuration​

Oura Ring uses OAuth2 3-legged authentication to securely access your Oura Ring account. You need to configure your OAuth2 client application credentials.

  1. Enter your OAuth2 Client ID in the Client ID for Authorization field. This is the Client ID you obtained from your Oura Ring OAuth2 client application settings. The Client ID is used in the OAuth2 authorization flow to identify your application.

  2. Enter your OAuth2 Client ID again in the Re-enter Client ID (same as above) field. This should match the Client ID you entered in the previous step.

  3. Enter your OAuth2 Client Secret in the Client Secret field. This is the Client Secret you obtained from your Oura Ring OAuth2 client application settings. The Client Secret is used in the OAuth2 token exchange and is sensitive information that must be kept confidential.

  4. Enter the OAuth2 scope in the Scope field. This should be the OAuth2 permission scope used to limit the application's access to your Oura Ring account data. Common scopes include personal for personal data access. Refer to the Oura Ring API documentation for available scopes.

OAuth2 Authentication​

  1. Click the Authorize button to begin the OAuth2 authorization process. You will be redirected to Oura Ring's authorization page.

  2. Sign in to your Oura Ring account using your Oura Ring account credentials.

  3. Review the permissions that Nexla is requesting. These permissions allow Nexla to access your Oura Ring account data based on the requested scope.

  4. Click Accept or Authorize to grant Nexla permission to access your Oura Ring account.

  5. After authorization, you will be redirected back to Nexla, and the credential will be automatically configured with the OAuth2 tokens.

    OAuth2 authentication uses your OAuth2 client application to securely access your Oura Ring account. When you authorize Nexla, you grant permission for Nexla to access your Oura Ring account data based on the requested scope (e.g., personal for personal data access). The authorization includes access to read health and wellness data from your Oura Ring device, including sleep, activity, and recovery metrics.

    The OAuth2 tokens (access token and refresh token) are automatically managed by Nexla. The access token is used to authenticate API requests, and the refresh token is used to obtain new access tokens when they expire. Tokens are automatically refreshed as needed to maintain access to your Oura Ring account.

    If you need to revoke access, you can do so in your Oura Ring account settings under OAuth2 applications or Connected apps. For detailed information about OAuth2 authentication, available scopes, and API access, see the Oura Ring API documentation.

Save the Credential​

  1. Once all of the relevant steps in the above sections have been completed, click the Save button at the bottom of the overlay to save the configured credential.

  2. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation and can be selected for use with a new data source or destination.