Skip to main content
POST
Check user permissions on a resource

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Headers

x-account-id
string
required

The account identifier

Prefer
string

Set to "heartbeat" to enable keep-alive newline heartbeats during long-running requests. Response includes Preference-Applied: heartbeat header when honored. (RFC 7240)

Example:

"heartbeat"

Body

application/json
resource_id
string
required

Resource identifier — can be a StackOne composite ID (c28xIQ... prefix) or a plain provider ID

Example:

"C08G6QB90LU"

user_id
string | null

User identifier — can be a StackOne composite ID (encoded prefix) or a plain provider user ID (e.g. Slack U08FW4R4N6S). At least one of user_id or email is required.

Example:

"U08FW4R4N6S"

email
string | null

User email address. At least one of user_id or email is required.

Example:

"user@company.com"

resource_type
string | null

Resource type (e.g. channel, workspace, file). When omitted, connector may infer from resource_id.

Example:

"channel"

action
enum<string> | null

Permission action to check

Available options:
read,
write,
comment,
delete,
export,
null
Example:

"read"

Response

Permission check result

data
object | null

Permission check result data