{ "opencollection": "1.0.0", "info": { "name": "Supabase Auth Admin Authentication API", "version": "2.0.0" }, "request": { "auth": { "type": "apikey", "key": "apikey", "value": "{{apikey}}", "placement": "header" } }, "items": [ { "info": { "name": "Authentication", "type": "folder" }, "items": [ { "info": { "name": "Sign up a new user", "type": "http" }, "http": { "method": "POST", "url": "https://{project_ref}.supabase.co/auth/v1/signup", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new user account with email and password, or phone and password. Returns the user object and session tokens. A confirmation email or SMS may be sent depending on project configuration." }, { "info": { "name": "Sign in with credentials", "type": "http" }, "http": { "method": "POST", "url": "https://{project_ref}.supabase.co/auth/v1/token", "params": [ { "name": "grant_type", "value": "", "type": "query", "description": "The type of authentication grant to use." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Authenticates a user with their credentials and returns a session including access and refresh tokens. The grant_type parameter determines the authentication method." }, { "info": { "name": "Send a one-time password", "type": "http" }, "http": { "method": "POST", "url": "https://{project_ref}.supabase.co/auth/v1/otp", "body": { "type": "json", "data": "{}" } }, "docs": "Sends a one-time password to the specified email or phone number. If the email template uses a confirmation URL variable, a magic link is sent instead. The OTP can be verified using the /verify endpoint." }, { "info": { "name": "Send a magic link", "type": "http" }, "http": { "method": "POST", "url": "https://{project_ref}.supabase.co/auth/v1/magiclink", "body": { "type": "json", "data": "{}" } }, "docs": "Sends a magic link email to the specified address for passwordless authentication. The user clicks the link to be authenticated." }, { "info": { "name": "Send password recovery email", "type": "http" }, "http": { "method": "POST", "url": "https://{project_ref}.supabase.co/auth/v1/recover", "body": { "type": "json", "data": "{}" } }, "docs": "Sends a password recovery email to the specified address containing a link that allows the user to reset their password." }, { "info": { "name": "Verify OTP via redirect", "type": "http" }, "http": { "method": "GET", "url": "https://{project_ref}.supabase.co/auth/v1/verify", "params": [ { "name": "token_hash", "value": "", "type": "query", "description": "The token hash from the email link" }, { "name": "type", "value": "", "type": "query", "description": "Type of verification" }, { "name": "redirect_to", "value": "", "type": "query", "description": "URL to redirect to after verification" } ] }, "docs": "Verifies a token hash from a magic link or email confirmation redirect. This endpoint is typically called by clicking the link in the email." }, { "info": { "name": "Verify an OTP or token hash", "type": "http" }, "http": { "method": "POST", "url": "https://{project_ref}.supabase.co/auth/v1/verify", "body": { "type": "json", "data": "{}" } }, "docs": "Verifies a one-time password or token hash received via email or SMS. Supports different verification types including signup, recovery, invite, magiclink, email_change, and phone_change." }, { "info": { "name": "Sign out a user", "type": "http" }, "http": { "method": "POST", "url": "https://{project_ref}.supabase.co/auth/v1/logout", "params": [ { "name": "scope", "value": "", "type": "query", "description": "Scope of logout. Local revokes only the current session, global revokes all sessions, others revokes all other sessions." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Invalidates the user's current session and refresh token. Requires a valid access token in the Authorization header." } ] } ], "bundled": true }