Remove Resource Roles

POST/api/v2/filesystem/resources/{resourceRid}/roles/remove

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.

Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:filesystem-write.

Path parameters

resourceRid

string

The unique resource identifier (RID) of a Resource.

Query parameters

preview

boolean

optional

Enables the use of preview functionality.

Request body

RemoveResourceRolesRequest

object

Hide child attributes

roles

list<ResourceRole>

optional

Show child attributes

Examples

Request

Copied!

curl -X POST \
	-H "Content-type: application/json" \
	-H "Authorization: Bearer $TOKEN" \
	"https://$HOSTNAME/api/v2/filesystem/resources/ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da/roles/remove?preview=true" \
	-d '{"roles":[{"resourceRolePrincipal":{"type":"principalWithId","principalId":"f05f8da4-b84c-4fca-9c77-8af0b13d11de","principalType":"GROUP"},"roleId":"8bf49052-dc37-4528-8bf0-b551cfb71268"}]}'

Error responses

Error Name
`RemoveResourceRolesPermissionDenied`	Error Code	`PERMISSION_DENIED`
	Status Code	403
	Description	Could not remove the ResourceRole.
	Parameters	`resourceRid`
`ResourceNotFound`	Error Code	`NOT_FOUND`
	Status Code	404
	Description	The given Resource could not be found.
	Parameters	`resourceRid`

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