Orion/Server API/User API

The User API is a web server API for browsing and manipulating users.

Actions on users

Create a user

Overview

To create a new user account, send a POST request with the UserName and Password.

HTTP Method

POST

Example Request

POST /users HTTP/1.1
Orion-Version: 1.0
Content-Type: application/json

{
 "UserName" : "newuser",
 "Password" : "newPassw0rd"
 "FullName": "New User",
}  

Example Response

HTTP/1.1 201 CREATED
Content-Type: application/json

{
 "EmailConfirmed": false,
 "FullName": "New User",
 "HasPassword": true,
 "Location": "/users/newuser",
 "UserName": "newuser"
}

Detailed Explanation

FullName and Email are optional fields that can be added to the request. The request does not need to be authenticated unless the server specifies the orion.auth.user.creation preference to allow only the admin user to create accounts.

Read a user

Overview

To read a user account profile, send a GET request.

HTTP Method

GET

Example Request

GET /users/newuser HTTP/1.1
Orion-Version: 1.0

  

Example Response

HTTP/1.1 200 OK
Content-Type: application/json

{
 "EmailConfirmed": false,
 "FullName": "New User",
 "HasPassword": true,
 "Location": "/users/newuser",
 "UserName": "newuser"
}

Detailed Explanation

The request needs to be authenticated as newuser or an admin user.

Update a user

Overview

To update a user account, send a PUT request with the updated properties.

HTTP Method

PUT

Example Request

PUT /users/newuser HTTP/1.1
Orion-Version: 1.0
Content-Type: application/json

{
 "Password" : "oldPassw0rd"
 "NewPassword" : "newPassw0rd"
 "FullName": "New Full Name",
}  

Example Response

HTTP/1.1 200 OK

Detailed Explanation

Users other than admin have to provide the old password to set a new one.

Delete a user

Overview

To delete a user account profile, send a DELETE request.

HTTP Method

DELETE

Example Request

DELETE /users/newuser HTTP/1.1
Orion-Version: 1.0

  

Example Response

HTTP/1.1 200 OK

Detailed Explanation

The request needs to be authenticated as newuser or an admin user.