Create user - AWorld API

Creates a new user in the system with generated credentials

curl --location --request POST 'https://api.eu-west-1.aworld.cloud/dashboard/v1/users' \ --header 'Content-Type: application/json' \ --data-raw '{ "email": "user@example.com", "password": "pa$$word", "lang": "en", "timezone": "UTC", "externalId": "string" }'

{ "userId": "string", "principalId": "string", "externalId": "string", "lang": "en", "timezone": "UTC", "accountId": "string", "workspaceId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" }

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

Data required to create a new user

string <email>

required

User's email address

password

string <password>

optional

Password for the user (if not provided, a temporary password will be generated)

lang

string

optional

User's preferred language code

Default:

timezone

string

optional

User's timezone

Default:

UTC

externalId

string

optional

Optional external system identifier for the user

Examples

Responses

🟢200OK

application/json

User created successfully

Body

User account information

userId

string

required

Unique identifier for the user

principalId

string

required

Identifier used for authentication

externalId

string

optional

Optional external system identifier for the user

lang

string

required

User's preferred language code

Default:

timezone

string

required

User's timezone

Default:

UTC

accountId

string

required

The account ID that this user belongs to

workspaceId

string

required

The workspace ID that this user belongs to

createdAt

string <date-time>

optional

Timestamp when the user was created

updatedAt

string <date-time>

optional

Timestamp when the user was last updated

🟠400Bad Request

🟠401Unauthorized

🟠409409