latestOpenAPI 3.0.32026-08-227451,2751.8 MB

d0fc0114da66

Authorization

Check whether an identity has access to a resource

Performs an authorization check on a resource

get/authorization/check

Query parameters

workspaceIdstring required

ID of the resource's workspace

resourceTypestring required

ID of the resource. Leave empty to authorize for the entire resource type

resourceIdstring

ID of the resource. Leave empty to authorize for the entire resource type

scope'read' | 'write' | 'list' | 'read_secret' | 'authorize' required

Scope of the authorization check

feature_flagsstring[]

Required feature flags

additional_scopesstring[]

Additional scope checks to perform (AND'd with the primary check). Each value is a resourceType:permission pair (e.g., artifacts:read).

Response

Result of the authorization check

grantedboolean

Whether the authorization check resulted in granted authorization

api_key_idstring

The verified id of the api key, if api key auth used

user_idstring

The verified user id if the authentication is user based