core_groups_list
GET/api/v3//core/groups/
Group Viewset
Request
Query Parameters
attributes string
Attributes
include_users boolean
Default value:
trueis_superuser boolean
members_by_pk integer[]
members_by_username string[]
Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.
name string
ordering string
Which field to use when ordering the results.
page integer
A page number within the paginated result set.
page_size integer
Number of results to return per page.
search string
A search term.
Responses
- 200
- 400
- 403
- application/json
- Schema
- Example (from schema)
Schema
pagination
object
required
results
object[]
required
{
"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": "[email protected]",
"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
non_field_errors string[]
code string
property name* any
Validation Error
{
"non_field_errors": [
"string"
],
"code": "string"
}
- application/json
- Schema
- Example (from schema)
Schema
detail stringrequired
code string
{
"detail": "string",
"code": "string"
}
Authorization: http
name: authentiktype: httpscheme: bearer
- csharp
- curl
- dart
- go
- http
- java
- javascript
- kotlin
- c
- nodejs
- objective-c
- ocaml
- php
- powershell
- python
- r
- ruby
- rust
- shell
- swift
- HTTPCLIENT
- RESTSHARP
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "/api/v3/core/groups/");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <TOKEN>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());