Skip to main content
GET
Python (SDK)

Authorizations

Authorization
string
header
required

Send Authorization: Bearer , using an MKA1 API key for automation or an OAuth API access token for a signed-in application. Use a dynamic security callback to refresh OAuth access tokens. Browser session-only operations still require their declared cookie.

Headers

X-On-Behalf-Of
string

Optional external end-user identifier forwarded by the API gateway.

Path Parameters

file_id
string
required

The ID of the file.

user_id
string
required

The principal: a member's user id, the end-user id a request is delegated to with X-On-Behalf-Of, or 'team' for the permission that applies to every member of the file's team.

Minimum string length: 1

Response

200 - application/json

OK

The effective permission of one principal on a file, with where it comes from.

object
any
required

The object type, which is always 'file.permission'.

file_id
string
required

The ID of the file.

grantee_type
enum<string>
required

Who the permission applies to: one principal (user), or every member of the resource's team (team).

Available options:
user,
team
user_id
string | null
required

The principal the permission applies to: a member's user id, or the end-user id a request is delegated to with X-On-Behalf-Of. null when the permission applies to the file's team.

role
enum<string> | null
required

The highest role the principal holds on the file, or null when it holds none.

Available options:
owner,
writer,
reader
source
enum<string>
required

Where the role comes from: the resource's owner, a permission held by this principal, the resource's team permission, or nothing — the principal reaches the resource only as an org admin of its team, if at all.

Available options:
owner,
grant,
team,
none