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.
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["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 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.workspaces.add_user_for_workspace(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.workspace_gid | string | Required within parent | |
query | object | Optional | Additional keys: not allowed |
query.opt_pretty | boolean | Optional | |
query.opt_fields | array | Optional | |
query.opt_fields[] | string | Each item | One of: email, name, photo, photo.image_1024x1024, photo.image_128x128, photo.image_21x21, photo.image_27x27, photo.image_36x36, photo.image_60x60 |
body | object | Required within parent | |
body.data | Model | Optional | Expand Add a user to a team — request body — body data |
Referenced models: Add a user to a team — 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 Add a user to a workspace or organization — response body — data data — User Base Response |
$ (allOf 2) | Model | All variants apply | Expand 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
Schemas
Section titled “Schemas”Add a user to a workspace or organization — response body — data data — User Base Response
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (allOf 1) | Model | All variants apply | Expand Get users in a team — response body — data data item |
$ (allOf 2) | object | All variants apply | |
$ (allOf 2).email | string | Optional | The user's email address. Format: email Read only: true |
$ (allOf 2).photo | JSON | Optional | |
$ (allOf 2).photo (anyOf 1) | Model | Alternative | Expand 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) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A user identification object for specification with the addUser/removeUser endpoints. |
user | string | Optional | A 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
| 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. |
Get a user — response body — data data photo image 1024x1024, image 128x128, image 21x21, image 27x27, image 36x36, image 60x60
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A 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_21x21 | string | Optional | PNG image of the user at 21x21 pixels. Format: uri |
image_27x27 | string | Optional | PNG image of the user at 27x27 pixels. Format: uri |
image_36x36 | string | Optional | PNG image of the user at 36x36 pixels. Format: uri |
image_60x60 | string | Optional | PNG image of the user at 60x60 pixels. Format: uri |
image_128x128 | string | Optional | PNG image of the user at 128x128 pixels. Format: uri |
image_1024x1024 | string | Optional | JPEG 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
| 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. |
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. |
email | string | Optional | The user's email address. Format: email Read only: true |
photo | JSON | Optional | |
photo (anyOf 1) | Model | Alternative | Expand Get a user — response body — data data photo image 1024x1024, image 128x128, image 21x21, image 27x27, image 36x36, image 60x60 |
photo (anyOf 2) | null | Alternative |
Referenced models: Get a user — response body — data data photo image 1024x1024, image 128x128, image 21x21, image 27x27, image 36x36, image 60x60
Policy, approvals and errors
Section titled “Policy, approvals and errors”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.