Skip to main content
This guide walks you through obtaining all required credentials for the Oura plugin.

​
Authentication Method

The Oura plugin uses API key authentication.
  • api_key (default) — Personal access token for the Oura Cloud API

​
Personal Access Token

​
Step 1: Register an Application

  1. Sign in to Oura Cloud with your Oura account.
  2. Open the developer / OAuth section (typically Personal Access Tokens or API Applications — see Oura API documentation for the current path).
  3. Create a new personal access token or OAuth application, following Oura’s steps to generate a token with the scopes you need (sleep, activity, readiness, etc.).

​
Step 2: Copy the Token

Copy the token when it is displayed. Treat it like a password. Storing credentials: 
pnpm corsair setup --plugin=oura api_key=your-personal-access-token
Verify: 
pnpm corsair auth --plugin=oura --credentials

​
Webhook Secret

If you configure Oura webhooks that sign requests, copy the signing secret from Oura’s webhook or subscription settings and store it for verification in Corsair. 
pnpm corsair setup --plugin=oura webhook_signature=your-webhook-secret

​
Required Credentials Summary

CredentialRequired forWhere to find
Personal access tokenapi_key authOura Cloud → developer / token settings
Webhook secretWebhooks (if used)Oura webhook configuration
For general information about how Corsair handles authentication, see Authentication.