/partner/embed-sessions
Create a one-time embedded-session bootstrap URL for a partner user. Successful responses use Cache-Control: no-store.
Required scope: embedded-sessions:issue
Authorization
apiKey API key provided in dashboard
In: header
Request Body
application/json
Create the embedded user and team membership on first use instead of failing when they do not exist.
falseEmbedded capability bundles granted to the session.
1 <= itemsExact embedded-application origin that will exchange the bootstrap.
uriExact parent-page origin to bind to this iframe lifecycle channel.
uriStable external user identifier in the partner system.
1 <= lengthThe team to bind the embedded session to.
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$uuidRelative reports or statements URL to open in the embedded application.
^\/(reports|statements)(?:[/?]|$)Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://staging.api.vrplatform.app/partner/embed-sessions" \ -H "Content-Type: application/json" \ -d '{ "bundles": [ "embed:exports:v1" ], "embedOrigin": "http://example.com", "parentOrigin": "http://example.com", "sub": "string", "teamId": "a4ede8ba-7c0a-4485-8763-cbd9b282fbec", "viewPath": "string" }'{
"bootstrapExpiresAt": "2019-08-24T14:15:22Z",
"channelId": "5f6d08bc-455a-4532-98b8-19e2cee51160",
"embedUrl": "http://example.com",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"parentOrigin": "http://example.com",
"sessionTtlSeconds": 900,
"teamId": "a4ede8ba-7c0a-4485-8763-cbd9b282fbec",
"userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b"
}{
"code": "string",
"message": "string",
"links": {
"docs": "string",
"schema": "string"
},
"issues": [
{
"message": "string",
"path": [
"string"
],
"schema": "string"
}
],
"retryable": true,
"context": null
}{
"code": "string",
"message": "string",
"links": {
"docs": "string",
"schema": "string"
},
"issues": [
{
"message": "string",
"path": [
"string"
],
"schema": "string"
}
],
"retryable": true,
"context": null
}{
"code": "string",
"message": "string",
"links": {
"docs": "string",
"schema": "string"
},
"issues": [
{
"message": "string",
"path": [
"string"
],
"schema": "string"
}
],
"retryable": true,
"context": null
}{
"code": "string",
"message": "string",
"links": {
"docs": "string",
"schema": "string"
},
"issues": [
{
"message": "string",
"path": [
"string"
],
"schema": "string"
}
],
"retryable": true,
"context": null
}{
"code": "string",
"message": "string",
"links": {
"docs": "string",
"schema": "string"
},
"issues": [
{
"message": "string",
"path": [
"string"
],
"schema": "string"
}
],
"retryable": true,
"context": null
}{
"code": "string",
"message": "string",
"links": {
"docs": "string",
"schema": "string"
},
"issues": [
{
"message": "string",
"path": [
"string"
],
"schema": "string"
}
],
"retryable": true,
"context": null
}{
"code": "string",
"message": "string",
"links": {
"docs": "string",
"schema": "string"
},
"issues": [
{
"message": "string",
"path": [
"string"
],
"schema": "string"
}
],
"retryable": true,
"context": null
}{
"code": "string",
"message": "string",
"links": {
"docs": "string",
"schema": "string"
},
"issues": [
{
"message": "string",
"path": [
"string"
],
"schema": "string"
}
],
"retryable": true,
"context": null
}{
"code": "string",
"message": "string",
"links": {
"docs": "string",
"schema": "string"
},
"issues": [
{
"message": "string",
"path": [
"string"
],
"schema": "string"
}
],
"retryable": true,
"context": null
}