APC APIExample mutationsService accounts and roles

Update a Deployment user's 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 deploymentUpdateUserRole mutation to change an existing user’s role on a Deployment, for example to promote a DEPLOYMENT_VIEWER to DEPLOYMENT_EDITOR:

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

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