Skip to content

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.

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 os
from alter_sdk import App
from 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()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
bodyobjectRequired within parent
body.dataModelRequired within parentExpand Create an access request — request body — body data

Referenced models: Create an access request — request body — body data

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

FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)objectAll variants apply
$ (allOf 1).dataModelOptionalExpand Create an access request — response body — data data — Access Request Response
$ (allOf 2)ModelAll variants applyExpand 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

Create an access request — request body — body data
FieldTypePresenceDescription and constraints
$objectRootA request to create shareable access for a user.
targetstringRequired within parentThe access requestable object that the user is requesting access to. This is the gid of the target. Supports projects and portfolios.
messageJSONOptional
message (anyOf 1)stringAlternativeThe optional message to include with the access request. This can be used to provide context or additional information about the request.
message (anyOf 2)nullAlternative
Create an access request — response body — data data — Access Request Response
FieldTypePresenceDescription and constraints
$objectRootA *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.
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
messagestringOptionalThe message included in the access request, if any.
approval_statusstringOptionalThe current approval status of the request.
Known values: pending, approved, denied
requesterModelOptionalExpand Get users in a team — response body — data data item
The user who made the access request.
Read only: true
targetModelOptionalExpand 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
FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand 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
FieldTypePresenceDescription and constraints
$objectRootA *target id* object represents the target resource that the requester wants access to.
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
Get users in a team — response body — data data item
FieldTypePresenceDescription and constraints
$objectRootA *user* object represents an account in Asana that can be given access to various workspaces, projects, and tasks.
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
namestringOptional*Read-only except when same user as requester*. The user's name.
Create an access request — response body — data data — sdk__Access Request Response
FieldTypePresenceDescription and constraints
$objectRootA 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.
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
messagestringOptionalThe message included in the access request, if any.
approval_statusstringOptionalThe current approval status of the request.
Known values: pending, approved, denied
requesterModelOptionalExpand Get a timesheet approval status — response body — data data user
targetModelOptionalExpand 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
FieldTypePresenceDescription and constraints
$objectRootA 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
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
namestringOptional*Read-only except when same user as requester*. The user's name.
Create an access request — response body — data data target — shared_target_da37ff781a99
FieldTypePresenceDescription and constraints
$objectRootA 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
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true

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.

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.