Create api key connection.
POST
/v1/virtual-users/{identity_id}/connections/{provider}
const url = 'https://app.everruns.com/api/v1/virtual-users/example/connections/example';const options = { method: 'POST', headers: {'Content-Type': 'application/json'}, body: '{"api_key":"example-api-key"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://app.everruns.com/api/v1/virtual-users/example/connections/example \ --header 'Content-Type: application/json' \ --data '{ "api_key": "example-api-key" }'Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”identity_id
required
string
provider
required
string
Request Bodyrequired
Section titled “Request Bodyrequired”Media typeapplication/json
Request body for API-key connection creation (plugin-based providers). Accepts api_key plus any additional form fields as extra_fields.
object
api_key
required
Provider API key, encrypted before storage.
string
Example
example-api-keykey
additional properties
Additional provider-specific form fields (e.g. org_slug for Deno personal tokens).
Responses
Section titled “Responses”Success
Media typeapplication/json
Connection info returned in API responses (never includes token)
object
connected_at
required
Time the grant was created.
string format: date-time
connection_type
required
Credential mechanism used by this connection.
string
provider
required
Stable provider identifier.
string
provider_username
Display name on the provider.
string | null
scopes
Provider scopes granted to this account.
string | null
Example
{ "connected_at": "2026-09-29T12:00:00Z", "connection_type": "oauth", "provider": "github", "provider_username": "octocat", "scopes": "read:user"}Authentication required
Permission denied
Virtual user not found