Asana: Create an access request
Asana accessRequests.createAccessRequest: arguments, response, policy and SDK examples.
← Access requests operations · Get started
Operation asana.createaccessrequest
Provider route: POST /access_requests. 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["accessRequests"]["createAccessRequest"]>[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.accessRequests.createAccessRequest(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.access_requests.create_access_request(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
body | object | Required within parent | |
body.data | Model | Required within parent | Expand Create an access request — request body — body data |
Referenced models: Create an access request — request body — body data
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 | Model | Optional | Expand Create an access request — response body — data data — Access Request Response |
$ (allOf 2) | Model | All variants apply | Expand Create an access request — response body — data |
Referenced models: Create an access request — response body — data data — Access Request Response, Create an access request — response body — data
Schemas
Section titled “Schemas”Create an access request — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A request to create shareable access for a user. |
target | string | Required within parent | The access requestable object that the user is requesting access to. This is the gid of the target. Supports projects and portfolios. |
message | JSON | Optional | |
message (anyOf 1) | string | Alternative | The optional message to include with the access request. This can be used to provide context or additional information about the request. |
message (anyOf 2) | null | Alternative |
Create an access request — response body — data data — Access Request Response
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A *access request* object represents a request to access a shareable resource within Asana. It includes the requester's information, approval status, and target resource details. |
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 |
message | string | Optional | The message included in the access request, if any. |
approval_status | string | Optional | The current approval status of the request. Known values: pending, approved, denied |
requester | Model | Optional | Expand Get users in a team — response body — data data item The user who made the access request. Read only: true |
target | Model | Optional | Expand Create an access request — response body — data data target — Access Request Target Id Compact The target resource that the requester wants access to. Read only: true |
Referenced models: Create an access request — response body — data data target — Access Request Target Id Compact, Get users in a team — response body — data data item
Create an access request — response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Create an access request — response body — data data — sdk__Access Request Response |
Referenced models: Create an access request — response body — data data — sdk__Access Request Response
Create an access request — response body — data data target — Access Request Target Id Compact
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A *target id* object represents the target resource that the requester wants access to. |
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 |
Get users in a team — response body — data data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A *user* object represents an account in Asana that can be given access to various workspaces, projects, and tasks. |
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 | *Read-only except when same user as requester*. The user's name. |
Create an access request — response body — data data — sdk__Access Request 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 *access request* object represents a request to access a shareable resource within Asana. It includes the requester's information, approval status, and target resource details. |
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 |
message | string | Optional | The message included in the access request, if any. |
approval_status | string | Optional | The current approval status of the request. Known values: pending, approved, denied |
requester | Model | Optional | Expand Get a timesheet approval status — response body — data data user |
target | Model | Optional | Expand Create an access request — response body — data data target — shared_target_da37ff781a99 |
Referenced models: Get a timesheet approval status — response body — data data user, Create an access request — response body — data data target — shared_target_da37ff781a99
Get a timesheet approval status — response body — data data user
| 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 *user* object represents an account in Asana that can be given access to various workspaces, projects, and tasks. 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 | *Read-only except when same user as requester*. The user's name. |
Create an access request — response body — data data target — shared_target_da37ff781a99
| 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 *target id* object represents the target resource that the requester wants access to. 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 |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: asana.createaccessrequest. Catalog operation: asana:createAccessRequest. 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.