Activepieces Management Octri Preview
POST/v1/app-connections/oauth2/authorization-url

Get an OAuth 2.0 authorization URL

Generates an OAuth 2.0 authorization URL for an app connection. Supply pieceName, clientId, and redirectUrl; you can also provide pieceVersion, projectId, and props for the authorization request.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

6 body fields

OAuth 2.0 authorization request details. pieceName, clientId, and redirectUrl are required.

clientIdstringrequired
The OAuth 2.0 client identifier.
pieceNamestringrequired
The name of the piece for which to generate an authorization URL.
pieceVersionstringoptional
The version of the piece to use.
projectIdstringoptional
The identifier of the project associated with the authorization request.
propsobjectoptional
Key-value properties to include in the authorization request, with string property names.
redirectUrlstringrequired
The URL to redirect to after authorization.

1 status code
200Returns the authorization URL and, when provided, a code verifier.
authorizationUrlstringrequired
codeVerifierstringoptional

Error handling

The body must include pieceName, clientId, and redirectUrl. props can contain key-value data with string property names.