User group assigment

The user group assigment.

Create a user group assignment

Create a new user group assignment for a user and a group.

SecurityJWT
Request
Request Body schema: application/json

A JSON object containing user group assignment information.

user
required
string or integer

The user of the user group assignment.

Without a user the request will always return a 403 Forbidden response.

group
required
string or integer

The group of the user group assignment.

Without a group the request will always return a 403 Forbidden response.

Responses
200

Successful operation

201

Successful operation

post/usergroupassignment
Request samples
application/json
{
  • "user": 6,
  • "group": 8
}
Response samples
application/json
{
  • "success": true,
  • "hash": "ba9f5616f88b108a0ae6818d23a9a5c83119bffc",
  • "data": {
    },
  • "timestamp": 1681293521098
}

Get all user group assignments

Get all user group assignments of the authenticated hub.

SecurityJWT
Request
query Parameters
group
string or integer

Filter the user group assignment list for a group.

page
integer
Default: 1

The page number of the response.

Responses
200

Successful operation

get/usergroupassignment
Request samples
Response samples
application/json
{
  • "success": true,
  • "hash": "ba9031f23a3459812c9dd3ce9d5e650e70d8b07e",
  • "data": [
    ],
  • "meta": {
    },
  • "timestamp": 1661948985925
}

Get a user group assignment

Get a user group assignment.

SecurityJWT
Request
path Parameters
usergroupassignment
required
string

The hash of the user group assignment.

Responses
200

Successful operation

404

Not Found

get/usergroupassignment/{usergroupassignment}
Request samples
Response samples
application/json
{
  • "success": true,
  • "hash": "265d9f6fcb0cdb1dd438ac11a5919642838a1450",
  • "data": {
    },
  • "timestamp": 1661949528292
}

Delete a user group assignment

Delete a user group assignment.

SecurityJWT
Request
path Parameters
usergroupassignment
required
string

The hash of the user group assignment.

Responses
200

Successful operation

404

Not Found

delete/usergroupassignment/{usergroupassignment}
Request samples
Response samples
application/json
{
  • "success": true,
  • "hash": "8739602554c7f3241958e3cc9b57fdecb474d508",
  • "data": { },
  • "timestamp": 1661438926362
}