Skip to main content

Supported Scopes

A list of scopes is available at the discovery endpoints listed in Authentication. Further descriptions of AgSync specific supported scopes are listed below:

  • AgSync
    • This scope will give the user access to their AgSync User ID, Home Account ID, and Name.
  • Roles
    • This scope will give the user access to the roles that they are a part of.

One tip to also help performance is to include agsync_resources and roles_resources as requested scopes when retrieving an access token. This will provide a larger token and more data to be sent across in the request, but the added information allows Raven to process the request faster and with less overhead. This leads to better response times.

Refer to the following table for more information about scope:

Supported ScopeDescription
openidIndicates that the application intends to use Open ID Connect to verify user identity.
profileAccess to claims representing profile information; name, picture, updated_at, etc.
emailAccess to the email claim; user’s email address and email_verified.
agsyncAccess to user ID, home account ID, and name.
agsync_resourcesAccess to a larger access token; Allows for faster processing with less overhead.
rolesAccess to the roles that one is a part of.
roles_resourcesAccess to a larger access token; Allows for faster processing with less overhead.
offline_accessProvides a refresh token that allows a user to get an access token, even if not logged in.

Supported Claims

The following is a listed of claims supported by Dispatch Pro:

  • sub
  • name, family_name, given_name, middle_name, nickname
  • preferred_username
  • profile
  • picture
  • website
  • gender
  • birthdate
  • zoneinfo
  • locale
  • updated_at
  • email, email_verified
  • agsync_user_id
  • account_id
  • agsync_name
  • agsync_account_id
  • org_id
  • external_provider_user_id
  • user_integration_partner_id
  • role