Skip to main content

Restricted Sharing Group

View as Markdown

RestrictedSharingGroup object​

A RestrictedSharingGroup is a workspace group whose members cannot grant or revoke permissions on workspace assets while they have assumed the group or one of its child groups. Users acting as themselves are not affected.

namestringBetaIDImmutable

The resource name of the restricted sharing group. Format: restricted-sharing-groups/{restricted_sharing_group_id} Example: restricted-sharing-groups/123

restricted_sharing_group_idstringBetaOutput only

The id of the restricted workspace group: the numeric id of an existing and non-system workspace group.

group_display_namestringBetaOutput only

The display name of the restricted workspace group.

Get a restricted sharing group Beta​

GET /api/2.0/access-control/{name=restricted-sharing-groups/*}

Gets a restricted sharing group in the workspace. Use it to check whether a group is on the workspace's restricted list. Requires workspace admin.

API scopes: access-management

Parameters​

namestringRequiredpath

The name of the restricted sharing group to get. Format: restricted-sharing-groups/{restricted_sharing_group_id}

Response​

Returns the RestrictedSharingGroup object.

List restricted sharing groups Beta​

GET /api/2.0/access-control/restricted-sharing-groups

Lists the restricted sharing groups in the workspace. Requires workspace admin.

API scopes: access-management

Parameters​

page_sizeint32query

The maximum number of groups to return. The service may return fewer. If unspecified or 0, at most 100 groups are returned. Values above 100 are coerced to 100. Negative values are rejected.

page_tokenstringquery

A page token from a previous ListRestrictedSharingGroups call. Provide this to retrieve the subsequent page.

Response​

Returns a list of RestrictedSharingGroup objects.

Create a restricted sharing group Beta​

POST /api/2.0/access-control/restricted-sharing-groups

Adds a group to the workspace's restricted list. The workspace allows at most 100 restricted sharing groups. Requires workspace admin.

API scopes: access-management

Parameters​

restricted_sharing_group_idstringRequiredquery

The id of the workspace group to restrict: the numeric id of an existing and non-system workspace group.

Request body​

The restricted sharing group to create. It has no client-set fields; the group is identified by restricted_sharing_group_id.

namestringIDImmutable

The resource name of the restricted sharing group. Format: restricted-sharing-groups/{restricted_sharing_group_id} Example: restricted-sharing-groups/123

Response​

Returns the RestrictedSharingGroup object.

Delete a restricted sharing group Beta​

DELETE /api/2.0/access-control/{name=restricted-sharing-groups/*}

Removes a group from the workspace's restricted list. Requires workspace admin.

API scopes: access-management

Parameters​

namestringRequiredpath

The name of the restricted sharing group to delete. Format: restricted-sharing-groups/{restricted_sharing_group_id}