Principal
A Policy defines authorization rules in the BigState system. It specifies which principals can perform which actions on which resources, enabling structured and secure access control.
Endpoints
Create policy Request#
POST
await client.policyCreate(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 policy Request#
GET
await client.policyGet(policyId)
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
Delete policy Request#
DELETE
await client.policyDelete(policyId)
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 policy list Request#
GET
await client.policyGetList()
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