Delete a user with the APC API | Astronomer Documentation

The examples on this page show common ways to use the APC API — they’re not a complete API reference. For the full, interactive API documentation for your installation, including every available query, mutation, and type, go to https://houston.<your-base-domain>/v1, and click on the Docs tab. See Develop and test APC API queries for more on using the built-in GraphQL explorer.

To delete a user from Astro Private Cloud, you need:

System Admin permissions
The ID of the user to delete. To retrieve this, request the id value in a users query or run astro workspace user list.

The following query removes a user, then returns information about the deleted user.

1 mutation removeUser {
2 	removeUser (
3     id: "<user-id>"
4   ) {
5     uuid
6     emails {address}
7     status
8   }
9 }