Delegating access to subsystems

Some app architectures are split across multiple subsystems, with each one running on its own servers. In these cases, it's best to avoid sharing a single access token between all the subsystems, and make sure each subsystem has access to only the minimal scopes it needs to function properly. This improves your app's security and makes it easier to rotate your access tokens.

To create a new delegate access token, make an authenticated request to this endpoint:

POST https://{shop}

Provide the following parameters in the body of the request:

  • delegate_access_scope: The list of scopes that will be delegated to the new access token (required).
  • expires_in: The amount of time, in seconds, after which the new access token is no longer be valid (optional).

There are a few restrictions to take into account when creating a delegate access token:

  • An application can delegate only the same or fewer scopes than were granted to it when asking for permission. It's not possible to request extra scopes using this endpoint. If a new scope is required, then the app must first be re-authorized with the new access scope by a user of the store.
  • When an application is re-authorized with fewer access scopes, all delegate access tokens will also lose the access scopes that are no longer authorized.
  • A delegate access token cannot be used to create new delegate access tokens.
  • Only an access token that never expires can be used to make authenticated requests to this endpoint.
  • A delegate access token can be used to make requests to any API endpoints that do not require access scopes. This includes, for example, uninstalling the application from a store. Make sure that only trusted parties have access to a delegated access token.

Sign up for a Partner account to get started.

Sign up