admin

Show user details

Administering Users and Roles

MethodPath
GET/api/v1/users/show/user:String

List all user details

Administering Users and Roles

MethodPath
GET/api/v1/users/list

Authenticate a user against their password

Administering Users and Roles

MethodPath
GET/api/v1/users/auth

Required Payload Fields (as JSON)

Field NameType
passwordString
usernameString

validate a JWT token

Administering Users and Roles

MethodPath
GET/api/v1/users/token/validate

Required Payload Fields (as JSON)

Field NameType
keyString
tokenString

List all api-key details

Administering Users and Roles

MethodPath
GET/api/v1/api-keys/list

Show api-key details

Administering Users and Roles

MethodPath
GET/api/v1/api-keys/show/ident:String

Create a new user

Administering Users and Roles

MethodPath
POST/api/v1/users/create

Required Payload Fields (as JSON)

Field NameType
fullnameString,
idint,
tenant_ids[String]
user_roles[String]
usernameString

Change a user's full name

Administering Users and Roles

MethodPath
POST/api/v1/users/fullname/user:String

Change a user's password

Administering Users and Roles

MethodPath
POST/api/v1/users/password/user:String

Required Payload Fields (as JSON)

Field NameType
newString
oldString

Allow user to change their password

Administering Users and Roles

MethodPath
POST/api/v1/users/change-password

Required Payload Fields (as JSON)

Field NameType
new_passwordString
old_passwordString
usernameString

Remove a user

Administering Users and Roles

MethodPath
POST/api/v1/users/remove/user:String

Add new roles to a user

Administering Users and Roles

MethodPath
POST/api/v1/users/add-roles/user:String

Remove roles from a user

Administering Users and Roles

MethodPath
POST/api/v1/users/remove-roles/user:String

Add tenant ids to a user

Administering Users and Roles

MethodPath
POST/api/v1/users/add-tenants/user:String

Remove tenant ids from a user

Administering Users and Roles

MethodPath
POST/api/v1/users/remove-tenants/user:String

Create a new api-key

Administering Users and Roles

MethodPath
POST/api/v1/api-keys/create

Required Payload Fields (as JSON)

Field NameType
identifierString,
roles[String]
tenant_ids[String]

Revoke an api-key

Administering Users and Roles

MethodPath
POST/api/v1/api-keys/revoke/ident:String

Show user details

Administering Users and Roles

MethodPath
GET/api/v1/users/show/user:String

List all user details

Administering Users and Roles

MethodPath
GET/api/v1/users/list

Authenticate a user against their password

Administering Users and Roles

MethodPath
GET/api/v1/users/auth

validate a JWT token

Administering Users and Roles

MethodPath
GET/api/v1/users/token/validate

List all api-key details

Administering Users and Roles

MethodPath
GET/api/v1/api-keys/list

Show api-key details

Administering Users and Roles

MethodPath
GET/api/v1/api-keys/show/ident:String