core_users_list
GET/api/v3//core/users/
User Viewset
Request
Query Parameters
attributes string
Attributes
email string
groups_by_name string[]
groups_by_pk uuid[]
include_groups boolean
Default value: true
is_active boolean
is_superuser boolean
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.
path string
path_startswith string
search string
A search term.
type string[]
Possible values: [external, internal, internal_service_account, service_account]
username string
uuid uuid
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": 0,
"username": "string",
"name": "string",
"is_active": true,
"last_login": "2024-09-27T14:26:18.113Z",
"is_superuser": true,
"groups": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"groups_obj": [
{
"pk": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"num_pk": 0,
"name": "string",
"is_superuser": true,
"parent": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"parent_name": "string",
"attributes": {}
}
],
"email": "[email protected]",
"avatar": "string",
"attributes": {},
"uid": "string",
"path": "string",
"type": "internal",
"uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
]
}
- application/json
- Schema
- Example (from schema)
Schema
non_field_errors string[]
code string
{
"non_field_errors": [
"string"
],
"code": "string"
}
- application/json
- Schema
- Example (from schema)
Schema
detail stringrequired
code string
{
"detail": "string",
"code": "string"
}
- curl
- python
- go
- nodejs
- ruby
- csharp
- php
- java
- powershell
- CURL
curl -L -X GET '/api/v3/core/users/' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'