sources_scim_groups_list

GET /sources/scim_groups/

SCIMSourceGroup Viewset

Request

Query Parameters

group__group_uuid uuid

group__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.

source__slug string

Responses

application/json

Schema
Example (from schema)

Schema

pagination

object

required

next numberrequired

previous numberrequired

count numberrequired

current numberrequired

total_pages numberrequired

start_index numberrequired

end_index numberrequired

results

object[]

required

Array [

id stringrequired

group uuidrequired

group_obj

object

required

Simplified Group Serializer for user's groups

pk uuidrequired

num_pk integerrequired

Get a numerical, int32 ID for the group

name stringrequired

is_superuser boolean

Users added to this group will be superusers.

parent uuidnullable

parent_name stringnullablerequired

attributes object

source uuidrequired

attributes

]

{
  "pagination": {
    "next": 0,
    "previous": 0,
    "count": 0,
    "current": 0,
    "total_pages": 0,
    "start_index": 0,
    "end_index": 0
  },
  "results": [
    {
      "id": "string",
      "group": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "group_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": {}
      },
      "source": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "attributes": {}
    }
  ]
}

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"
}

sources_scim_groups_list