Mist API Reference
Mist Automation Guide
HomeSDKsAPI ReferenceContext Plugin
Admins

registerNewAdmin

POST
/api/v1/register

Register a new administrator account and initial organization. This public endpoint does not require authentication. Mist sends a verification email containing a link such as /verify/register?token={token}; use Verify Registration to complete registration with that token.

Use Get Registration Information before submitting this request to determine whether CAPTCHA is required, which CAPTCHA provider to render, and which public site key to use. If CAPTCHA is required, include the provider response token in recaptcha and the provider name in recaptcha_flavor.

Request Body

application/json

Request Body

Administrator invitation and initial registration payload

account_only?boolean

Skip creating initial setup if true

Defaultfalse
allow_mist?boolean

Whether to allow Mist to look at this org

Defaultfalse
city?string

Registration city for the admin user

country?string

Registration country or region for the admin user, as a name or ISO code

email*string

Registration email address for the admin user

Lengthlength <= 64
first_name*string

Given name for the registering admin user

invite_code?string

Invite code used to authorize new admin registration

last_name*string

Family name for the registering admin user

no_tracking?boolean

Optional privacy-consent setting. When omitted, defaults to true in GDPR environments and false in non-GDPR environments.

org_name*string

Organization name supplied during initial admin registration

password*string

Credential password for the registering admin account

Formatpassword
recaptcha*string

CAPTCHA verification token submitted during admin registration

recaptcha_flavor?recaptcha_flavor

CAPTCHA provider flavor used for registration verification. enum: google, hcaptcha.

Default"google"

Value in

  • "google"
  • "hcaptcha"
referer_invite_token?string

Invite token to apply after account creation

return_to?string

URL the user should be redirected back to

state?string

Registration state or province for the admin user, optional depending on country or region

street_address?string

Street address of registering user

street_address 2?string

Street address 2 of registering user

zipcode?string

Postal code for the registering admin user

Response Body

curl -X POST "https://example.com/api/v1/register" \  -H "Content-Type: application/json" \  -d '{    "account_only": false,    "allow_mist": false,    "city": "Cupertino",    "country": "United States",    "email": "test@mistsys.com",    "first_name": "John",    "invite_code": "MISTROCKS",    "last_name": "Smith",    "no_tracking": false,    "org_name": "Smith LLC",    "password": "foryoureyesonly",    "recaptcha": "string",    "recaptcha_flavor": "hcaptcha",    "referer_invite_token": "Dm2gtT8dwMeM4Bc2E8FLIaA96VHOjPat",    "return_to": "https://mist.zendesk.com/hc/quickstart.pdf",    "state": "California",    "street_address": "1601 S De Anza Blvd Ste 248",    "street_address 2": "1601 S De Anza Blvd Ste 248",    "zipcode": "95014"  }'
Empty

getAdminRegistrationInfo GET

Return the public CAPTCHA settings required for administrator registration. This public endpoint does not require authentication. Use the returned `flavor`, `required`, and `sitekey` values to render the correct CAPTCHA challenge before calling [Register New Admin](/api/mist/admins/registerNewAdmin).

verifyAdminInvite POST

Accept an administrator invite using the invite verification token from the invite email. This public endpoint does not require authentication. After a successful verification, call [Get Self](/api/mist/self/self-account/getSelf) to refresh the authenticated admin profile and retrieve the newly granted privileges.