Users

Create User

Create a new user.

Note: Requires administrator permissions.

post/_api/user

Request

The document declares no server URL.
Auth
- API key in header Authorization
- or HTTP bearer
TypeScript
https://skmtc.dev/macrometa/apis/macrometa-api-reference/docs/_api/user/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

activeboolean

If set to true, the user is active.

emailstring required

The email of the user.

passwdstring required

The user password. The password must have at least 8 characters, one uppercase letter, one lowercase letter, one number, and one special character (!@#$%^&*).

displayNamestring

The display name of the user.

Example request

{
  "email": "test@bar.com",
  "passwd": "P@55w0rd",
  "displayName": "Jhon Doe"
}

Response

Successfully created user.

codeinteger

HTTP response code.

errorboolean

Flag if there is an error in response. False for this response.

userstring

The id of the user.

activeboolean

Account status

emailstring

The email of the user for whom we want the auth token.

extraobject

A JSON object with extra data about the user.

tenantstring

The name of the tenant for whose user we want the auth token.

displayNamestring

The name of the user for whom we want the auth token.

Example response

{
  "code": 201,
  "user": "Ugr0xjYMS9y0eN5gBxSSmg",
  "active": true,
  "email": "joe@foo.com",
  "extra": {},
  "tenant": "foo",
  "displayName": "joe"
}

Changes

No recorded changes to this operation across all 1 revision of this API.