Get room access rights

GET /api/2.0/files/rooms/{id}/share

Request

Returns the access rights of a room with the ID specified in the request.

Authorization

An API key is a token that you provide when making API calls. Include the token in a cookie parameter called asc_auth_key.

Example: asc_auth_key=864FE52C-1C1C-469F-9308-51DAFEFE7436.

Headers

Acceptenum of string

Can be one of: application/json, text/json, text/plain.

Path

idintegerformat: int32required

Query

filterTypeone of

.enum of string

[UserOrGroup - User or group, InvitationLink - Invitation link, ExternalLink - External link, AdditionalExternalLink - Additional external link, PrimaryExternalLink - Primary external link, User - User, Group - Group]

Can be one of: UserOrGroup, InvitationLink, ExternalLink, AdditionalExternalLink, PrimaryExternalLink, User, Group.

.enum of integer

[0 - User or group, 1 - Invitation link, 2 - External link, 4 - Additional external link, 8 - Primary external link, 16 - User, 32 - Group]

Can be one of: 0, 1, 2, 4, 8, 16, 32.

Examples

GET /api/2.0/files/rooms/376/share HTTP/1.1
Accept: application/json
Host: example.com

curl --request GET \
  --url https://example.com/api/2.0/files/rooms/376/share \
  --header 'Accept: application/json'

Responses

200

Security information of room files

accessone of

.enum of string

[None - None, ReadWrite - Read and write, Read - Read, Restrict - Restrict, Varies - Varies, Review - Review, Comment - Comment, FillForms - Fill forms, CustomFilter - Custom filter, RoomAdmin - Room admin, Editing - Editing, PowerUser - Power user]

Can be one of: None, ReadWrite, Read, Restrict, Varies, Review, Comment, FillForms, CustomFilter, RoomAdmin, Editing, PowerUser.

.enum of integer

[0 - None, 1 - Read and write, 2 - Read, 3 - Restrict, 4 - Varies, 5 - Review, 6 - Comment, 7 - Fill forms, 8 - Custom filter, 9 - Room admin, 10 - Editing, 11 - Power user]

Can be one of: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11.

sharedTounknown

isLockedboolean

isOwnerboolean

canEditAccessboolean

subjectTypeone of

.enum of string

[User - User, ExternalLink - External link, Group - Group, InvitationLink - Invitation link, PrimaryExternalLink - Primary external link]

Can be one of: User, ExternalLink, Group, InvitationLink, PrimaryExternalLink.

.enum of integer

[0 - User, 1 - External link, 2 - Group, 3 - Invitation link, 4 - Primary external link]

Can be one of: 0, 1, 2, 3, 4.

401

Unauthorized

403

Forbidden