Workspace Permissions

View as Markdown

Delete Workspace Permission AssignmentDELETE /api/2.0/accounts/{account_id}/workspaces/{workspace_id}/permissionassignments/principals/{principal_id}Update Workspace Permission AssignmentPUT /api/2.0/accounts/{account_id}/workspaces/{workspace_id}/permissionassignments/principals/{principal_id}

Delete Workspace Permission Assignment

DELETE /api/2.0/accounts/{account_id}/workspaces/{workspace_id}/permissionassignments/principals/{principal_id}

Deletes the workspace permissions assignment in a given account and workspace for the specified principal.

API scopes: access-management

Parameters

account_idstringpath

The account ID.

workspace_idint64path

The workspace ID for the account.

principal_idint64path

The ID of the user, service principal, or group.

View as Markdown

Response

{}

Update Workspace Permission Assignment

PUT /api/2.0/accounts/{account_id}/workspaces/{workspace_id}/permissionassignments/principals/{principal_id}

Creates or updates the workspace permissions assignment in a given account and workspace for the specified principal.

API scopes: access-management

Parameters

account_idstringpath

The account ID.

workspace_idint64path

The workspace ID.

principal_idint64path

The ID of the user, service principal, or group.

Request body

permissionsarray of string

Array of permissions assignments to update on the workspace. Valid values are "USER" and "ADMIN" (case-sensitive). If both "USER" and "ADMIN" are provided, "ADMIN" takes precedence. Other values will be ignored. Note that excluding this field, or providing unsupported values, will have the same effect as providing an empty list, which will result in the deletion of all permissions for the principal.

Values: UNKNOWN, USER, ADMIN

Response

principalobject

Information about the principal assigned to the workspace.

Show child attributesHide child attributes

user_namestringRequired

The username of the user. Present only if the principal is a user.

group_namestringRequired

The group name of the group. Present only if the principal is a group.

service_principal_namestringRequired

The name of the service principal. Present only if the principal is a service principal.

principal_idint64

The unique, opaque id of the principal.

display_namestring

The display name of the principal.

permissionsarray of string

The permissions level of the principal.

Values: UNKNOWN, USER, ADMIN

errorstring

Error response associated with a workspace permission assignment, if any.

View as Markdown

Request

{
  "permissions": [
    "string"
  ]
}

Response

{
  "principal": {
    "user_name": "string",
    "group_name": "string",
    "service_principal_name": "string",
    "principal_id": 0,
    "display_name": "string"
  },
  "permissions": [
    "string"
  ],
  "error": "string"
}