ADMINISTRATIONWorkspace

Share Workspace Resource

Grants a role on a workspace resource to a user or a group. It overrides any existing role this user/service account/group/workspace api key has on the resource. To target a user or service account, pass only the user email. The user must be in your workspace. To target a group, pass only the group id. To target a workspace api key, pass the api key id. The resource will be shared with the service account associated with the api key. You must have admin access to the resource to share it.

Path parameters

resource_idstringRequired

The ID of the target resource.

Headers

xi-api-keystringOptional

Request

This endpoint expects an object.
roleenumRequired

Role to update the target principal with.

Allowed values:
resource_typeenumRequired

Resource type of the target resource.

user_emailstringOptional

The email of the user or service account.

group_idstringOptional

The ID of the target group. To target the permissions principals have by default on this resource, use the value ‘default’.

workspace_api_key_idstringOptional

The ID of the target workspace API key. This isn’t the same as the key itself that would you pass in the header for authentication. Workspace admins can find this in the workspace settings UI.

Response

Successful Response

Errors