Skip to content

Asana: Roles schemas

12 Asana schemas with complete fields and constraints.

← Roles operations · All schemas

Create a role — request body — body / data / base_role_type: guest, member, admin, super admin, csm

FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand Get multiple roles — response body — data, next page data item
$ (allOf 2)objectAll variants apply
$ (allOf 2).creation_timestringOptionalThe time at which this role was created.
Format: date-time
Read only: true
$ (allOf 2).modified_atstringOptionalThe time at which this role was last modified.
Read only: true
Format: date-time
$ (allOf 2).base_role_typestringOptionalThe base role type of the role.
One of: guest, member, admin, super_admin, csm
$ (allOf 2).permissionsModelOptionalExpand Create a role — request body — body / data / base_role_type: guest, member, admin, super admin, csm base role type: guest, member, admin, super admin, csm permissions

Referenced models: Get multiple roles — response body — data, next page data item, Create a role — request body — body / data / base_role_type: guest, member, admin, super admin, csm base role type: guest, member, admin, super admin, csm permissions

Create a role — request body — body / data / base_role_type: guest, member, admin, super admin, csm base role type: guest, member, admin, super admin, csm permissions

FieldTypePresenceDescription and constraints
$objectRootThe permissions of the role.
create_app_authorizationbooleanOptionalControls whether users with this role can create app authorizations
create_pat_authorizationbooleanOptionalControls whether users with this role can create PAT authorizations
share_goal_with_domainbooleanOptionalControls whether users with this role can create company-wide goals
share_portfolios_with_orgbooleanOptionalControls whether users with this role can create portfolios that are shared with the organization and share existing portfolios to the organization
assign_rolesbooleanOptionalControls whether users with this role can assign guest, member, and admin roles to other users
manage_rolesbooleanOptionalControls whether users with this role can create, edit, and delete roles
export_project_databooleanOptionalControls whether users with this role can export project data
task_deletion_policystringOptionalDetermines what tasks users with this role are allowed to delete
One of: all, owned, none
download_mobile_attachmentsbooleanOptionalControls whether users with this role can download attachments from mobile app
import_databooleanOptionalControls whether users with this role can import data into the domain
create_global_custom_fieldsbooleanOptionalControls whether users with this role can create global custom fields
upload_attachmentsbooleanOptionalControls whether users with this role can upload attachments
create_teambooleanOptionalControls whether users with this role can create teams
allowed_guest_invitesstringOptionalControls what type of email users with this role are allowed to invite
One of: all, none
create_and_edit_ai_automationsbooleanOptionalControls whether users with this role can create and edit AI automations
proactive_aibooleanOptionalControls whether users with this role can use proactive AI features
standard_aibooleanOptionalControls whether users with this role can use standard AI features
create_and_edit_ai_teammatesbooleanOptionalControls whether users with this role can create and edit AI teammates
share_teams_with_orgbooleanOptionalControls whether users with this role can share teams with the organization
create_goalbooleanOptionalControls whether users with this role can create goals
create_projectbooleanOptionalControls whether users with this role can create projects
create_read_only_linkbooleanOptionalControls whether users with this role can create read-only links
create_portfoliobooleanOptionalControls whether users with this role can create portfolios
view_public_teamsbooleanOptionalControls whether users with this role can view public teams
view_shared_with_org_projectsbooleanOptionalControls whether users with this role can view projects shared with the organization
view_shared_with_org_tasksbooleanOptionalControls whether users with this role can view tasks shared with the organization
view_shared_with_org_portfoliosbooleanOptionalControls whether users with this role can view portfolios shared with the organization

Create a role — request body — body data

FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand Create a role — request body — body / data / base_role_type: guest, member, admin, super admin, csm
$ (allOf 2)objectAll variants apply
$ (allOf 2).base_role_typestringRequired within parentThe base role type of the role.
One of: guest, member, admin
$ (allOf 2).workspacestringRequired within parent*Create-only*. The GID of 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.

Referenced models: Create a role — request body — body / data / base_role_type: guest, member, admin, super admin, csm

Get a role — request body — query

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
opt_prettybooleanOptional
opt_fieldsarrayOptional
opt_fields[]stringEach itemOne of: base_role_type, creation_time, description, is_standard_role, modified_at, name, 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, workspace, workspace.name

Get a role — response body — data

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Get a role — response body — data data — sdk__Rbac Role Response

Referenced models: Get a role — response body — data data — sdk__Rbac Role Response

Get a role — response body — data / data / base_role_type: guest, member, admin, super admin, csm

FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand Get multiple roles — response body — data, next page data item
$ (allOf 2)objectAll variants apply
$ (allOf 2).creation_timestringOptionalThe time at which this role was created.
Format: date-time
Read only: true
$ (allOf 2).modified_atstringOptionalThe time at which this role was last modified.
Read only: true
Format: date-time
$ (allOf 2).base_role_typestringOptionalThe base role type of the role.
Known values: guest, member, admin, super_admin, csm
$ (allOf 2).permissionsModelOptionalExpand Get a role — response body — data data permissions

Referenced models: Get multiple roles — response body — data, next page data item, Get a role — response body — data data permissions

Get a role — response body — data data permissions

FieldTypePresenceDescription and constraints
$objectRootThe permissions of the role.
create_app_authorizationbooleanOptionalControls whether users with this role can create app authorizations
create_pat_authorizationbooleanOptionalControls whether users with this role can create PAT authorizations
share_goal_with_domainbooleanOptionalControls whether users with this role can create company-wide goals
share_portfolios_with_orgbooleanOptionalControls whether users with this role can create portfolios that are shared with the organization and share existing portfolios to the organization
assign_rolesbooleanOptionalControls whether users with this role can assign guest, member, and admin roles to other users
manage_rolesbooleanOptionalControls whether users with this role can create, edit, and delete roles
export_project_databooleanOptionalControls whether users with this role can export project data
task_deletion_policystringOptionalDetermines what tasks users with this role are allowed to delete
Known values: all, owned, none
download_mobile_attachmentsbooleanOptionalControls whether users with this role can download attachments from mobile app
import_databooleanOptionalControls whether users with this role can import data into the domain
create_global_custom_fieldsbooleanOptionalControls whether users with this role can create global custom fields
upload_attachmentsbooleanOptionalControls whether users with this role can upload attachments
create_teambooleanOptionalControls whether users with this role can create teams
allowed_guest_invitesstringOptionalControls what type of email users with this role are allowed to invite
Known values: all, none
create_and_edit_ai_automationsbooleanOptionalControls whether users with this role can create and edit AI automations
proactive_aibooleanOptionalControls whether users with this role can use proactive AI features
standard_aibooleanOptionalControls whether users with this role can use standard AI features
create_and_edit_ai_teammatesbooleanOptionalControls whether users with this role can create and edit AI teammates
share_teams_with_orgbooleanOptionalControls whether users with this role can share teams with the organization
create_goalbooleanOptionalControls whether users with this role can create goals
create_projectbooleanOptionalControls whether users with this role can create projects
create_read_only_linkbooleanOptionalControls whether users with this role can create read-only links
create_portfoliobooleanOptionalControls whether users with this role can create portfolios
view_public_teamsbooleanOptionalControls whether users with this role can view public teams
view_shared_with_org_projectsbooleanOptionalControls whether users with this role can view projects shared with the organization
view_shared_with_org_tasksbooleanOptionalControls whether users with this role can view tasks shared with the organization
view_shared_with_org_portfoliosbooleanOptionalControls whether users with this role can view portfolios shared with the organization

Get a role — response body — data data workspace

FieldTypePresenceDescription and constraints
$objectRootA 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
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
namestringOptionalThe name of the workspace.

Get a role — response body — data data — Rbac Role Response

FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand Get a role — response body — data / data / base_role_type: guest, member, admin, super admin, csm
$ (allOf 2)objectAll variants apply
$ (allOf 2).workspaceJSONOptional
$ (allOf 2).workspace (allOf 1)ModelAll variants applyExpand Update a workspace — request body — body data
$ (allOf 2).workspace (allOf 2)objectAll variants apply*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

Referenced models: Get a role — response body — data / data / base_role_type: guest, member, admin, super admin, csm, Update a workspace — request body — body data

Get a role — response body — data data — sdk__Rbac Role Response

FieldTypePresenceDescription and constraints
$objectRootA 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.
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
namestringOptionalThe name of the role.
descriptionstringOptionalThe description of the role.
is_standard_rolebooleanOptionalWhether the role is a standard role or a custom role. Defaults to `false`.
creation_timestringOptionalThe time at which this role was created.
Format: date-time
Read only: true
modified_atstringOptionalThe time at which this role was last modified.
Read only: true
Format: date-time
base_role_typestringOptionalThe base role type of the role.
Known values: guest, member, admin, super_admin, csm
permissionsModelOptionalExpand Get a role — response body — data data permissions
workspaceModelOptionalExpand 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 multiple roles — response body — data, next page

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parent
data[]ModelEach itemExpand Get a role — response body — data data — sdk__Rbac Role Response
next_pageModelOptionalExpand 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 multiple roles — response body — data, next page data item

FieldTypePresenceDescription and constraints
$objectRootA *role* represents a group of permissions that can be assigned to a user or team.
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
namestringOptionalThe name of the role.
descriptionstringOptionalThe description of the role.
is_standard_rolebooleanOptionalWhether the role is a standard role or a custom role. Defaults to `false`.

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.