Britive platform release 2026.09.02 is now live in production.

List permissions associated to a profile

Prev Next
Get
/api/resource-manager/profiles/{profileId}/permissions
Security
HTTP
Type bearer
Path parameters
profileId
stringRequired

Id of profile to add permission

Query parameters
filter
string

Parameter to filter permissions by name

Examplename eq permission1
searchText
string

Parameter to filter permission by search text

Exampletest
page
integer

Parameter to specify the page number of the records to retrieve

Default0
size
integer

Parameter to specify the number of records to retrieve per page

Default20
sort
string

parameter to specify the sort parameter and direction

Responses
200

permissions got retrieved successfully

Expand All
object
count
integer
page
integer
size
integer
sort
string
data
Array of object (ProfilePermissionDto)
object
permissionId
string
version
string

Permission version - latest, local or a number. Optional on update.

permissionName
string
description
string
resourceTypeId
string
resourceTypeName
string
variables
Array of object (VariableValues)

Bindings set on this profile - they override the permission's variableDefaults.

object

Variable binding on a profile-permission. Three mutually exclusive runtime resolution states encoded by (isSystemDefined, promptAtCheckout): Static (both false; value is literal); System-defined (isSystemDefined=true; server resolves at runtime); Prompt-at-checkout (promptAtCheckout=true; end user supplies at checkout via Settings.checkoutVariableValues). isSystemDefined=true AND promptAtCheckout=true is rejected (RM-0027). Sending a non-blank value in a state that resolves it at checkout is rejected (RM-0031) — see the value property.

name
string
value
string

Populated in the Static state, and in the System-defined state for type=String (the system template). Null for Prompt-at-checkout and for a System-defined type=password, both of which resolve the value at checkout. Sending a non-blank value in either of those two resolved states is rejected at attach and update (400 RM-0031) rather than silently dropped, so declarative clients do not see a permanent diff on the field. A blank value is accepted and normalized to null.

isSystemDefined
boolean

marks the System-defined state - value is server-generated for type=password (RM-0031), otherwise it must be a system defined value (RM-0037)

Defaultfalse
promptAtCheckout
boolean

Marks the Prompt-at-checkout state. Applies to any type, including String. The end user supplies the value at checkout, so a non-blank value on the binding is rejected (RM-0031). Mutually exclusive with isSystemDefined. Legacy records (no flag) are interpreted as promptAtCheckout=true iff type=password AND isSystemDefined=false.

Defaultfalse
type
string

Variable type, server-derived (read-only). Set at attach time from the permission's variable token — password when the permission declares the variable as name:password, otherwise String. Any value sent by the client is ignored and overwritten.

Valid values[ "String", "password" ]
regexPattern
string

Java-compatible regular expression constraining this variable's value (syntax-checked at attach time; 400 RM-0023 when invalid). For type=password: required in every state (RM-0022) — governs server-side generation (System-defined) and validation of user-supplied values (Prompt-at-checkout); a password must be system-defined or prompt-at-checkout (static rejected, RM-0028). For type=String: optional, and only valid with promptAtCheckout=true -- sending it in the system-defined or static state is rejected (400 RM-0032) rather than silently dropped, so declarative clients do not see a permanent diff on the field.

description
string

Optional human-readable explanation of regexPattern, shown to the end user at checkout so they understand what a valid value looks like. Valid only alongside a regexPattern (any type); sending it without one is rejected (400 RM-0033), keeping the two in lockstep.

effectiveVariables
Array of object (VariableValues)

Bindings used at checkout - profile variables merged over the permission's variableDefaults.

object

Variable binding on a profile-permission. Three mutually exclusive runtime resolution states encoded by (isSystemDefined, promptAtCheckout): Static (both false; value is literal); System-defined (isSystemDefined=true; server resolves at runtime); Prompt-at-checkout (promptAtCheckout=true; end user supplies at checkout via Settings.checkoutVariableValues). isSystemDefined=true AND promptAtCheckout=true is rejected (RM-0027). Sending a non-blank value in a state that resolves it at checkout is rejected (RM-0031) — see the value property.

name
string
value
string

Populated in the Static state, and in the System-defined state for type=String (the system template). Null for Prompt-at-checkout and for a System-defined type=password, both of which resolve the value at checkout. Sending a non-blank value in either of those two resolved states is rejected at attach and update (400 RM-0031) rather than silently dropped, so declarative clients do not see a permanent diff on the field. A blank value is accepted and normalized to null.

isSystemDefined
boolean

marks the System-defined state - value is server-generated for type=password (RM-0031), otherwise it must be a system defined value (RM-0037)

Defaultfalse
promptAtCheckout
boolean

Marks the Prompt-at-checkout state. Applies to any type, including String. The end user supplies the value at checkout, so a non-blank value on the binding is rejected (RM-0031). Mutually exclusive with isSystemDefined. Legacy records (no flag) are interpreted as promptAtCheckout=true iff type=password AND isSystemDefined=false.

Defaultfalse
type
string

Variable type, server-derived (read-only). Set at attach time from the permission's variable token — password when the permission declares the variable as name:password, otherwise String. Any value sent by the client is ignored and overwritten.

Valid values[ "String", "password" ]
regexPattern
string

Java-compatible regular expression constraining this variable's value (syntax-checked at attach time; 400 RM-0023 when invalid). For type=password: required in every state (RM-0022) — governs server-side generation (System-defined) and validation of user-supplied values (Prompt-at-checkout); a password must be system-defined or prompt-at-checkout (static rejected, RM-0028). For type=String: optional, and only valid with promptAtCheckout=true -- sending it in the system-defined or static state is rejected (400 RM-0032) rather than silently dropped, so declarative clients do not see a permanent diff on the field.

description
string

Optional human-readable explanation of regexPattern, shown to the end user at checkout so they understand what a valid value looks like. Valid only alongside a regexPattern (any type); sending it without one is rejected (400 RM-0033), keeping the two in lockstep.

404

Not Found