HomeGuidesAPI Reference
GuidesAPI ReferenceGitHubAirheads Developer CommunityLog In
API Reference

Create a user account

Create a user account. For public cloud environment, user has to re-register via invitation email. Email will be sent during processing of this request. Providing role on account setting app is mandatory in this API along with other subscribed apps. Scope must be given only for NMS app. For non-nms apps such as account setting refer the parameters in the example json payload.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Schema for the user account to be created

string
required

name of user

string
required

Password (Password requirements are at least 8 characters, a lowercase letter, an uppercase letter, a number, a symbol, no parts of your username, does not include your first name, does not include your last name. Your password cannot be any of your last 6 passwords.)

string
required

description of user

name
object
required
string
required

Phone number. Format: +country_code-local_number

address
object
required
applications
array of objects
required
applications*
Responses
201

request accepted successfully

400

A required parameter or field is missing or invalid argument.

401

Unauthorized access. Authentication failed or was not provided.

403

Access denied.

413

Request-size limit exceeded

417

Request-size limit exceeded

429

API Rate limit exceeded

500

Internal server error.

503

Customer migration in progress.

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here!