Create a target-bound provider setup URL.

POST

/v1/virtual-users/{identity_id}/connections/{provider}/authorize

curl --request POST \
  --url https://app.everruns.com/api/v1/virtual-users/example/connections/example/authorize \
  --header 'Content-Type: application/json' \
  --data '{ "agent_id": "example", "mode": "virtual_user", "popup": false, "return_to": "/settings/connections", "session_id": "example" }'

• Production API

Parameters

Path Parameters

identity_id

required

string

provider

required

string

Request Body^required

Media typeapplication/json

Browser setup options. The canonical target is selected by the authorized resource path.

object

agent_id

Required when mode = identity: the agent whose service grant this is. The grant is owned by the agent’s identity, not by the admin who authorizes it (EVE-1030). Optional legacy service agent target.

string | null

mode

Legacy setup mode; canonical resource paths capture the target.

string | null

Example

virtual_user

popup

Whether setup completes in a popup.

boolean | null

Example

false

return_to

Same-origin return path after setup.

string | null

Example

/settings/connections

session_id

Optional session grant destination for legacy setup.

string | null

Responses

200

Browser setup created

Media typeapplication/json

Browser URL returned to a bearer-authenticated consumer before navigation.

object

authorization_url

required

Navigate the browser to this provider authorization URL.

string

Example

{
  "authorization_url": "https://provider.example/authorize?state=opaque"
}

403

Setup not authorized