share_grants

Create a new share grant

post/api/v1beta/share-grants

Request

  • The document declares no server URL.
  • Auth: bearer_auth (a scheme the document does not define)

Request body

resource_idstring required

The ID of the resource to share

resource_typestring required

The type of resource to share (e.g., "assistant")

rolestring required

The role to grant ("viewer" or "editor")

subject_idstring required

The ID of the subject to grant access to. Organization-wide grants use "organization".

subject_id_typestring required

The type of subject ID (e.g., "id", "organization_group_id", or "organization_id")

subject_typestring required

The type of subject to grant access to (e.g., "user", "organization_group", or "organization")

Response

Successfully created the share grant

created_atstring date-time required

When this share grant was created

idstring required

The unique ID of the share grant

resource_idstring required

The ID of the resource being shared

resource_typestring required

The type of resource being shared (e.g., "assistant")

rolestring required

The role being granted ("viewer" or "editor")

subject_idstring required

The ID of the subject being granted access. Organization-wide grants use "organization".

subject_id_typestring required

The type of subject ID (e.g., "id", "organization_group_id", or "organization_id")

subject_typestring required

The type of subject being granted access (e.g., "user", "organization_group", or "organization")

updated_atstring date-time required

When this share grant was last updated

Changes

No recorded changes to this operation across all 52 revisions of this API.