providers_scim_users_list
GET/providers/scim_users/
SCIMProviderUser Viewset
Request
Query Parameters
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.
provider__id integer
search string
A search term.
user__id integer
user__username string
Responses
- 200
- 400
- 403
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
pagination
object
required
next numberrequired
previous numberrequired
count numberrequired
current numberrequired
total_pages numberrequired
start_index numberrequired
end_index numberrequired
results
object[]
required
id uuidrequired
scim_id stringrequired
user integerrequired
user_obj
object
required
Stripped down user serializer to show relevant users for groups
pk ID (integer)required
username stringrequired
Possible values: <= 150 characters
, Value must match regular expression ^[\w.@+-]+$
Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.
name stringrequired
User's display name.
is_active Active (boolean)
Designates whether this user should be treated as active. Unselect this instead of deleting accounts.
last_login date-timenullable
email email
Possible values: <= 254 characters
attributes object
uid stringrequired
provider integerrequired
{
"pagination": {
"next": 0,
"previous": 0,
"count": 0,
"current": 0,
"total_pages": 0,
"start_index": 0,
"end_index": 0
},
"results": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"scim_id": "string",
"user": 0,
"user_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"
},
"provider": 0
}
]
}
- 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"
}
Loading...