Scopes
Below is a list of scopes which can be included when requesting an access token.
Tip
When requesting a token from the auth server, you can simply use a wildcard *
to include all scopes available to your user.
Scope |
The application will be able to |
---|---|
addresses.suggest |
Retrieve address suggestions. |
broker.member |
Retrieve broker related resources and create organizations for that broker. |
collections.manage |
Manage collection resources. |
collections.view |
Retrieve collection resources. |
contracts.manage |
Manage contract resources. |
organizations.manage |
Manage organization related resources on behalf of a single organization or all organizations belonging to a broker. |
returns.manage |
Manage all return related resources. |
shipments.manage |
Manage shipments on behalf of all shops belonging to an organization or broker. |
shipments.view |
Retrieve shipments on behalf of all shops belonging to an organization or broker. |
system.manage |
Manage all system related resources. |
users.manage |
Manage user resources. |