POST /workspaces/{workspace_gid}/removeUser
Remove a user from a workspace or organization.
The user making this call must be an admin in the workspace. The user can be referenced by their globally unique user ID or their email address.
When invoked using a Service Account Token (SAT), this endpoint follows the same behavior as the SCIM API Delete endpoint. To learn more about how Asana handles user deprovisioning, refer to our Help Center article on deprovisioning users.
When invoked using a Personal Access Token (PAT), the endpoint behaves similarly, except that ownership of the user’s resources is transferred to the PAT owner instead of the admin specified in the Admin Console.
Note: If you wish to retain access to a user’s private resources (i.e., those visible only to that user), you have to make them public manually (or ask the user to do so) before removal.
Returns an empty data record.
Servers
- https://app.asana.com/api/1.0
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
workspace_gid |
String | Yes |
Globally unique identifier for the workspace or organization. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
opt_pretty |
Boolean | No |
Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
data |
Object | No |
A user identification object for specification with the addUser/removeUser endpoints. |
data.user |
String | No |
A string identifying a user. This can either be the string "me", an email, or the gid of a user. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.