Pinal Developers

Reference

Scopes

25 scopes across 7 services. Ask for the smallest set that does the job; people are more likely to say yes, and you'll have less to protect.

    • openid Sign in with Pinal Issues an ID token with a stable account identifier (sub). Consent screen: “Know who you are”
    • profile Profile Adds name, given_name, family_name and picture claims. Consent screen: “See your name and profile picture”
    • email Email address Adds email and email_verified claims. Consent screen: “See your email address”
    • offline_access Offline access Issues a refresh token so the app can keep working without you present. Consent screen: “Stay connected while you’re away”
    • mail.metadata Read message metadata Headers and labels only. Bodies and attachments are not included. Consent screen: “See senders, subjects and dates of your mail”
    • mail.read Private data Read mail Full message bodies and attachments across every mailbox. Consent screen: “Read your email, including attachments”
    • mail.compose Private data Create drafts Write drafts that stay in Drafts until the person sends them. Consent screen: “Create and edit drafts in your mailbox”
    • mail.send Sensitive actions Send mail Send messages from the person’s address without them seeing each one first. Consent screen: “Send email as you”
    • mail.labels Manage labels Organise messages. Cannot read message bodies on its own. Consent screen: “Create, rename and apply labels”
    • mail.settings Sensitive actions Mail settings Includes forwarding rules, so it is shown with a warning. Consent screen: “Change filters, forwarding and auto-replies”
    • contacts.read Private data Read contacts Names, addresses, phone numbers and groups. Consent screen: “See your contacts”
    • contacts.write Private data Manage contacts Includes everything in contacts.read. Consent screen: “Add, edit and delete your contacts”
    • calendar.freebusy Free/busy Time blocks only, with no event details. Consent screen: “See when you’re free or busy”
    • calendar.read Private data Read events Titles, attendees, locations and notes. Consent screen: “See your calendars and events”
    • calendar.write Private data Manage events Includes sending invitations on the person’s behalf. Consent screen: “Create, change and delete events”
    • passwords.autofill Private data Autofill Request one item at a time for a matching site; the person approves each fill. Consent screen: “Fill saved logins when you ask it to”
    • passwords.read Sensitive actions Read vault Encrypted items; decryption needs the person’s vault key on their device. Consent screen: “Read the items in your vault”
    • passwords.write Sensitive actions Save to vault Create and update encrypted items. Consent screen: “Save new logins to your vault”
    • notes.read Private data Read notes Every note, including attachments. Consent screen: “Read your notes and notebooks”
    • notes.write Private data Write notes Includes moving notes between notebooks and deleting them. Consent screen: “Create and edit your notes”
    • notes.share Sensitive actions Share notes Create share links and invite collaborators. Consent screen: “Share your notes with other people”
    • photos.read Private data View library Originals, thumbnails and metadata including location. Consent screen: “See your photos and videos”
    • photos.upload Upload Upload only. Cannot see existing items. Consent screen: “Add photos and videos to your library”
    • photos.albums Private data Manage albums Add and remove items in albums the app can see. Consent screen: “Create and organise your albums”
    • photos.share Sensitive actions Share Create links and shared albums. Consent screen: “Share photos and albums with others”

Every scope

ScopeConsent screen saysUsed by
openid Know who you are Who's signed in
profile See your name and profile picture ID token claims
email See your email address ID token claims
offline_access Stay connected while you’re away ID token claims
mail.metadata See senders, subjects and dates of your mail List messages
mail.read Read your email, including attachments Get a message
mail.compose Create and edit drafts in your mailbox Create a draft
mail.send Send email as you Send a message
mail.labels Create, rename and apply labels Label or mark a messageList labels
mail.settings Change filters, forwarding and auto-replies ID token claims
contacts.read See your contacts List contactsGet a contact
contacts.write Add, edit and delete your contacts Create a contactDelete a contact
calendar.freebusy See when you’re free or busy Free/busy
calendar.read See your calendars and events List events
calendar.write Create, change and delete events Create an event
passwords.autofill Fill saved logins when you ask it to Request a fill
passwords.read Read the items in your vault List vault items
passwords.write Save new logins to your vault Save an item
notes.read Read your notes and notebooks List notesGet a note
notes.write Create and edit your notes Create a noteUpdate a noteDelete a note
notes.share Share your notes with other people Share a note
photos.read See your photos and videos List photosList albums
photos.upload Add photos and videos to your library Upload a photo
photos.albums Create and organise your albums Create an album
photos.share Share photos and albums with others Share an album