Project Policy API
Project policies describe a set of actions one account can perform when it was associated with a grant for a project.
The following actions can be used in the projectActions fields of this API:
ViewComponentgrants read access to a componentCreateComponentallows creating new components in a projectUpdateComponentallows uploading new versions for existing components in a projectDeleteComponentallows deleting components from a projectViewWorkerallows querying existing workers of a component belonging to the projectCreateWorkerallows launching new workers of a component in the projectUpdateWorkerallows manipulating existing workers of a component belonging to the projectDeleteWorkerallows deleting workers of a component belonging to the projectViewProjectGrantsallows listing the existing grants of the projectCreateProjectGrantsallows creating new grants for the projectDeleteProjectGrantsallows deleting existing grants of the project
Get a project policy
| Path | Method | Protected |
|---|---|---|
/v1/project-policies/{project_policy_id} | GET | Yes |
Returns a given project policy by it's ID. Project policy identifiers are used in project grants.
Example Response JSON
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"projectActions": {
"actions": [
"ViewComponent"
]
}
}Create a project policy
| Path | Method | Protected |
|---|---|---|
/v1/project-policies | POST | Yes |
Creates a new project policy and returns the object describing it, including the newly created policy's id.
Example Request JSON
{
"name": "string",
"projectActions": {
"actions": [
"ViewComponent"
]
}
}Example Response JSON
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"projectActions": {
"actions": [
"ViewComponent"
]
}
}Project Policy API Errors
| Status Code | Description | Body |
|---|---|---|
| 400 | Invalid request, returning with a list of issues detected in the request | {"errors":["string"]} |
| 401 | Unauthorized request | {"error":"string"} |
| 404 | Account not found | {"error":"string"} |
| 500 | Internal server error | {"error":"string"} |