shopify.auth
January 26, 2024 · View on GitHub
This object contains functions used to authenticate apps, and redirect users to Shopify.
Token Exchange
Learn more about token exchange.
| Property | Description |
|---|---|
| tokenExchange | Performs token exchange to get access token from session token |
Authorization Code Grant Flow
Learn more about authorization code grant flow.
| Property | Description |
|---|---|
| begin | Redirect the user to Shopify to request authorization for the app. |
| callback | Receive Shopify's callback after the user approves the app installation. |
| nonce | Generates a random string of characters to be used as the state value for OAuth. |
Utility Functions
| Property | Description |
|---|---|
| safeCompare | Compares two strings or arrays in a way that's safe against timing attacks. |
| getEmbeddedAppUrl | Builds a URL to redirect the user back to the right Shopify surface based on the current request. |
| buildEmbeddedAppUrl | Constructs the appropriate Shopify URL to redirect to. |