Write policies API endpoint reference guide
The policies resource allows you to manage and apply policies to your data sources. The endpoints and examples provided in this guide are specific to creating global write policies.
POST
/dataSource/{dataSourceId}/access
Manually grants write access to a user.
POST
/policy/global
Creates a global policy.
DELETE
/policy/global/{policyId}
Deletes the specified policy.
GET
/policy/global/{policyId}
Gets the specified policy.
PUT
/policy/global/{policyId}
Updates the specified policy.
The parameters for manually granting write access to a data source without using a policy are outlined in the table below.
The parameters for creating a global write policy are outlined in the table below.
The actions array specifies the policy access type and restriction level. Its child parameters are outlined in the table below.
The circumstances object specifies the conditions under which the policy applies to a data source. Its child parameters are outlined in the table below.
Method | Endpoint | Description |
---|---|---|
Method | Endpoint | Description |
---|---|---|
Parameter | Description |
---|---|
Parameter | Description |
---|---|
Parameter | Description |
---|---|
Parameter | Description | Required or optional | Default values | Accepted values |
---|---|---|---|---|
Parameter | Description | Required or optional | Default values | Accepted values |
---|---|---|---|---|
Parameter | Description | Required or optional | Default values | Accepted values |
---|---|---|---|---|
Parameter | Description | Required or optional | Default values | Accepted values |
---|---|---|---|---|
Parameter | Description |
---|---|
Parameter |
---|