• DOCUMENTATION
  • WORKATO BLOG
  • PRODUCT BLOG
  • Return to Workato
  • Log in
  • ☰
  • Community/Discussions
Solution home Recipe 101 Recipe FAQs

Scopes in Custom Actions

Modified on: Tue, Oct 9, 2018 at 8:41 PM

Scope is a parameter as defined in the OAuth 2.0 standards to enable a client to specify the scope of the access request. The scope parameter allows the application to express the desired scope of the access request. The scope parameter can also be used by the authorization server in the response to indicate which scopes were actually granted (if they are different than the ones requested).


You can use scopes to:

  • Let an application authenticate users and get additional information about them, such as their email or picture.

  • Implement granular access control to your API. In this case, you need to define custom scopes (claims) for your API and add these newly-created scopes to your scope request parameter.


Sample custom action and their OAuth scopes for Concur:



In the example above when building your custom action with an HTTP request, the request will be authorized under the Concur connection OAuth scopes:


Expense reports:add, Expense reports:approve, Expense reports:update, List items:add,
List items:update, List items:delete, Images:add, Images:retrieve report, Images:line item


If you have not successfully authenticated or does not authorize the scopes for your application, an error code and description will be appended to the redirect URI, typically with a 403 error message.


If in any case the scope is not listed on the custom action, you can specify the scope by appending it on the base URI and path. your application can request multiple scopes as space or comma separated list.


For example, you want to have this scope on your custom action: teams:read users:read


You can specify it to something like this:


https://slack.com/oauth/authorize?  client_id=...&  scope=team%3Aread+users%3Aread


For additional information, it's best to check the API documentation of the application to find out the scopes needed for the action you want to use.


Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.

Related Articles

    Still can't find your solution?

    Visit our forums to search for answers, or post your own questions.

    Documentation
    Developer's Library
    Tutorials
    eBooks
    Product Hour
    Product Blog
    Workato Blog
    Product updates
    Customer Stories
    © Workato 2020   Privacy   Terms   +1 (844) 469-6752
    • Documentation
    • Workato Blog
    • Product Blog
    • Solutions
    • Forums
    • Tickets
    • Log in
    • Return to Workato