Add a Deployment user role 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.

Use the deploymentAddUserRole GraphQL mutation to add a user, or deploymentUpdateUserRole to change an existing user’s role.

1 mutation {
2   deploymentAddUserRole(
3     deploymentId: "<deployment-id>"
4     email: "<user-email>"
5     role: DEPLOYMENT_EDITOR
6   ) {
7     id
8   }
9 }

Use role: DEPLOYMENT_VIEWER to restrict a user to read-only access instead.

For the full role-assignment flow, see Manage users on Astro Private Cloud.