Manage Workspace users with the APC API

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.

You can use the APC API to manage the users in a Workspace. These mutations require Workspace Admin permissions on the target Workspace. Each mutation requires a workspaceUuid, which you can retrieve by running astro workspace list or using the workspaces query. The role value must be one of WORKSPACE_ADMIN, WORKSPACE_EDITOR, or WORKSPACE_VIEWER.

Add a user to a Workspace

Use the workspaceAddUser mutation to add an existing user to a Workspace with a specified role.

mutation AddWorkspaceUser(
  $workspaceUuid: Uuid! = "<workspace-id>"
  $email: String! = "<user-email-address>"
  $role: Role! = WORKSPACE_VIEWER
) {
  workspaceAddUser(
    workspaceUuid: $workspaceUuid
    email: $email
    role: $role
  ) {
    id
    label
    users {
      id
      username
      roleBindings {
        role
      }
    }
  }
}

Update a user’s Workspace role

Use the workspaceUpsertUserRole mutation to change the role of a user who already belongs to a Workspace.

mutation UpdateWorkspaceUserRole(
  $workspaceUuid: Uuid! = "<workspace-id>"
  $email: String! = "<user-email-address>"
  $role: Role! = WORKSPACE_EDITOR
) {
  workspaceUpsertUserRole(
    workspaceUuid: $workspaceUuid
    email: $email
    role: $role
  )
}

Remove a user from a Workspace

Use the workspaceRemoveUser mutation to remove a user from a Workspace. Provide the workspaceUuid and the userUuid of the user to remove. To retrieve the userUuid, use the workspaceUsers query or a users query.

mutation RemoveWorkspaceUser(
  $workspaceUuid: Uuid! = "<workspace-id>"
  $userUuid: Uuid! = "<user-id>"
) {
  workspaceRemoveUser(
    workspaceUuid: $workspaceUuid
    userUuid: $userUuid
  ) {
    id
    label
    users {
      id
      username
    }
  }
}

⌘I

Overview

Architecture

Upgrade to Astro Private Cloud 2.0

Install Astro Private Cloud

Develop Dags

Airflow administration

Airflow 3

Deploy Dags

Manage Deployments

Platform administration

Manage Platform resources

Security and compliance

APC API

Platform Observability

Release notes

Reference

Manage Workspace users with the APC API

Add a user to a Workspace

Update a user’s Workspace role

Remove a user from a Workspace

​Add a user to a Workspace

​Update a user’s Workspace role

​Remove a user from a Workspace

Add a user to a Workspace

Update a user’s Workspace role

Remove a user from a Workspace