Users
Successful user sign in.
POST /api/v2/users/sign_in HTTP/1.1
Host: localhost
Content-Type: application/json
Accept: */*
Content-Length: 46
{
"user": {
"username": "text",
"password": "text"
}
}Successful user sign in.
{
"id": 100,
"user_id": 1000,
"group_id": 1000,
"username": "admin",
"password": "text",
"email": "admin@nodeum.local",
"is_admin": true,
"created_at": "2026-01-01T00:00:00.000Z",
"updated_at": "2026-01-01T00:00:00.000Z"
}Pass the username and password of a user in the authorization header. This currently gives full access.
Successful user sign out.
No content
DELETE /api/v2/users/sign_out HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*
Successful user sign out.
No content
Pass the username and password of a user in the authorization header. This currently gives full access.
The number of items to display for pagination.
The number of items to skip for pagination.
List of configurations.
1GET /api/v2/users/me/configurations HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*
List of configurations.
{
"configurations": [
{
"id": 5,
"key": "global.locale",
"value": "en"
}
],
"count": 1
}Pass the username and password of a user in the authorization header. This currently gives full access.
5global.localeenA specific file.
5global.localeenPOST /api/v2/users/me/configurations HTTP/1.1
Host: localhost
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 36
{
"key": "global.locale",
"value": "en"
}A specific file.
{
"id": 5,
"key": "global.locale",
"value": "en"
}Pass the username and password of a user in the authorization header. This currently gives full access.
Numeric ID, or key of configuration.
A specific file.
5global.localeenGET /api/v2/users/me/configurations/{configuration_id} HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*
A specific file.
{
"id": 5,
"key": "global.locale",
"value": "en"
}Pass the username and password of a user in the authorization header. This currently gives full access.
Numeric ID, or key of configuration.
5global.localeenA specific file.
5global.localeenPUT /api/v2/users/me/configurations/{configuration_id} HTTP/1.1
Host: localhost
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 36
{
"key": "global.locale",
"value": "en"
}A specific file.
{
"id": 5,
"key": "global.locale",
"value": "en"
}Pass the username and password of a user in the authorization header. This currently gives full access.
Numeric ID, or key of configuration.
Configuration destroyed.
No content
DELETE /api/v2/users/me/configurations/{configuration_id} HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*
Configuration destroyed.
No content
Pass the username and password of a user in the authorization header. This currently gives full access.
The number of items to display for pagination.
The number of items to skip for pagination.
List of API Keys.
1GET /api/v2/users/me/api_keys HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*
List of API Keys.
{
"api_keys": [
{
"id": 5,
"key": "******************Iwgo",
"name": "dev-key"
}
],
"count": 1
}Pass the username and password of a user in the authorization header. This currently gives full access.
5******************Iwgodev-keyA specific file.
5******************Iwgodev-keyPOST /api/v2/users/me/api_keys HTTP/1.1
Host: localhost
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 75
{
"name": "dev-key",
"api_key_scopes": [
{
"controller": "text",
"action": "text"
}
]
}A specific file.
{
"id": 5,
"key": "******************Iwgo",
"name": "dev-key",
"api_key_scopes": [
{
"controller": "text",
"action": "text"
}
]
}Pass the username and password of a user in the authorization header. This currently gives full access.
Numeric ID of API Key.
A specific file.
5******************Iwgodev-keyGET /api/v2/users/me/api_keys/{api_key_id} HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*
A specific file.
{
"id": 5,
"key": "******************Iwgo",
"name": "dev-key",
"api_key_scopes": [
{
"controller": "text",
"action": "text"
}
]
}Pass the username and password of a user in the authorization header. This currently gives full access.
Numeric ID of API Key.
5******************Iwgodev-keyA specific file.
5******************Iwgodev-keyPUT /api/v2/users/me/api_keys/{api_key_id} HTTP/1.1
Host: localhost
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 75
{
"name": "dev-key",
"api_key_scopes": [
{
"controller": "text",
"action": "text"
}
]
}A specific file.
{
"id": 5,
"key": "******************Iwgo",
"name": "dev-key",
"api_key_scopes": [
{
"controller": "text",
"action": "text"
}
]
}Pass the username and password of a user in the authorization header. This currently gives full access.
Numeric ID of API Key.
API Key destroyed.
No content
DELETE /api/v2/users/me/api_keys/{api_key_id} HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*
API Key destroyed.
No content
Pass the username and password of a user in the authorization header. This currently gives full access.
A specific user.
10010001000adminCreation and update only
admin@nodeum.localUser is unauthorized.
GET /api/v2/users/me HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*
{
"id": 100,
"user_id": 1000,
"group_id": 1000,
"username": "admin",
"password": "text",
"email": "admin@nodeum.local",
"is_admin": true,
"created_at": "2026-01-01T00:00:00.000Z",
"updated_at": "2026-01-01T00:00:00.000Z"
}Pass the username and password of a user in the authorization header. This currently gives full access.
The number of items to display for pagination.
The number of items to skip for pagination.
List of users.
1GET /api/v2/users HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*
List of users.
{
"count": 1,
"users": [
{
"id": 100,
"user_id": 1000,
"group_id": 1000,
"username": "admin",
"password": "text",
"email": "admin@nodeum.local",
"is_admin": true,
"created_at": "2026-01-01T00:00:00.000Z",
"updated_at": "2026-01-01T00:00:00.000Z"
}
]
}Pass the username and password of a user in the authorization header. This currently gives full access.
10010001000adminCreation and update only
admin@nodeum.localA specific user.
10010001000adminCreation and update only
admin@nodeum.localThe received resource was not correctly formatted.
POST /api/v2/users HTTP/1.1
Host: localhost
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 114
{
"user_id": 1000,
"group_id": 1000,
"username": "admin",
"password": "text",
"email": "admin@nodeum.local",
"is_admin": true
}{
"id": 100,
"user_id": 1000,
"group_id": 1000,
"username": "admin",
"password": "text",
"email": "admin@nodeum.local",
"is_admin": true,
"created_at": "2026-01-01T00:00:00.000Z",
"updated_at": "2026-01-01T00:00:00.000Z"
}Pass the username and password of a user in the authorization header. This currently gives full access.
Numeric ID, username, or email.
A specific user.
10010001000adminCreation and update only
admin@nodeum.localGET /api/v2/users/{user_id} HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*
A specific user.
{
"id": 100,
"user_id": 1000,
"group_id": 1000,
"username": "admin",
"password": "text",
"email": "admin@nodeum.local",
"is_admin": true,
"created_at": "2026-01-01T00:00:00.000Z",
"updated_at": "2026-01-01T00:00:00.000Z"
}Pass the username and password of a user in the authorization header. This currently gives full access.
Numeric ID, username, or email.
10010001000adminCreation and update only
admin@nodeum.localA specific user.
10010001000adminCreation and update only
admin@nodeum.localThe received resource was not correctly formatted.
PUT /api/v2/users/{user_id} HTTP/1.1
Host: localhost
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 114
{
"user_id": 1000,
"group_id": 1000,
"username": "admin",
"password": "text",
"email": "admin@nodeum.local",
"is_admin": true
}{
"id": 100,
"user_id": 1000,
"group_id": 1000,
"username": "admin",
"password": "text",
"email": "admin@nodeum.local",
"is_admin": true,
"created_at": "2026-01-01T00:00:00.000Z",
"updated_at": "2026-01-01T00:00:00.000Z"
}Pass the username and password of a user in the authorization header. This currently gives full access.
Numeric ID, username, or email.
Container destroyed.
No content
DELETE /api/v2/users/{user_id} HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*
Container destroyed.
No content
Pass the username and password of a user in the authorization header. This currently gives full access.
List of users.
1GET /api/v2/users/-/systems HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*
List of users.
{
"count": 1,
"users": [
{
"name": "text",
"uid": 1,
"gid": 1,
"info": "text"
}
]
}Pass the username and password of a user in the authorization header. This currently gives full access.
List of user groups.
1GET /api/v2/groups/-/systems HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*
List of user groups.
{
"count": 1,
"groups": [
{
"name": "text",
"gid": 1,
"users": [
"text"
]
}
]
}Last updated
Was this helpful?