Scopes
The scopes a client may request and what each one grants.
On this page
The scopes below are generated from the scope table the server enforces. Scopes and consent explains how an application asks for them and what the person sees.
Standard scopes#
| Scope | Description |
|---|---|
openid | Confirms you are signed in and shares the account identifier this app knows you by. On its own it shares nothing else: no name, no email address. |
profile | Your display name, your username, your profile picture, your language and time zone, and when you last changed your profile. |
email | Your email address, and whether you have verified it. |
offline_access | Lets the app keep working in the background and stay signed in without asking you for your password again. You can end it at any time from Connected apps in your account. |
tdaid.tenant | Tells the app which organization you are signed in to. |
Product scopes#
| Pattern | Description |
|---|---|
^[a-z][a-z0-9_]{1,31}$ | Lets the app use your permissions in <ns>, limited to what your role there allows. |
Personal access token scopes#
| Scope | Description |
|---|---|
identity.self.read | Read my own profile: GET /v1/me with a personal access token. |
identity.self.write | Edit my own profile: PATCH /v1/me with a personal access token. |