These operations require an administrator key owner and the appropriate users:* or groups:* scope. They manage local accounts and local groups. An ordinary user cannot read the administrative directory merely by having those scopes.
A new user needs login_identifier and a valid password; a group needs name. attributes holds profile attributes. display_name, first_name, last_name and email also support top-level input. provider_access maps permitted login methods (local, saml, cas, oidc, oauth2). group_ids is a list of numeric local group IDs. Membership PUT replaces the entire list rather than adding one group.
PATCH requires at least one changed field. User/group updates, membership replacement and deletion need the current ETag. DELETE user deactivates the account and revokes its API keys; it does not erase all related business data. System and externally managed accounts/groups have additional restrictions. Replace [REDACTED] in the example with your own strong password.
Operations and verified examples
GET /api/v1/groups
Purpose: Returns the local group list.
Permission: groups:read. Administrator key owner; the scope alone is insufficient.
Query parameters: page[after], page[limit].
Body: no additional input fields; follow the example.
curl --globoff --silent --show-error \
--request GET \
--header "Authorization: Bearer $SIMBIOZA_API_KEY" \
"$BASE_URL/api/v1/groups?page[limit]=1"
Actual response: HTTP 200.
{
"data": [
{
"id": 1,
"key": "administrator",
"name": "Administrator",
"is_system": true,
"is_enabled": true,
"sort_order": 10
}
],
"meta": {
"request_id": "ffc6243b21b6ad990f3e9fd642cb88d9",
"page": {
"limit": 1,
"total": 5,
"has_more": true,
"next_cursor": "eyJvZmZzZXQiOjF9"
}
},
"links": {
"self": "/api/v1/groups?page%5Blimit%5D=1",
"next": "/api/v1/groups?page%5Blimit%5D=1&page%5Bafter%5D=eyJvZmZzZXQiOjF9"
}
}
Errors verified for this operation: 401, 403. See shared rules for status meanings and problem responses.
POST /api/v1/groups
Purpose: Creates a local non-system group.
Permission: groups:manage. Administrator key owner; the scope alone is insufficient.
Query parameters: none.
Body / supported fields: is_enabled, name. The example below uses verified values; conditions and list-replacement rules are described at the start of the chapter.
curl --globoff --silent --show-error \
--request POST \
--header "Authorization: Bearer $SIMBIOZA_API_KEY" \
--header "Content-Type: application/json" \
--data-raw '{
"name": "API urednici / API editors",
"is_enabled": true
}' \
"$BASE_URL/api/v1/groups"
Actual response: HTTP 201.
{
"data": {
"id": 5,
"key": "api_urednici_api_editors",
"name": "API urednici / API editors",
"is_system": false,
"is_enabled": true,
"sort_order": 50
},
"meta": {
"request_id": "4234d5238d039d2641b6e983b4dc91f5"
},
"links": {
"self": "/api/v1/groups/5"
}
}
Errors verified for this operation: 400, 401, 403, 409, 415. See shared rules for status meanings and problem responses.
DELETE /api/v1/groups/{groupId}
Purpose: Deletes a local non-system group and its memberships.
Permission: groups:manage. Administrator key owner; the scope alone is insufficient.
Path: groupId. Take values from the preceding response. A page ID is its document key; nodeId is numeric, and a UUID is not a slug.
Query parameters: none.
Body: no additional input fields; follow the example.
Before writing: refresh the GET and set ETAG from its ETag header.
curl --globoff --silent --show-error \
--request DELETE \
--header "Authorization: Bearer $SIMBIOZA_API_KEY" \
--header "If-Match: $ETAG" \
"$BASE_URL/api/v1/groups/5"
Actual response: HTTP 204. The body is empty.
Errors verified for this operation: 401, 403. See shared rules for status meanings and problem responses.
GET /api/v1/groups/{groupId}
Purpose: Returns one local group.
Permission: groups:read. Administrator key owner; the scope alone is insufficient.
Path: groupId. Take values from the preceding response. A page ID is its document key; nodeId is numeric, and a UUID is not a slug.
Query parameters: none.
Body: no additional input fields; follow the example.
curl --globoff --silent --show-error \
--request GET \
--header "Authorization: Bearer $SIMBIOZA_API_KEY" \
"$BASE_URL/api/v1/groups/5"
Actual response: HTTP 200.
{
"data": {
"id": 5,
"key": "api_urednici_api_editors",
"name": "API urednici / API editors",
"is_system": false,
"is_enabled": true,
"sort_order": 50
},
"meta": {
"request_id": "3d2d9c22881a73fd170a603ec1b9a6cd"
},
"links": {
"self": "/api/v1/groups/5"
}
}
Errors verified for this operation: 401, 403. See shared rules for status meanings and problem responses.
PATCH /api/v1/groups/{groupId}
Purpose: Updates a local non-system group.
Permission: groups:manage. Administrator key owner; the scope alone is insufficient.
Path: groupId. Take values from the preceding response. A page ID is its document key; nodeId is numeric, and a UUID is not a slug.
Query parameters: none.
Body / supported fields: is_enabled, name. The example below uses verified values; conditions and list-replacement rules are described at the start of the chapter.
Before writing: refresh the GET and set ETAG from its ETag header.
curl --globoff --silent --show-error \
--request PATCH \
--header "Authorization: Bearer $SIMBIOZA_API_KEY" \
--header "Content-Type: application/json" \
--header "If-Match: $ETAG" \
--data-raw '{
"name": "API suradnici"
}' \
"$BASE_URL/api/v1/groups/5"
Actual response: HTTP 200.
{
"data": {
"id": 5,
"key": "api_urednici_api_editors",
"name": "API suradnici",
"is_system": false,
"is_enabled": true,
"sort_order": 50
},
"meta": {
"request_id": "79038fa2daf0fba9720e54dbde347e84"
},
"links": {
"self": "/api/v1/groups/5"
}
}
Errors verified for this operation: 400, 401, 403, 412, 422, 428. See shared rules for status meanings and problem responses.
GET /api/v1/users
Purpose: Returns a cursor-paginated list of local users.
Permission: users:read. Administrator key owner; the scope alone is insufficient.
Query parameters: page[after], page[limit].
Body: no additional input fields; follow the example.
curl --globoff --silent --show-error \
--request GET \
--header "Authorization: Bearer $SIMBIOZA_API_KEY" \
"$BASE_URL/api/v1/users?page[limit]=1"
Actual response: HTTP 200.
{
"data": [
{
"id": 1,
"login_identifier": "Admin",
"display_name": "Administrator",
"email": "admin@example.test",
"email_aliases": [
"admin@example.test"
],
"attributes": {
"display_name": "Administrator",
"email": "admin@example.test",
"first_name": "Admin",
"last_name": "Simbioza"
},
"is_admin": true,
"is_active": true,
"auth_source": "local",
"provider_access": {
"local": true,
"saml": false,
"cas": false,
"oidc": false,
"oauth2": false
},
"groups": [
{
"id": 1,
"key": "administrator",
"name": "Administrator",
"is_system": true,
"is_enabled": true,
"sort_order": 10
}
],
"last_login_at": "2026-11-06 22:35:53",
"must_change_password": "[REDACTED]"
}
],
"meta": {
"request_id": "eb06b96c165d9a118b0e0973f3654f96",
"page": {
"limit": 1,
"has_more": true,
"next_cursor": "aWQ6MQ"
}
},
"links": {
"self": "/api/v1/users?page%5Blimit%5D=1",
"next": "/api/v1/users?page[limit]=1&page[after]=aWQ6MQ"
}
}
Errors verified for this operation: 401, 403. See shared rules for status meanings and problem responses.
POST /api/v1/users
Purpose: Creates a local user.
Permission: users:create. Administrator key owner; the scope alone is insufficient.
Query parameters: none.
Body / supported fields: attributes, display_name, email, first_name, group_ids, is_active, is_admin, last_name, login_identifier, password, provider_access. The example below uses verified values; conditions and list-replacement rules are described at the start of the chapter.
curl --globoff --silent --show-error \
--request POST \
--header "Authorization: Bearer $SIMBIOZA_API_KEY" \
--header "Content-Type: application/json" \
--data-raw '{
"login_identifier": "api.example@example.invalid",
"password": "[REDACTED]",
"is_active": true,
"is_admin": false,
"provider_access": {
"local": true
},
"attributes": {
"display_name": "Ogledni API korisnik",
"email": "api.example@example.invalid"
}
}' \
"$BASE_URL/api/v1/users"
Actual response: HTTP 201.
{
"data": {
"id": 4,
"login_identifier": "api.example@example.invalid",
"display_name": "Ogledni API korisnik",
"email": "api.example@example.invalid",
"email_aliases": [
"api.example@example.invalid"
],
"attributes": {
"email": "api.example@example.invalid",
"display_name": "Ogledni API korisnik"
},
"is_admin": false,
"is_active": true,
"auth_source": "local",
"provider_access": {
"local": true,
"saml": false,
"cas": false,
"oidc": false,
"oauth2": false
},
"groups": [],
"last_login_at": null,
"must_change_password": "[REDACTED]"
},
"meta": {
"request_id": "ee8bf7773217b84d00d9b262e56d9f9b"
},
"links": {
"self": "/api/v1/users/4"
}
}
Errors verified for this operation: 401, 403. See shared rules for status meanings and problem responses.
DELETE /api/v1/users/{userId}
Purpose: Deactivates a local user and revokes their API keys.
Permission: users:delete. Administrator key owner; the scope alone is insufficient.
Path: userId. Take values from the preceding response. A page ID is its document key; nodeId is numeric, and a UUID is not a slug.
Query parameters: none.
Body: no additional input fields; follow the example.
Before writing: refresh the GET and set ETAG from its ETag header.
curl --globoff --silent --show-error \
--request DELETE \
--header "Authorization: Bearer $SIMBIOZA_API_KEY" \
--header "If-Match: $ETAG" \
"$BASE_URL/api/v1/users/4"
Actual response: HTTP 204. The body is empty.
Errors verified for this operation: 401, 403. See shared rules for status meanings and problem responses.
GET /api/v1/users/{userId}
Purpose: Returns one local user.
Permission: users:read. Administrator key owner; the scope alone is insufficient.
Path: userId. Take values from the preceding response. A page ID is its document key; nodeId is numeric, and a UUID is not a slug.
Query parameters: none.
Body: no additional input fields; follow the example.
curl --globoff --silent --show-error \
--request GET \
--header "Authorization: Bearer $SIMBIOZA_API_KEY" \
"$BASE_URL/api/v1/users/4"
Actual response: HTTP 200.
{
"data": {
"id": 4,
"login_identifier": "api.example@example.invalid",
"display_name": "Ogledni API korisnik",
"email": "api.example@example.invalid",
"email_aliases": [
"api.example@example.invalid"
],
"attributes": {
"display_name": "Ogledni API korisnik",
"email": "api.example@example.invalid"
},
"is_admin": false,
"is_active": true,
"auth_source": "local",
"provider_access": {
"local": true,
"saml": false,
"cas": false,
"oidc": false,
"oauth2": false
},
"groups": [],
"last_login_at": null,
"must_change_password": "[REDACTED]"
},
"meta": {
"request_id": "ac38613b06ac5362c257dda6d691fad6"
},
"links": {
"self": "/api/v1/users/4"
}
}
Errors verified for this operation: 401, 403. See shared rules for status meanings and problem responses.
PATCH /api/v1/users/{userId}
Purpose: Partially updates a local user.
Permission: users:update. Administrator key owner; the scope alone is insufficient.
Path: userId. Take values from the preceding response. A page ID is its document key; nodeId is numeric, and a UUID is not a slug.
Query parameters: none.
Body / supported fields: attributes, display_name, email, first_name, group_ids, is_active, is_admin, last_name, login_identifier, password, provider_access. The example below uses verified values; conditions and list-replacement rules are described at the start of the chapter.
Before writing: refresh the GET and set ETAG from its ETag header.
curl --globoff --silent --show-error \
--request PATCH \
--header "Authorization: Bearer $SIMBIOZA_API_KEY" \
--header "Content-Type: application/json" \
--header "If-Match: $ETAG" \
--data-raw '{
"attributes": {
"display_name": "Ažurirani API korisnik"
}
}' \
"$BASE_URL/api/v1/users/4"
Actual response: HTTP 200.
{
"data": {
"id": 4,
"login_identifier": "api.example@example.invalid",
"display_name": "Ažurirani API korisnik",
"email": "api.example@example.invalid",
"email_aliases": [
"api.example@example.invalid"
],
"attributes": {
"display_name": "Ažurirani API korisnik",
"email": "api.example@example.invalid"
},
"is_admin": false,
"is_active": true,
"auth_source": "local",
"provider_access": {
"local": true,
"saml": false,
"cas": false,
"oidc": false,
"oauth2": false
},
"groups": [
{
"id": 5,
"key": "api_urednici_api_editors",
"name": "API urednici / API editors",
"is_system": false,
"is_enabled": true,
"sort_order": 50
}
],
"last_login_at": null,
"must_change_password": "[REDACTED]"
},
"meta": {
"request_id": "92b0f70bd59be10cf076a4de0ffd1589"
},
"links": {
"self": "/api/v1/users/4"
}
}
Errors verified for this operation: 401, 403. See shared rules for status meanings and problem responses.
PUT /api/v1/users/{userId}/groups
Purpose: Replaces a local user's manual memberships.
Permission: groups:manage. Administrator key owner; the scope alone is insufficient.
Path: userId. Take values from the preceding response. A page ID is its document key; nodeId is numeric, and a UUID is not a slug.
Query parameters: none.
Body / supported fields: group_ids. The example below uses verified values; conditions and list-replacement rules are described at the start of the chapter.
Before writing: refresh the GET and set ETAG from its ETag header.
curl --globoff --silent --show-error \
--request PUT \
--header "Authorization: Bearer $SIMBIOZA_API_KEY" \
--header "Content-Type: application/json" \
--header "If-Match: $ETAG" \
--data-raw '{
"group_ids": [
5
]
}' \
"$BASE_URL/api/v1/users/4/groups"
Actual response: HTTP 200.
{
"data": {
"id": 4,
"login_identifier": "api.example@example.invalid",
"display_name": "Ogledni API korisnik",
"email": "api.example@example.invalid",
"email_aliases": [
"api.example@example.invalid"
],
"attributes": {
"display_name": "Ogledni API korisnik",
"email": "api.example@example.invalid"
},
"is_admin": false,
"is_active": true,
"auth_source": "local",
"provider_access": {
"local": true,
"saml": false,
"cas": false,
"oidc": false,
"oauth2": false
},
"groups": [
{
"id": 5,
"key": "api_urednici_api_editors",
"name": "API urednici / API editors",
"is_system": false,
"is_enabled": true,
"sort_order": 50
}
],
"last_login_at": null,
"must_change_password": "[REDACTED]"
},
"meta": {
"request_id": "bde44da0c5418fd4da77d60d991c2288"
},
"links": {
"self": "/api/v1/users/4/groups"
}
}
Errors verified for this operation: 401, 403. See shared rules for status meanings and problem responses.