Credentials

Begin OAuth connect flow

Changed on

Initiate the OAuth connect flow for a credential.

Discriminates on the provider's returned challenge: OAuth2 authorization-code providers return an authorize_url for popup redirect; device-flow providers return user_code / verification_uri for the RFC 8628 human step.

post/credentials/{credential_id}/connect

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /credentials/{credential_id}/connect
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL /authorize, token URL /oauth/token)

Path parameters

credential_idstring required

ID of the credential.

Example:cred_6968b39855d91a3561684b32

Request body

extraobject

Additional provider-specific connect parameters.

scopesstring[]

OAuth scopes to request.

Example request

{
  "extra": {
    "prompt": "consent"
  },
  "scopes": [
    "read_write"
  ]
}

Response

Successful Response

unknown required

Changes

  • c516481e6ed8Revision changes
    • info

      the endpoint scheme security OAuth2 was added to the API

  • da1def020382Revision changes
    • breaking

      the response's body type changed from object to no type for status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status