Skip to content

Asana: Add a user to a workspace or organization

Asana workspaces.addUserForWorkspace: arguments, response, policy and SDK examples.

← Workspaces operations · Get started

Operation asana.adduserforworkspace

Provider route: POST /workspaces/{workspace_gid}/addUser. 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["workspaces"]["addUserForWorkspace"]>[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.workspaces.addUserForWorkspace(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.workspaces.add_user_for_workspace(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.workspace_gidstringRequired within parent
queryobjectOptionalAdditional keys: not allowed
query.opt_prettybooleanOptional
query.opt_fieldsarrayOptional
query.opt_fields[]stringEach itemOne of: email, name, photo, photo.image_1024x1024, photo.image_128x128, photo.image_21x21, photo.image_27x27, photo.image_36x36, photo.image_60x60
bodyobjectRequired within parent
body.dataModelOptionalExpand Add a user to a team — request body — body data

Referenced models: Add a user to a team — 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 Add a user to a workspace or organization — response body — data data — User Base Response
$ (allOf 2)ModelAll variants applyExpand Add a user to a workspace or organization — response body — data

Referenced models: Add a user to a workspace or organization — response body — data data — User Base Response, Add a user to a workspace or organization — response body — data

Add a user to a workspace or organization — response body — data data — User Base Response
FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand Get users in a team — response body — data data item
$ (allOf 2)objectAll variants apply
$ (allOf 2).emailstringOptionalThe user's email address.
Format: email
Read only: true
$ (allOf 2).photoJSONOptional
$ (allOf 2).photo (anyOf 1)ModelAlternativeExpand Get a user — response body — data data photo image 1024x1024, image 128x128, image 21x21, image 27x27, image 36x36, image 60x60
$ (allOf 2).photo (anyOf 2)nullAlternative

Referenced models: Get users in a team — response body — data data item, Get a user — response body — data data photo image 1024x1024, image 128x128, image 21x21, image 27x27, image 36x36, image 60x60

Add a user to a workspace or organization — response body — data
FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Add a user to a workspace or organization — response body — data data — sdk__User Base Response

Referenced models: Add a user to a workspace or organization — response body — data data — sdk__User Base Response

Add a user to a team — request body — body data
FieldTypePresenceDescription and constraints
$objectRootA user identification object for specification with the addUser/removeUser endpoints.
userstringOptionalA string identifying a user. This can either be the string "me", an email, or the gid of a user.
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.
Get a user — response body — data data photo image 1024x1024, image 128x128, image 21x21, image 27x27, image 36x36, image 60x60
FieldTypePresenceDescription and constraints
$objectRootA map of the user's profile photo in various sizes, or null if no photo is set. Sizes provided are 21, 27, 36, 60, 128, and 1024. All images are in PNG format, except for 1024 (which is in JPEG format).
Read only: true
image_21x21stringOptionalPNG image of the user at 21x21 pixels.
Format: uri
image_27x27stringOptionalPNG image of the user at 27x27 pixels.
Format: uri
image_36x36stringOptionalPNG image of the user at 36x36 pixels.
Format: uri
image_60x60stringOptionalPNG image of the user at 60x60 pixels.
Format: uri
image_128x128stringOptionalPNG image of the user at 128x128 pixels.
Format: uri
image_1024x1024stringOptionalJPEG image of the user at 1024x1024 pixels.
Format: uri
Add a user to a workspace or organization — response body — data data — sdk__User Base Response
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.
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.
emailstringOptionalThe user's email address.
Format: email
Read only: true
photoJSONOptional
photo (anyOf 1)ModelAlternativeExpand Get a user — response body — data data photo image 1024x1024, image 128x128, image 21x21, image 27x27, image 36x36, image 60x60
photo (anyOf 2)nullAlternative

Referenced models: Get a user — response body — data data photo image 1024x1024, image 128x128, image 21x21, image 27x27, image 36x36, image 60x60

SDK function policy ID: asana.adduserforworkspace. Catalog operation: asana:addUserForWorkspace. 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.