Skip to content

Ramp: Role schemas

3 Ramp schemas with complete fields and constraints.

← Role operations · All schemas

List custom roles — response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentCustom roles for the business.
data[]ModelEach itemExpand List custom roles — response body — data item

Referenced models: List custom roles — response body — data item

List custom roles — response body — data item

FieldTypePresenceDescription and constraints
$objectRoot
base_rolestringRequired within parentSystem role this custom role is based on.
descriptionJSONRequired within parent
description (anyOf 1)stringAlternativeDescription of the custom role.
description (anyOf 2)nullAlternative
idstringRequired within parentUnique identifier of the custom role.
Format: uuid
namestringRequired within parentDisplay name of the custom role.
product_capabilitiesarrayRequired within parentProduct capabilities enabled for the custom role.
product_capabilities[]ModelEach itemExpand List custom roles — response body — data item product capabilities item

Referenced models: List custom roles — response body — data item product capabilities item

List custom roles — response body — data item product capabilities item

FieldTypePresenceDescription and constraints
$objectRoot
accessJSONRequired within parent
access (anyOf 1)stringAlternativeAccess level granted for the product capability, or null when the capability does not use access levels.
access (anyOf 2)nullAlternative
descriptionstringRequired within parentDescription of the product capability.
namestringRequired within parentName of the product capability.

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.