User administration and authentication

Overview

An API for user administration and user authentication handling. Intended for use by the web GUI. All responses from the API will contain 'X-MEN-RequestID' header with server-side generated request ID.

Version information

Version : 1

URI scheme

Host : docker.mender.io
BasePath : /api/management/v1/useradm
Schemes : HTTPS

Paths

• POST/auth/login
• POST/settings
• GET/settings
• POST/users
• GET/users
• GET/users/{id}
• PUT/users/{id}
• DELETE/users/{id}

Log in to Mender

POST /auth/login

Description

Accepts user credentials via standard Basic Auth, and returns a JWT token to be used for authentication in subsequent requests.

Parameters

Responses

Example HTTP response

Response 200

{
  "application/jwt" : "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9. eyJleHAiOjE0NzYxMTkxMzYsImlzcyI6Ik1lbmRlciIsIn N1YiI6Ijg1NGIzMTA5LTQ4NjItNGEyNS1hMWZiLWYxMTE2 MWNlN2E4NCIsInNjcCI6WyJtZW5kZXIuKiJdfQ. X7Ief4PhPLlR6mA2wh3G3K0Z2tud0rK1QJesxu52NfICSe ARmlujczs-_1YZxMwI0s-HgpXHbXIjaSVK80BjxjAM1rqp RGvgqSqG-dU5KmglDpAaTr4VaJci3VFPlVUVTRpI7bfqNM nKZtjmOUAGwjvroDUwX1RwayEmms-efGI"
}

Response 400

{
  "error" : "missing Authorization header",
  "request_id" : "f7881e82-0492-49fb-b459-795654e7188a"
}

Response 401

{
  "error" : "missing Authorization header",
  "request_id" : "f7881e82-0492-49fb-b459-795654e7188a"
}

Response 500

{
  "error" : "missing Authorization header",
  "request_id" : "f7881e82-0492-49fb-b459-795654e7188a"
}

Set user settings

POST /settings

Description

Create user settings or replace existing settings with provided object.

Parameters

Responses

Example HTTP response

Response 400

{
  "error" : "missing Authorization header",
  "request_id" : "f7881e82-0492-49fb-b459-795654e7188a"
}

Response 401

{
  "error" : "missing Authorization header",
  "request_id" : "f7881e82-0492-49fb-b459-795654e7188a"
}

Response 500

{
  "error" : "missing Authorization header",
  "request_id" : "f7881e82-0492-49fb-b459-795654e7188a"
}

Get user settings

GET /settings

Description

Returns user settings.

Parameters

Responses

Example HTTP response

Response 401

{
  "error" : "missing Authorization header",
  "request_id" : "f7881e82-0492-49fb-b459-795654e7188a"
}

Response 500

{
  "error" : "missing Authorization header",
  "request_id" : "f7881e82-0492-49fb-b459-795654e7188a"
}

Create user

POST /users

Parameters

Responses

Example HTTP request

Request body

{
  "email" : "user@acme.com",
  "password" : "mypass1234"
}

Example HTTP response

Response 400

{
  "error" : "missing Authorization header",
  "request_id" : "f7881e82-0492-49fb-b459-795654e7188a"
}

Response 401

{
  "error" : "missing Authorization header",
  "request_id" : "f7881e82-0492-49fb-b459-795654e7188a"
}

Response 422

{
  "error" : "missing Authorization header",
  "request_id" : "f7881e82-0492-49fb-b459-795654e7188a"
}

Response 500

{
  "error" : "missing Authorization header",
  "request_id" : "f7881e82-0492-49fb-b459-795654e7188a"
}

List users

GET /users

Description

Returns a non-paged collection of users information.

Parameters

Responses

Example HTTP response

Response 401

{
  "error" : "missing Authorization header",
  "request_id" : "f7881e82-0492-49fb-b459-795654e7188a"
}

Response 500

{
  "error" : "missing Authorization header",
  "request_id" : "f7881e82-0492-49fb-b459-795654e7188a"
}

Get user information

GET /users/{id}

Description

Returns user information.

Parameters

Responses

Example HTTP response

Response 200

{
  "email" : "user@acme.com",
  "id" : "806603def19d417d004a4b67e",
  "created_ts" : "2016-10-03T16:58:51.639Z",
  "updated_ts" : "2016-10-04T11:33:66.611Z"
}

Response 401

{
  "error" : "missing Authorization header",
  "request_id" : "f7881e82-0492-49fb-b459-795654e7188a"
}

Response 404

{
  "error" : "missing Authorization header",
  "request_id" : "f7881e82-0492-49fb-b459-795654e7188a"
}

Response 500

{
  "error" : "missing Authorization header",
  "request_id" : "f7881e82-0492-49fb-b459-795654e7188a"
}

Update user information

PUT /users/{id}

Description

Update user email or change user password.

Parameters

Responses

Example HTTP request

Request body

{
  "email" : "new_email@acme.com"
}

Example HTTP response

Response 400

{
  "error" : "missing Authorization header",
  "request_id" : "f7881e82-0492-49fb-b459-795654e7188a"
}

Response 401

{
  "error" : "missing Authorization header",
  "request_id" : "f7881e82-0492-49fb-b459-795654e7188a"
}

Response 404

{
  "error" : "missing Authorization header",
  "request_id" : "f7881e82-0492-49fb-b459-795654e7188a"
}

Response 422

{
  "error" : "missing Authorization header",
  "request_id" : "f7881e82-0492-49fb-b459-795654e7188a"
}

Response 500

{
  "error" : "missing Authorization header",
  "request_id" : "f7881e82-0492-49fb-b459-795654e7188a"
}

Remove user from the system

DELETE /users/{id}

Description

Remove user information from the system.

Parameters

Responses

Example HTTP response

Response 401

{
  "error" : "missing Authorization header",
  "request_id" : "f7881e82-0492-49fb-b459-795654e7188a"
}

Response 500

{
  "error" : "missing Authorization header",
  "request_id" : "f7881e82-0492-49fb-b459-795654e7188a"
}

Definitions

Error

Error descriptor.

Settings

User settings.

Type : object

User

User descriptor.

UserNew

New user descriptor.

UserUpdate

Update user information.