Every account may contain one or more projects. A project is a container for applications and Application Users, and provides an easy way to share and work with a subset of the resources that exist in an account through Scoping.
Projects are their own scope; every resource may or may not be part of the project scope, which in turn limits visibility of those items to only that project. For more details about scoping, see Scoping.
API Status
General Availability:
/projects
/projects/:projectId
/projects
/projects/:projectId
ProjectDocument Data Model
See also: ScopesDocument
Filterable Fields
This resource type can be filtered using the following fields and operators.
Create a Project
Create a new project within an account.
Read a Project
Gets a single project by its projectId
.
Read all Projects
Read all projects in an account. The result may be paginated if there are more than 30 items.
Update a Project
Update the fields of a project by its id
by POST
ing a subset of the ProjectDocument
containing the changed fields.
Delete a Project
Delete a project by its id
. This will also remove access to any contained applications, Application Users, etc.
DangerThis action cannot be reversed! You will lose access to ALL applications and Application Users within the deleted project.