OAuth Scopes
Scopes define the level of access your application requests.
Only request the scopes you actually need.
OpenID Connect Scopes
| Scope |
Description |
openid |
Required for OpenID Connect. Returns user's ID. |
email |
Access to user's email address. |
offline_access |
Request a refresh token for long-lived access. |
Profile Scopes
| Scope |
Description |
profile:read |
Read user profile information (name, gender, birthdate, etc.). |
profile:write |
Update user profile information. |
Integration Scopes
| Scope |
Description |
integrations:read |
Read user's integrations (access control cards, etc.). |
integrations:write |
Modify user's integration settings. |
Loyalty Scopes
| Scope |
Description |
loyalty:read |
Read loyalty points, transactions, and rewards. |
loyalty:write |
Record transactions and redeem rewards. |
Shop & Orders Scopes
| Scope |
Description |
shop:read |
Read shop catalog, products, and collections. |
orders:read |
Read order history and status. |
orders:write |
Create and manage orders. |
Example Scope Request
scope=openid profile:read email loyalty:read