Initiate connect

Start a connect session by providing a code challenge. Record the sessionId, and use the returned url to authenticate in a browser.

GET /authorization/connect

Initiate connect

cURL

curl --request GET \
  --url https://api.example.com/authorization/connect \
  --header 'Authorization: Bearer <token>'

202

{
  "url": "<string>",
  "sessionId": "<string>",
  "expires": "2023-11-07T05:31:56Z",
  "message": "<string>"
}

Query Parameters

code_challenge · string · required

Required. SHA256 code challenge. See https://tonyxu-io.github.io/pkce-generator/.

Response

202

application/json

Accepted

url · string | null

Url to navigate the user to.

sessionId · string | null

Id of the session.

expires · string<date-time>

Date and time of then the connect window expires.

message · string | null · read-only