The Client Context endpoint and fields are described below including details of the supported RESTful CRUD verbs. For details of the conventions of the API see the general conventions.
Endpoint path prefix:
/n/v1/clientcontext
clientcontext was introduced in API version V1
Client Context has not been marked for deprecation
This endpoint supports the following CRUD operations in line with our API conventions. See the conventions section for more details.
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.
{
"hasSession" : false,
"hasBearer" : true,
"client" : {
"urn" : "3d059a42-2095-4d19-aea9-3243787e1ccd",
"scope" : "api.baack.co",
"owner" : {
"urn" : "32a90f18-aaa0-4bdc-a63e-4efd2e16c28c",
"url" : "/n/v1/company/32a90f18-aaa0-4bdc-a63e-4efd2e16c28c"
},
"clientID" : "Bearer"
},
"owner" : {
"urn" : "32a90f18-aaa0-4bdc-a63e-4efd2e16c28c",
"url" : "/n/v1/company/32a90f18-aaa0-4bdc-a63e-4efd2e16c28c",
"name" : "Example company name",
"parentCompany" : {
"urn" : "fe7f2716-3541-45d5-833d-b8a14ad386d0",
"url" : "/n/v1/company/fe7f2716-3541-45d5-833d-b8a14ad386d0"
},
"owner" : {
"urn" : "7f8a5363-3a24-4ca1-a9a8-986bbbe7ee56",
"url" : "/n/v1/company/7f8a5363-3a24-4ca1-a9a8-986bbbe7ee56"
},
"organisation" : {
"urn" : "0225cc24-77fc-40fe-88dd-66f358a17d56",
"url" : "/n/v1/organisation/0225cc24-77fc-40fe-88dd-66f358a17d56"
}
}
}API code READ_SUCCESS HTTP status code 200 : On read when the request is successful. The returned representation is given with the relevant 2XX HTTP code without further detail.
API code NOT_FOUND HTTP status code 404 : When the request referenced a representation or a concept that was not found including other request context requirements. Note that if a request is missing other concepts including authorisation, permissions or restrictions on the visibility HTTP not found (404) will typically be returned. Note that when creating a representation if the owner or other references can't be resolved the endpoint may return not found.