Choose a version:

delegateAccessTokenCreate

mutation

Creates a DelegateAccessToken with a subset of the parent token's permissions.

Delegate access tokens enable secure permission delegation to subsystems or services that need limited access to shop resources. Each token inherits only the scopes you specify, ensuring subsystems operate with minimal required permissions rather than full app access.

Learn more about delegating access tokens to subsystems.

Anchor to Arguments

Arguments

Anchor to inputinput •DelegateAccessTokenInput! required: The input fields for creating a delegate access token.

Was this section helpful?

Anchor to DelegateAccessTokenCreatePayload returnsDelegateAccessTokenCreatePayload returns

Anchor to delegateAccessTokendelegateAccessToken •DelegateAccessToken: The delegate access token.
Anchor to shopshop •Shop! non-null: The user's shop.
Anchor to userErrorsuserErrors •[DelegateAccessTokenCreateUserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Examples

delegateAccessTokenCreate reference

Mutation Reference

mutation delegateAccessTokenCreate($input: DelegateAccessTokenInput!) {

delegateAccessTokenCreate(input: $input) {

delegateAccessToken {

# DelegateAccessToken fields

}

shop {

# Shop fields

}

userErrors {

field

message

}

Input

{

"input": {

"delegateAccessScope": [

"<your-delegateAccessScope>"

"expiresIn": 1

}

Variables

{
  "input": {
    "delegateAccessScope": [
      "<your-delegateAccessScope>"
    ],
    "expiresIn": 1
  }
}

Schema

input DelegateAccessTokenInput {
  delegateAccessScope: [String!]!
  expiresIn: Int
}