Jump to

• Request
• Response
• Examples

Create a User

post

/user

Creates a user.

Request

There are no request parameters for this operation.

Back to Top

Response

201 Response

The user was created successfully.

Back to Top

Examples

The following example shows how to create a user by submitting a POST request on the REST resource using cURL. For more information about cURL, see "Use cURL".

The -d option specifies the file to attach as the request body.

curl -X POST "hostname:port/user" -H "accept: */*" -H "Content-Type: application/json" -d @file.json

where:

• file.json is the JSON file the user details to create.

Example of Request Body

The following is an example of the contents of file.json sent as the request body:

{
    "firstName": "John",
    "lastName": "Wayne",
    "middleName": "middle-name",
    "email": "[e-mail]",
    "isAdmin": 1,
    "username": "JWayne",
    "displayName": "John Wayne"
}

Example of Response Body

If successful, the response code 201 is returned along with a header. For example:

{
  "_id": 2,
  "email": "[e-mail]",
  "isAdmin": 1,
  "lastName": "tesuser",
  "username": "tesuser",
  "firstName": "tesuser",
  "middleName": "tesuser",
  "profilePic": null,
  "displayName": "TES User"
}

If the request fails, the response includes the appropriate HTTP code. For a 4xx/5xx code, the message body also contains a ProblemDetails structure with the cause attribute set to the appropriate application error.

Back to Top