Create a Deployment user 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.
To add an existing Astro Private Cloud user to a Deployment, you need:
- Workspace Admin privileges
- A Deployment ID. To retrieve this value, run
astro deployment listor request theidvalue in theworkspaceDeploymentquery. - The ID of the user to add. To retrieve this, request the
idvalue in ausersquery or runastro workspace user list. - The role to add the user as. Can be
DEPLOYMENT_ADMIN,DEPLOYMENT_EDITOR, orDEPLOYMENT_VIEWER.
The following query adds a user to a Deployment as a Deployment viewer, then returns the user and Deployment information back to the requester.