core_groups_list
GET/core/groups/
Group Viewset
Request
Query Parameters
Attributes
Default value: true
Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.
Which field to use when ordering the results.
A page number within the paginated result set.
Number of results to return per page.
A search term.
Responses
- 200
- 400
- 403
- application/json
- Schema
- Example (from schema)
Schema
Array [
Array [
]
Array [
]
]
pagination
object
required
results
object[]
required
Users added to this group will be superusers.
users_obj
object[]
nullable
required
Possible values: <= 150 characters, Value must match regular expression ^[\w.@+-]+$
Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.
User's display name.
Designates whether this user should be treated as active. Unselect this instead of deleting accounts.
Possible values: <= 254 characters
attributes
object
attributes
object
roles_obj
object[]
required
Possible values: <= 150 characters
{
"pagination": {
"next": 0,
"previous": 0,
"count": 0,
"current": 0,
"total_pages": 0,
"start_index": 0,
"end_index": 0
},
"results": [
{
"pk": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"num_pk": 0,
"name": "string",
"is_superuser": true,
"parent": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"parent_name": "string",
"users": [
0
],
"users_obj": [
{
"pk": 0,
"username": "string",
"name": "string",
"is_active": true,
"last_login": "2024-07-29T15:51:28.071Z",
"email": "user@example.com",
"attributes": {},
"uid": "string"
}
],
"attributes": {},
"roles": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"roles_obj": [
{
"pk": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string"
}
]
}
]
}
- application/json
- Schema
- Example (from schema)
Schema
Validation Error
{
"non_field_errors": [
"string"
],
"code": "string"
}
- application/json
- Schema
- Example (from schema)
Schema
{
"detail": "string",
"code": "string"
}