Ramp: Role schemas
3 Ramp schemas with complete fields and constraints.
← Role operations · All schemas
List custom roles — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | Custom roles for the business. |
data[] | Model | Each item | Expand List custom roles — response body — data item |
Referenced models: List custom roles — response body — data item
List custom roles — response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
base_role | string | Required within parent | System role this custom role is based on. |
description | JSON | Required within parent | |
description (anyOf 1) | string | Alternative | Description of the custom role. |
description (anyOf 2) | null | Alternative | |
id | string | Required within parent | Unique identifier of the custom role. Format: uuid |
name | string | Required within parent | Display name of the custom role. |
product_capabilities | array | Required within parent | Product capabilities enabled for the custom role. |
product_capabilities[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
access | JSON | Required within parent | |
access (anyOf 1) | string | Alternative | Access level granted for the product capability, or null when the capability does not use access levels. |
access (anyOf 2) | null | Alternative | |
description | string | Required within parent | Description of the product capability. |
name | string | Required within parent | Name of the product capability. |