Principal
Subjects in BigState may belong to a principal — a higher-level entity that represents an owner, user, device, or any logical grouping. Principals allow you to organize subjects, control access, and manage state flows across related components.
Endpoints
Create principal Request#
POST
await client.principalCreate(data)
request parameters
response parameters
After submitting a call, you receive a response message to inform you that your request was received and processed.Depending on the HTTP status code of the response message, it is helpful to build some logic to handle any errors that a request or the system may return.
HTTP Responses
Get principal Request#
GET
await client.principalGet(principalId)
request parameters
response parameters
After submitting a call, you receive a response message to inform you that your request was received and processed.Depending on the HTTP status code of the response message, it is helpful to build some logic to handle any errors that a request or the system may return.
HTTP Responses
Get principal list Request#
GET
await client.principalGetList()
request parameters
This endpoint does not take any query or body parameters
response parameters
After submitting a call, you receive a response message to inform you that your request was received and processed.Depending on the HTTP status code of the response message, it is helpful to build some logic to handle any errors that a request or the system may return.
HTTP Responses