/v1/permissionItems/resolveEntityPermissions
—
post

Resolve entity permissions for specific targets and actions. This endpoint checks whether given entities have permission to perform specific actions on target resources. It considers both direct permissions and inherited permissions from permission groups. The response indicates the final access decision (grant/deny) and identifies which permission item and entity provided the access.

Path Parameters
Not Applicable
Request Headers
HttpEndpointRequestHeaders_AuthRequired_JsonContentType

FieldTypeRequiredDescription
AuthorizationstringYes

Access token

Example: Bearer <token>

Content-TypestringYes

HTTP JSON request content type

Example: application/json

Request Query
Not Applicable
Request Body
ResolveEntityPermissionsEndpointParams

Parameters for resolving entity permissions within a workspace.

{
workspaceId?: string
items: Array<ResolveEntityPermissionItemInput>
}
ResolveEntityPermissionItemInput

Input for resolving entity permissions. Used to check what permissions an entity has on specific resources.

{
targetId?: string | Array<string>
filepath?: string | Array<string>
folderpath?: string | Array<string>
workspaceRootname?: string
entityId: string | Array<string>
action: string | Array<string>
}
200 — Response Headers
HttpEndpointResponseHeaders_ContentType_ContentLength

FieldTypeRequiredDescription
Content-TypestringYes

HTTP JSON response content type

Example: application/json

Content-LengthstringYes

HTTP response content length in bytes

Example: 1024

200 — Response Body
ResolveEntityPermissionsEndpointResult

Response containing resolved permission items.

{
items: Array<ResolvedEntityPermissionItem>
}
ResolvedEntityPermissionItem

A resolved permission item showing whether an entity has access to perform a specific action on a target resource.

{
target: ResolvedEntityPermissionItemTarget
entityId: string
action: string
access: boolean
permittingEntityId?: string
permittingTargetId?: string
}
ResolvedEntityPermissionItemTarget

Represents the resolved target of a permission item, indicating what resource the permission applies to.

{
targetId?: string
filepath?: string
folderpath?: string
workspaceRootname?: string
}
4XX or 5XX — Response Headers
HttpEndpointResponseHeaders_ContentType_ContentLength

FieldTypeRequiredDescription
Content-TypestringYes

HTTP JSON response content type

Example: application/json

Content-LengthstringYes

HTTP response content length in bytes

4XX or 5XX — Response Body
EndpointErrorResult

Endpoint error result

{
errors?: Array<ExternalError>
}
ExternalError

{
message: string
}