Connectors

Authorize an OAuth connector

Create an OAuth authorization URL for a provider. Use this to start a browser-based consent flow.

get/v1/oauth/{provider}/authorize

Request

  • Base URL: https://api.sprites.dev
  • URL: https://api.sprites.dev/v1/oauth/{provider}/authorize
  • Auth: HTTP bearer

Path parameters

providerstring required

Query parameters

scopesstring

Comma-separated scopes to request. Replaces the default scope set for this authorization URL.

Example:chat:write,channels:read
add_scopesstring

Comma-separated scopes to add to any scopes already granted for this provider.

Example:reactions:write,files:read
redirect_uristring

OAuth callback URI. Defaults to the Sprites API callback for the provider.

Example:https://api.sprites.dev/v1/oauth/slack/callback
statestring

Optional state value. If omitted, Sprites generates one that ties the callback to the organization.

Example:opaque-state

Response

Success

authorize_urlstring required

Provider URL where the user grants access.

statestring required

State value that must be sent back to the callback.

Example response

{
  "authorize_url": "https://slack.com/oauth/v2/authorize?client_id=...",
  "state": "opaque-state"
}

Changes

No recorded changes to this operation across all 1 revision of this API.