This endpoint is in preview and may be modified or removed at any time.
To use this endpoint, add preview=true
to the request query parameters.
Removes Organizations from a Project.
Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:filesystem-write
.
object
list<OrganizationRid>
1
2
3
4
5
curl -X POST \
\t-H "Content-type: application/json" \
\t-H "Authorization: Bearer $TOKEN" \
"https://$HOSTNAME/api/v2/filesystem/projects/ri.compass.main.folder.01a79a9d-e293-48db-a585-9ffe221536e8/removeOrganizations?preview=true" \
-d '{"organizationRids":["ri.multipass..organization.c30ee6ad-b5e4-4afe-a74f-fe4a289f2faa"]}'
Error Name | ||
---|---|---|
Organizations | Error Code | NOT_FOUND |
Status Code | 404 | |
Description | At least one organization RID could not be found. | |
Parameters | organizationRids | |
Organization | Error Code | INVALID_ARGUMENT |
Status Code | 400 | |
Description | An organization cannot be removed from a project if it would result in a project with no organizations under a space marked with an organization. | |
Parameters | organizationRids | |
Invalid | Error Code | INVALID_ARGUMENT |
Status Code | 400 | |
Description | Organizations on a project must also exist on the parent space. This error is thrown if the configuration of a project's organizations (on creation or subsequently) results in the project being marked with either no organizations in a marked space, or with an organization that is not present on the parent space. | |
Parameters | organizationRids | |
Remove | Error Code | PERMISSION_DENIED |
Status Code | 403 | |
Description | Could not removeOrganizations the Project. | |
Parameters | projectRid | |
Project | Error Code | NOT_FOUND |
Status Code | 404 | |
Description | The given Project could not be found. | |
Parameters | projectRid |
See Errors for a general overview of errors in the platform.