Remove Organizations

POST/api/v2/filesystem/projects/{projectRid}/removeOrganizations

Warning

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.

Path parameters

projectRid

string

The unique resource identifier (RID) of a Project.

Query parameters

preview

boolean

optional

Enables the use of preview functionality.

Request body

RemoveOrganizationsRequest

object

Hide child attributes

organizationRids

list<OrganizationRid>

optional

Show child attributes

Examples

Request

Copied!

curl -X POST \
	-H "Content-type: application/json" \
	-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 responses

Error Name
`RemoveOrganizationsPermissionDenied`	Error Code	`PERMISSION_DENIED`
	Status Code	403
	Description	Could not removeOrganizations the Project.
	Parameters	`projectRid`

See Errors for a general overview of errors in the platform.