Auth Token Management

  • user_id:<user-id> - Gives the token access to a given user. Multiple can be listed. Ex user_id:pigeon user_id:bluebird. User ID scopes must be used in conjunction with other scopes to specify which resources of the user the token can access.
  • read:messages - Gives the token access to read messages. Must be used in conjunction with one or more user_ids.
  • read:user-tokens - Gives the token access to read user tokens. Must be used in conjunction with one or more user_id scopes.
  • write:user-tokens - Gives the token access to write user tokens. Must be used in conjunction with one or more user_id scopes.
  • read:brands[:<brand_id>] Give the token access to read brands, optionally restricted to a specific brand_id. Examples read:brands, read:brands:my_brand.
  • write:brands[:<brand_id>] Give the token access to read brands, optionally restricted to a specific brand_id. Examples write:brands, write:brands:my_brand.
  • inbox:read:messages Give the token access to read inbox messages.
  • inbox:write:events Give the token access to write inbox events, such as mark message as read.
  • read:preferences Give the token access to read user preferences.
  • write:preferences Give the token access to write user preferences.