User Groups

11 Endpunkte. Basis-URL: https://xapi.ambertech.cloud/api/v1

List user groups#

GET/groupsToken

Parameter

Name	Ort	Typ	Beschreibung
`is_deleted`	Query	`string`	–
`search`	Query	`string`	–

Antworten

200OK

Beispiel (cURL)

curl -X GET "https://xapi.ambertech.cloud/api/v1/groups" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Create a user group#

POST/groupsToken

Request-Body`application/jsonCreateUserGroupDto`

Name	Typ	Beschreibung
`name`Pflicht	`string`	Group name
`description`	`object`	Group description
`color`	`string`	Hex color code (6-digit) Beispiel: `#6B7280`
`default_role_id`	`object`	Default role ID for new members
`organizationId`	`string`	Organization ID (sent by frontend, ignored — JWT is used)

Antworten

201Erstellt

Beispiel (cURL)

curl -X POST "https://xapi.ambertech.cloud/api/v1/groups" \
  -H "Authorization: Bearer $XISUITE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"…"}'

Get a user group by ID#

GET/groups/{id}Token

Parameter

Name	Ort	Typ	Beschreibung
`id`Pflicht	Pfad	`string`	–
`withMembers`	Query	`string`	–

Antworten

200OK

Beispiel (cURL)

curl -X GET "https://xapi.ambertech.cloud/api/v1/groups/{id}" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Update a user group#

PUT/groups/{id}Token

Parameter

Name	Ort	Typ	Beschreibung
`id`Pflicht	Pfad	`string`	–

Request-Body`application/jsonUpdateUserGroupDto`

Name	Typ	Beschreibung
`name`	`string`	Group name
`description`	`object`	Group description
`color`	`string`	Hex color code (6-digit) Beispiel: `#6B7280`
`default_role_id`	`object`	Default role ID for new members

Antworten

200OK

Beispiel (cURL)

curl -X PUT "https://xapi.ambertech.cloud/api/v1/groups/{id}" \
  -H "Authorization: Bearer $XISUITE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"…","description":{},"color":"#6B7280"}'

Actions: restore | permanent_delete | duplicate#

PATCH/groups/{id}Token

Parameter

Name	Ort	Typ	Beschreibung
`id`Pflicht	Pfad	`string`	–

Request-Body`application/jsonPatchUserGroupDto`

Name	Typ	Beschreibung
`action`Pflicht	`string`	Werte: `restorepermanent_deleteduplicate`
`newName`	`string`	New name (required for duplicate)
`organizationId`	`string`	Organization ID (accepted from frontend, JWT org is always used)
`copyMembers`	`boolean`	When duplicating, copy existing group members too.

Antworten

200OK

Beispiel (cURL)

curl -X PATCH "https://xapi.ambertech.cloud/api/v1/groups/{id}" \
  -H "Authorization: Bearer $XISUITE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"action":"restore"}'

Soft-delete a user group#

DELETE/groups/{id}Token

Parameter

Name	Ort	Typ	Beschreibung
`id`Pflicht	Pfad	`string`	–

Antworten

200OK

Beispiel (cURL)

curl -X DELETE "https://xapi.ambertech.cloud/api/v1/groups/{id}" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

List members of a group#

GET/groups/{id}/membersToken

Parameter

Name	Ort	Typ	Beschreibung
`id`Pflicht	Pfad	`string`	–

Antworten

200OK

Beispiel (cURL)

curl -X GET "https://xapi.ambertech.cloud/api/v1/groups/{id}/members" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Add member(s) to a group#

POST/groups/{id}/membersToken

Parameter

Name	Ort	Typ	Beschreibung
`id`Pflicht	Pfad	`string`	–

Request-Body`application/jsonAddMembersDto`

Name	Typ	Beschreibung
`user_id`	`string`	Single user ID to add
`user_ids`	`string[]`	Multiple user IDs to add (bulk)
`role_id`	`object`	Role ID to assign to added member(s)

Antworten

201Erstellt

Beispiel (cURL)

curl -X POST "https://xapi.ambertech.cloud/api/v1/groups/{id}/members" \
  -H "Authorization: Bearer $XISUITE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"user_id":"…","user_ids":[],"role_id":{}}'

Update role of a group member#

PATCH/groups/{id}/membersToken

Parameter

Name	Ort	Typ	Beschreibung
`id`Pflicht	Pfad	`string`	–

Request-Body`application/jsonUpdateMemberRoleDto`

Name	Typ	Beschreibung
`user_id`Pflicht	`string`	User ID whose role to update
`role_id`	`object`	New role ID (null to remove role)

Antworten

200OK

Beispiel (cURL)

curl -X PATCH "https://xapi.ambertech.cloud/api/v1/groups/{id}/members" \
  -H "Authorization: Bearer $XISUITE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"user_id":"…"}'

Remove member(s) from a group#

DELETE/groups/{id}/membersToken

Parameter

Name	Ort	Typ	Beschreibung
`id`Pflicht	Pfad	`string`	–

Request-Body`application/jsonRemoveMembersDto`

Name	Typ	Beschreibung
`user_id`	`string`	Single user ID to remove
`user_ids`	`string[]`	Multiple user IDs to remove (bulk)

Antworten

200OK

Beispiel (cURL)

curl -X DELETE "https://xapi.ambertech.cloud/api/v1/groups/{id}/members" \
  -H "Authorization: Bearer $XISUITE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"user_id":"…","user_ids":[]}'

Get group memberships for several users#

GET/groups/membershipsToken

Returns a map of user id to the groups that user belongs to, restricted to the caller's organization and excluding soft-deleted groups. Every requested id is present in the response; users with no groups map to an empty array.

Parameter

Name	Ort	Typ	Beschreibung
`user_ids`Pflicht	Query	`string[]`	Comma-separated user ids

Antworten

200OK

Beispiel (cURL)

curl -X GET "https://xapi.ambertech.cloud/api/v1/groups/memberships" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

User Groups

List user groups#

Parameter

Antworten

Create a user group#

Request-Bodyapplication/jsonCreateUserGroupDto

Antworten

Get a user group by ID#

Parameter

Antworten

Update a user group#

Parameter

Request-Bodyapplication/jsonUpdateUserGroupDto

Antworten

Actions: restore | permanent_delete | duplicate#

Parameter

Request-Bodyapplication/jsonPatchUserGroupDto

Antworten

Soft-delete a user group#

Parameter

Antworten

List members of a group#

Parameter

Antworten

Add member(s) to a group#

Parameter

Request-Bodyapplication/jsonAddMembersDto

Antworten

Update role of a group member#

Parameter

Request-Bodyapplication/jsonUpdateMemberRoleDto

Antworten

Remove member(s) from a group#

Parameter

Request-Bodyapplication/jsonRemoveMembersDto

Antworten

Get group memberships for several users#

Parameter

Antworten

Request-Body`application/jsonCreateUserGroupDto`

Request-Body`application/jsonUpdateUserGroupDto`

Request-Body`application/jsonPatchUserGroupDto`

Request-Body`application/jsonAddMembersDto`

Request-Body`application/jsonUpdateMemberRoleDto`

Request-Body`application/jsonRemoveMembersDto`