admin
auth_user_show: Show user details
Method | Path |
GET | /api/v1/users/show/user:String |
Params
Examples
cURL
curl -X GET -H 'Content-Type: application/json' -H "Authorization: $JWT" \
$URL/api/v1/users/show/admin
Output
{
"fullname": "admin",
"id": 1,
"tenant_ids": [
"default"
],
"user_roles": [
"admin",
"user"
],
"username": "admin"
}
auth_user_list: List all user details
Method | Path |
GET | /api/v1/users/list |
Examples
cURL
curl -X GET -H 'Content-Type: application/json' -H "Authorization: $JWT" \
$URL/api/v1/users/list
Output
[
{
"fullname": "admin",
"id": 1,
"tenant_ids": [
"default"
],
"user_roles": [
"admin",
"user"
],
"username": "admin"
},
{
"fullname": "\"Frodo Ringbearer\"",
"id": 2,
"tenant_ids": [
"default"
],
"user_roles": [
"admin",
"user"
],
"username": "frodo"
}
]
auth_user_auth: Authenticate a user against their password
Method | Path |
GET | /api/v1/users/auth |
Body Fields
Field | Type |
password | String |
username | String |
Examples
cURL
curl -X GET -H 'Content-Type: application/json' -H "Authorization: $JWT" \
$URL/api/v1/users/auth -d '{
"password": "decorate",
"username": "frodo"
}'
cURL
curl -X GET -H 'Content-Type: application/json' -H "Authorization: $JWT" \
$URL/api/v1/users/auth
Output
true
auth_user_token_validate: validate a JWT token
Method | Path |
GET | /api/v1/users/token/validate |
Body Fields
Field | Type |
key | String |
token | String |
auth_apikey_list: List all api-key details
Method | Path |
GET | /api/v1/api-keys/list |
auth_apikey_show: Show api-key details
Method | Path |
GET | /api/v1/api-keys/show/ident:String |
Params
auth_user_create: Create a new user
Method | Path |
POST | /api/v1/users/create |
Body Fields
Field | Type |
fullname | String, |
id | int, |
password | String |
tenant_ids | [String] |
user_roles | [String] |
username | String |
Examples
cURL
curl -X POST -H 'Content-Type: application/json' -H "Authorization: $JWT" \
$URL/api/v1/users/create -d '{
"fullname": "Frodo Baggins",
"id": 2,
"password": "decorate",
"tenant_ids": [
"default"
],
"user_roles": [
"admin",
"user"
],
"username": "frodo"
}'
auth_user_fullname: Change a user's full name
Method | Path |
POST | /api/v1/users/fullname/user:String |
Params
Examples
cURL
curl -X POST -H 'Content-Type: application/json' -H "Authorization: $JWT" \
$URL/api/v1/users/fullname/frodo -d '"Frodo Ringbearer"'
auth_user_password: Change a user's password
Method | Path |
POST | /api/v1/users/password/user:String |
Params
Body Fields
Field | Type |
new | String |
old | String |
change_password: Allow user to change their password
Method | Path |
POST | /api/v1/users/change-password |
Body Fields
Field | Type |
new_password | String |
old_password | String |
username | String |
auth_remove_user: Remove a user
Method | Path |
POST | /api/v1/users/remove/user:String |
Params
Examples
cURL
curl -X POST -H 'Content-Type: application/json' -H "Authorization: $JWT" \
$URL/api/v1/users/remove/frodo
auth_roles_add: Add new roles to a user
Method | Path |
POST | /api/v1/users/add-roles/user:String |
Params
Examples
cURL
curl -X POST -H 'Content-Type: application/json' -H "Authorization: $JWT" \
$URL/api/v1/users/add-roles/ -d '[
"admin"
]'
auth_roles_remove: Remove roles from a user
Method | Path |
POST | /api/v1/users/remove-roles/user:String |
Params
Examples
cURL
curl -X POST -H 'Content-Type: application/json' -H "Authorization: $JWT" \
$URL/api/v1/users/remove-roles/frodo -d '[
"admin"
]'
auth_tenants_add: Add tenant ids to a user
Method | Path |
POST | /api/v1/users/add-tenants/user:String |
Params
auth_tenants_remove: Remove tenant ids from a user
Method | Path |
POST | /api/v1/users/remove-tenants/user:String |
Params
auth_apikey_create: Create a new api-key
Method | Path |
POST | /api/v1/api-keys/create |
Body Fields
Field | Type |
identifier | String, |
roles | [String] |
tenant_ids | [String] |
Examples
cURL
curl -X POST -H 'Content-Type: application/json' -H "Authorization: $JWT" \
$URL/api/v1/api-keys/create -d '{
"identifier": "String,",
"roles": [
"String"
],
"tenant_ids": [
"String"
]
}'
auth_revoke_apikey: Revoke an api-key
Method | Path |
POST | /api/v1/api-keys/revoke/ident:String |
Params
auth_apikey_list: List all api-key details
Method | Path |
GET | /api/v1/api-keys/list |
auth_apikey_show: Show api-key details
Method | Path |
GET | /api/v1/api-keys/show/ident:String |
Params