Client Context – Baack docs
Client Context
Representation of the client context metadata to allow callers to understand the current client session state. The client context may be using a regular web session (in the case of your client accessing content via a logged in user session), a bearer token either from a secure server to server context or a bearer token from an insecure browser client. The response JSON will let you understand your session state in order to trigger experiences like logging in a user to allow them to use client features like the Editor or Tasks clients.
Endpoints
GET/n/v1/clientcontext/{urn}
Client context provides state information for the request context which can be useful for directing interactions
Responses
- 200 OK
- returns Client Context
READ_SUCCESS - 404 Not found
- returns Error
NOT_FOUND
curl -H "Authorization: Bearer $BAACK_API_TOKEN" \ https://api.baack.co/n/v1/clientcontext/{urn}
Fields
| Field | Type | Description |
|---|---|---|
| hasBearer | boolean | |
| identity | Identity | |
| hasSession | boolean | |
| client | API Client | |
| company | Company | |
| loginIframeSrc | string (uri) | |
| user | User |
User
Representation of a session user returned in contexts like the API client context when user based authentication is being used
Fields
| Field | Type | Description |
|---|---|---|
| urn | string (uuid) | |
| role | string | One of: |
| status | string | One of: |
Used by: Client Context