Customer sessions | Orishare docs

Exchange provider proof, backend authority or anonymous admission for a customer session

Authorization

AuthorizationBearer <token>

Publishable API key for permitted client events.

In: header

Header Parameters

Idempotency-Key*string

Required. Official clients generate a UUID when omitted by the caller.

Length1 <= length <= 255

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

grant_type*string

connection_id*string

Length1 <= length

provider_token*string

Length1 <= length <= 16384

capabilities?array<>

Itemsitems <= 3

lifetime_seconds?integer

Range1 <= value <= 3600

Response Body

`application/json`

curl -X POST "https://example.com/customer_sessions" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "grant_type": "anonymous",    "capabilities": [      "customer:read"    ]  }'

{  "customer_token": "string",  "customer_id": "string",  "session_id": "string",  "family_id": "string",  "assurance": "anonymous",  "capabilities": [    "customer:read"  ],  "expires_at": "2019-08-24T14:15:22Z",  "test_mode": true}

Renew a live session within its original authority and family lifetime

Authorization

publishableKey customerToken

AuthorizationBearer <token>

Publishable API key for permitted client events.

In: header

X-Orishare-Customer-Token<token>

Customer session proof, required together with a production publishable key.

In: header

Header Parameters

Idempotency-Key*string

Required. Official clients generate a UUID when omitted by the caller.

Length1 <= length <= 255

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

capabilities?array<>

Itemsitems <= 3

lifetime_seconds?integer

Range1 <= value <= 3600

Response Body

`application/json`

curl -X POST "https://example.com/customer/session_renewals" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{}'

{  "customer_token": "string",  "customer_id": "string",  "session_id": "string",  "family_id": "string",  "assurance": "anonymous",  "capabilities": [    "customer:read"  ],  "expires_at": "2019-08-24T14:15:22Z",  "test_mode": true}

Exchange the parent page session for a short-lived portal-bound embed session (portal origin only)

Authorization

publishableKey customerToken

AuthorizationBearer <token>

Publishable API key for permitted client events.

In: header

X-Orishare-Customer-Token<token>

Customer session proof, required together with a production publishable key.

In: header

Header Parameters

Idempotency-Key*string

Required. Official clients generate a UUID when omitted by the caller.

Length1 <= length <= 255

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

portal_id*string

Match^ptl_[0-9a-f]{32}$

version_id*string

Match^ptv_[0-9a-f]{32}$

acquisition_id*string

Match^acq_[A-Za-z0-9_-]{16,64}$

lifetime_seconds?integer

Range1 <= value <= 3600

Response Body

`application/json`

curl -X POST "https://example.com/customer/embed_sessions" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "portal_id": "ptl_00000000000000000000000000000000",    "version_id": "ptv_00000000000000000000000000000000",    "acquisition_id": "acq_exampleexample01"  }'

{  "customer_token": "string",  "customer_id": "string",  "session_id": "string",  "family_id": "string",  "assurance": "anonymous",  "capabilities": [    "customer:read"  ],  "expires_at": "2019-08-24T14:15:22Z",  "test_mode": true}

Revoke this family's embed sessions of one portal by acquisition id (portal origin only)

Authorization

publishableKey customerToken

AuthorizationBearer <token>

Publishable API key for permitted client events.

In: header

X-Orishare-Customer-Token<token>

Customer session proof, required together with a production publishable key.

In: header

Header Parameters

Idempotency-Key*string

Required. Official clients generate a UUID when omitted by the caller.

Length1 <= length <= 255

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

portal_id*string

Match^ptl_[0-9a-f]{32}$

acquisition_ids*array<>

Items1 <= items <= 20

Response Body

`application/json`

curl -X POST "https://example.com/customer/embed_session_retirements" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "portal_id": "ptl_00000000000000000000000000000000",    "acquisition_ids": [      "acq_exampleexample01"    ]  }'

{  "retired": 0}

Revoke this session

Authorization

publishableKey customerToken

AuthorizationBearer <token>

Publishable API key for permitted client events.

In: header

X-Orishare-Customer-Token<token>

Customer session proof, required together with a production publishable key.

In: header

Header Parameters

Idempotency-Key*string

Required. Official clients generate a UUID when omitted by the caller.

Length1 <= length <= 255

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

`application/json`

curl -X POST "https://example.com/customer/session_revocations" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{}'

Empty

Revoke this session family

Authorization

publishableKey customerToken

AuthorizationBearer <token>

Publishable API key for permitted client events.

In: header

X-Orishare-Customer-Token<token>

Customer session proof, required together with a production publishable key.

In: header

Header Parameters

Idempotency-Key*string

Required. Official clients generate a UUID when omitted by the caller.

Length1 <= length <= 255

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

`application/json`

curl -X POST "https://example.com/customer/session_family_revocations" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{}'

Empty

201application/json

400application/json

401application/json

403application/json

404application/json

409application/json

421application/json

422application/json

429application/json

500application/json

503application/json

201application/json

400application/json

401application/json

403application/json

404application/json

409application/json

421application/json

422application/json

429application/json

500application/json

503application/json

201application/json

400application/json

401application/json

403application/json

404application/json

409application/json

421application/json

422application/json

429application/json

500application/json

503application/json

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

421application/json

422application/json

429application/json

500application/json

503application/json

204

400application/json

401application/json

403application/json

404application/json

409application/json

421application/json

422application/json

429application/json

500application/json

503application/json

204

400application/json

401application/json

403application/json

404application/json

409application/json

421application/json

422application/json

429application/json

500application/json

503application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`