APC APIExample mutationsUser accounts

Verify user email 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.

If a user on the platform has trouble verifying their email address, you can use the APC API to manually verify it for them.

To run this mutation, you’ll need:

  • System Admin Permissions
  • The user’s email address. This needs to be the email address that the user provided when they began creating an account on the platform. They must have signed up for an account, and Astro Private Cloud must already have generated an invite token for the user.

The following request verifies the email and returns true or false based on whether the mutation was successful.

1mutation verifyEmail {
2	verifyEmail (
3    email: "<user-email>"
4  )
5}