Skip to content

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.

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 os
from alter_sdk import App
from 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()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand List custom roles — response body

Referenced models: List custom roles — response body

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.

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"]

Official provider source

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.