Asana: Get multiple roles
Asana roles.getRoles: arguments, response, policy and SDK examples.
← Roles operations · Get started
Operation asana.getroles
Provider route: GET /roles. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/asana with npm, or alter-sdk-asana with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { AsanaIntegration } from "@alter-ai/asana";
async function execute(input: Parameters<AsanaIntegration["roles"]["getRoles"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new AsanaIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.roles.getRoles(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_asana import AsanaIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = AsanaIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.roles.get_roles(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
query | object | Required within parent | Additional keys: not allowed |
query.opt_pretty | boolean | Optional | |
query.limit | integer | Optional | Minimum: 1 Maximum: 100 |
query.offset | string | Optional | |
query.workspace | string | Required within parent | |
query.archived | boolean | Optional | |
query.opt_fields | array | Optional | |
query.opt_fields[] | string | Each item | One of: base_role_type, creation_time, description, is_standard_role, modified_at, name, offset, path, permissions, permissions.allowed_guest_invites, permissions.assign_roles, permissions.create_and_edit_ai_automations, permissions.create_and_edit_ai_teammates, permissions.create_app_authorization, permissions.create_global_custom_fields, permissions.create_goal, permissions.create_pat_authorization, permissions.create_portfolio, permissions.create_project, permissions.create_read_only_link, permissions.create_team, permissions.download_mobile_attachments, permissions.export_project_data, permissions.import_data, permissions.manage_roles, permissions.proactive_ai, permissions.share_goal_with_domain, permissions.share_portfolios_with_org, permissions.share_teams_with_org, permissions.standard_ai, permissions.task_deletion_policy, permissions.upload_attachments, permissions.view_public_teams, permissions.view_shared_with_org_portfolios, permissions.view_shared_with_org_projects, permissions.view_shared_with_org_tasks, uri, workspace, workspace.name |
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 |
|---|---|---|---|
$ | JSON | Root | |
$ (allOf 1) | object | All variants apply | |
$ (allOf 1).data | array | Optional | |
$ (allOf 1).data[] | Model | Each item | Expand Get multiple roles — response body — data, next page data item |
$ (allOf 1).next_page | Model | Optional | Expand Get goals — response body — data, next page next page |
$ (allOf 2) | Model | All variants apply | Expand Get multiple roles — response body — data, next page |
Referenced models: Get goals — response body — data, next page next page, Get multiple roles — response body — data, next page data item, Get multiple roles — response body — data, next page
Schemas
Section titled “Schemas”Get goals — response body — data, next page next page
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | object | Alternative | *Conditional*. This property is only present when a limit query parameter is provided in the request. When making a paginated request, the API will return a number of results as specified by the limit parameter. If more results exist, then the response will contain a next_page attribute, which will include an offset, a relative path attribute, and a full uri attribute. If there are no more pages available, next_page will be null and no offset will be provided. Note that an offset token will expire after some time, as data may have changed. |
$ (anyOf 1).offset | string | Optional | Pagination offset for the request. Read only: true |
$ (anyOf 1).path | string | Optional | A relative path containing the query parameters to fetch for next_page Read only: true |
$ (anyOf 1).uri | string | Optional | A full uri containing the query parameters to fetch for next_page Format: uri Read only: true |
$ (anyOf 2) | null | Alternative |
Get multiple roles — response body — data, next page data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A *role* represents a group of permissions that can be assigned to a user or team. |
gid | string | Optional | Globally unique identifier of the resource, as a string. Read only: true |
resource_type | string | Optional | The base type of this resource. Read only: true |
name | string | Optional | The name of the role. |
description | string | Optional | The description of the role. |
is_standard_role | boolean | Optional | Whether the role is a standard role or a custom role. Defaults to `false`. |
Get multiple roles — response body — data, next page
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | |
data[] | Model | Each item | Expand Get a role — response body — data data — sdk__Rbac Role Response |
next_page | Model | Optional | Expand Get goals — response body — data, next page next page |
Referenced models: Get goals — response body — data, next page next page, Get a role — response body — data data — sdk__Rbac Role Response
Get a role — response body — data data — sdk__Rbac Role Response
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier. A *role* represents a group of permissions that can be assigned to a user or team. |
gid | string | Optional | Globally unique identifier of the resource, as a string. Read only: true |
resource_type | string | Optional | The base type of this resource. Read only: true |
name | string | Optional | The name of the role. |
description | string | Optional | The description of the role. |
is_standard_role | boolean | Optional | Whether the role is a standard role or a custom role. Defaults to `false`. |
creation_time | string | Optional | The time at which this role was created. Format: date-time Read only: true |
modified_at | string | Optional | The time at which this role was last modified. Read only: true Format: date-time |
base_role_type | string | Optional | The base role type of the role. Known values: guest, member, admin, super_admin, csm |
permissions | Model | Optional | Expand Get a role — response body — data data permissions |
workspace | Model | Optional | Expand Get a role — response body — data data workspace |
Referenced models: Get a role — response body — data data permissions, Get a role — response body — data data workspace
Get a role — response body — data data permissions
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The permissions of the role. |
create_app_authorization | boolean | Optional | Controls whether users with this role can create app authorizations |
create_pat_authorization | boolean | Optional | Controls whether users with this role can create PAT authorizations |
share_goal_with_domain | boolean | Optional | Controls whether users with this role can create company-wide goals |
share_portfolios_with_org | boolean | Optional | Controls whether users with this role can create portfolios that are shared with the organization and share existing portfolios to the organization |
assign_roles | boolean | Optional | Controls whether users with this role can assign guest, member, and admin roles to other users |
manage_roles | boolean | Optional | Controls whether users with this role can create, edit, and delete roles |
export_project_data | boolean | Optional | Controls whether users with this role can export project data |
task_deletion_policy | string | Optional | Determines what tasks users with this role are allowed to delete Known values: all, owned, none |
download_mobile_attachments | boolean | Optional | Controls whether users with this role can download attachments from mobile app |
import_data | boolean | Optional | Controls whether users with this role can import data into the domain |
create_global_custom_fields | boolean | Optional | Controls whether users with this role can create global custom fields |
upload_attachments | boolean | Optional | Controls whether users with this role can upload attachments |
create_team | boolean | Optional | Controls whether users with this role can create teams |
allowed_guest_invites | string | Optional | Controls what type of email users with this role are allowed to invite Known values: all, none |
create_and_edit_ai_automations | boolean | Optional | Controls whether users with this role can create and edit AI automations |
proactive_ai | boolean | Optional | Controls whether users with this role can use proactive AI features |
standard_ai | boolean | Optional | Controls whether users with this role can use standard AI features |
create_and_edit_ai_teammates | boolean | Optional | Controls whether users with this role can create and edit AI teammates |
share_teams_with_org | boolean | Optional | Controls whether users with this role can share teams with the organization |
create_goal | boolean | Optional | Controls whether users with this role can create goals |
create_project | boolean | Optional | Controls whether users with this role can create projects |
create_read_only_link | boolean | Optional | Controls whether users with this role can create read-only links |
create_portfolio | boolean | Optional | Controls whether users with this role can create portfolios |
view_public_teams | boolean | Optional | Controls whether users with this role can view public teams |
view_shared_with_org_projects | boolean | Optional | Controls whether users with this role can view projects shared with the organization |
view_shared_with_org_tasks | boolean | Optional | Controls whether users with this role can view tasks shared with the organization |
view_shared_with_org_portfolios | boolean | Optional | Controls whether users with this role can view portfolios shared with the organization |
Get a role — response body — data data workspace
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier. A *workspace* is the highest-level organizational unit in Asana. All projects and tasks have an associated workspace.A generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier. A *workspace* is the highest-level organizational unit in Asana. All projects and tasks have an associated workspace. *Create-only*. The workspace this role is associated with. Once created, roles cannot be moved to a different workspace. This attribute can only be specified at creation time. Read only: true |
gid | string | Optional | Globally unique identifier of the resource, as a string. Read only: true |
resource_type | string | Optional | The base type of this resource. Read only: true |
name | string | Optional | The name of the workspace. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: asana.getroles. Catalog operation: asana:getRoles. 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: ["roles:read"]