Ramp: List custom roles
Ramp role.getRolesResource: arguments, response, policy and SDK examples.
← Role operations · Get started
Operation ramp.get_roles_resource
Provider route: GET /developer/v1/roles. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/ramp with npm, or alter-sdk-ramp with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { RampIntegration } from "@alter-ai/ramp";
async function execute(input: Parameters<RampIntegration["role"]["getRolesResource"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new RampIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.role.getRolesResource(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_ramp import RampIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = RampIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.role.get_roles_resource(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand List custom roles — response body |
Referenced models: List custom roles — response body
Schemas
Section titled “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. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: ramp.get_roles_resource. Catalog operation: get_roles_resource. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.
Required provider scopes: ["users:read"]