---
id: providers-scim-groups-list
title: "providers_scim_groups_list"
description: "SCIMProviderGroup Viewset"
sidebar_label: "providers_scim_groups_list"
hide_title: true
hide_table_of_contents: true
api: eJytV0tv2zgQ/iuELnsxomzSwyKnDbpBYKBpA6TtHopAoKSxxYYmVZJKmjX833eGlCzakl9pT4nMeXzz+jhcJroGw53QalomV0lt9LMowdjMFmKRzY1uaptJYV0ySUqwhRE1CaPow/vp3X0rfkty7KuAFwskWXPDF+DQTnL1bZkIkv/RgHnFM4Un+OlNZ8FD1jSixCNbVLDgydUyca81CVlnhJrjyUybBXf4i5dcrSZ7jfqv3ea8equhDcIPPgz8aIQBTMOMSwuTTQ+bwf9biaJiMwGyZE6zxgJ7qUCxzhxzFTADtpHOnh0JpeZzOBHGNSMlpppFDoa9CFcJ5V3jz0JxB2ULgmFdRnEI5WAOZgAks+K/U9F8DDD0rIucUmPANUYx7DKP9TCIsbp2bZll430yFoUFborq5IQGNYa9u9hfuMdJ4vicGryfmgR/tFA0RrhX3/m8wWooJ57w65FUMDO1VhYsmbw4P6c/hUb4ytG/vK6lKPw8pt8tQVoOIej8OxR+zAxNrxPBWltzEbT2yyr46SKp0EDJisTgWejGjh4WulHjahiygR1nTjsuMyr+uFXruHGZUCX8HD0HVe48XcXl/RbCioLoIPcAN+FsOo9dUXWFk+Trvs+rd+dbO8LCjeHUScLBwo6l/hBvPiBlcInzZgZ1wnY/yIaEiZeflMSWc6YBSimR95gunnmOPIJjW8kMw/CdKeWnme/pA+GJBbYwMmPJtqNj6IGo0vxhWbhZhj38dHq8faWCww4+9ki2Ya9jiW3It+AYJxJFpAWXE4aClxds+o8HTHQacjaS6MA1I1kWeIM2GBiFGwnkWkvgagDhC4pZxssS/H2CPN6mCEldSpYDW1vD+2Tlb9jNeduZLNVIyXPKT4s5qGbj0IfJHehzh6J542C02TEGQUFxeR9XdjUY1XBHt0XaRDWhPogmkLLja5sECt0qQke/4xfChteukH1rTxKfpbWNfngiAIOZTQbxROzbk8SQRaAc2PpA25W3t9kTVOZ3v3hDbFr8inNYelV2Y4we0o3SKvNLTQZ0fgzL9YsMoizHhmG1uyn69PTQArKd+bj8jfm4BUUjz67vpzsSUoLjQo5O+O5o47ZoDUSN0DrdEyb+hMtzpWkhn7f7tKvwI10vGmm0nqfUs2Ceu227MZJkeS3S58vUj0y3kzxQYkJk0WayjqFyru52Hs9WuAu1QyTUTHvJNopefZKQ54D94vzi3dlfZ38OMn3Hn2gr7rRCvZilu8KvhFRQXviCYuUo40kFUuq/53rt6UxoyjtWG3CB8u0aNr276Wc0EcKmEOxVms5xF27ys0Iv0shE2v+XS52n6EqlH6bvbz4+3Pgwa23dgqvI+DrljFLe3lts7EUUteXex1GbbIe7SlpLREBRefTLttDxRtny0fq+pFaqECVJLZc5t/DFyNWKfg4rLbVAKSxRdr/yPsHrjjfXM5cNhOk6pNdy836NnSk59ck0mqaAJ3q0vRHMyQ+nPWjad9sbkRz7aDoAoHuvHVPOrdfUm1O49VTag3D9Fut9PdIHboZ+s8C3EXY13ut0iWP/Bq3rooDaRVoDricra6q8vSEaoAmPF65AYZPun2iB5eo1so2z5CU+6ydQOE8ddEff6AiZ+n+okvEn
sidebar_class_name: "get api-method"
info_path: docs/developer-docs/api/reference/authentik
custom_edit_url: null
hide_send_button: true
---

import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import Heading from "@theme/Heading";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"providers_scim_groups_list"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/providers/scim_groups/"}
>
  
</MethodEndpoint>



SCIMProviderGroup Viewset

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<details
  style={{"marginBottom":"1rem"}}
  className={"openapi-markdown__details"}
  data-collapsed={false}
  open={true}
>
  <summary
    style={{}}
  >
    <h3
      className={"openapi-markdown__details-summary-header-params"}
    >
      Query Parameters
    </h3>
  </summary><div>
    <ul>
      <ParamsItem
        className={"paramsItem"}
        param={{"in":"query","name":"group__group_uuid","schema":{"type":"string","format":"uuid"}}}
      >
        
      </ParamsItem><ParamsItem
        className={"paramsItem"}
        param={{"in":"query","name":"group__name","schema":{"type":"string"}}}
      >
        
      </ParamsItem><ParamsItem
        className={"paramsItem"}
        param={{"name":"ordering","required":false,"in":"query","description":"Which field to use when ordering the results.","schema":{"type":"string"}}}
      >
        
      </ParamsItem><ParamsItem
        className={"paramsItem"}
        param={{"name":"page","required":false,"in":"query","description":"A page number within the paginated result set.","schema":{"type":"integer"}}}
      >
        
      </ParamsItem><ParamsItem
        className={"paramsItem"}
        param={{"name":"page_size","required":false,"in":"query","description":"Number of results to return per page.","schema":{"type":"integer"}}}
      >
        
      </ParamsItem><ParamsItem
        className={"paramsItem"}
        param={{"in":"query","name":"provider__id","schema":{"type":"integer"}}}
      >
        
      </ParamsItem><ParamsItem
        className={"paramsItem"}
        param={{"name":"search","required":false,"in":"query","description":"A search term.","schema":{"type":"string"}}}
      >
        
      </ParamsItem>
    </ul>
  </div>
</details><div>
  <div>
    <ApiTabs
      label={undefined}
      id={undefined}
    >
      <TabItem
        label={"200"}
        value={"200"}
      >
        <div>
          
          
          
          
          
        </div><div>
          <MimeTabs
            className={"openapi-tabs__mime"}
            schemaType={"response"}
          >
            <TabItem
              label={"application/json"}
              value={"application/json"}
            >
              <SchemaTabs
                className={"openapi-tabs__schema"}
              >
                <TabItem
                  label={"Schema"}
                  value={"Schema"}
                >
                  <details
                    style={{}}
                    className={"openapi-markdown__details response"}
                    data-collapsed={false}
                    open={true}
                  >
                    <summary
                      style={{}}
                      className={"openapi-markdown__details-summary-response"}
                    >
                      <strong>
                        Schema
                      </strong>
                    </summary><div
                      style={{"textAlign":"left","marginLeft":"1rem"}}
                    >
                      
                    </div><ul
                      style={{"marginLeft":"1rem"}}
                    >
                      <SchemaItem
                        collapsible={true}
                        className={"schemaItem"}
                      >
                        <details
                          style={{}}
                          className={"openapi-markdown__details"}
                        >
                          <summary
                            style={{}}
                          >
                            <span
                              className={"openapi-schema__container"}
                            >
                              <strong
                                className={"openapi-schema__property"}
                              >
                                pagination
                              </strong><span
                                className={"openapi-schema__name"}
                              >
                                 object
                              </span><span
                                className={"openapi-schema__divider"}
                              >
                                
                              </span><span
                                className={"openapi-schema__required"}
                              >
                                required
                              </span>
                            </span>
                          </summary><div
                            style={{"marginLeft":"1rem"}}
                          >
                            <SchemaItem
                              collapsible={false}
                              name={"next"}
                              required={true}
                              schemaName={"number"}
                              qualifierMessage={undefined}
                              schema={{"type":"number"}}
                            >
                              
                            </SchemaItem><SchemaItem
                              collapsible={false}
                              name={"previous"}
                              required={true}
                              schemaName={"number"}
                              qualifierMessage={undefined}
                              schema={{"type":"number"}}
                            >
                              
                            </SchemaItem><SchemaItem
                              collapsible={false}
                              name={"count"}
                              required={true}
                              schemaName={"number"}
                              qualifierMessage={undefined}
                              schema={{"type":"number"}}
                            >
                              
                            </SchemaItem><SchemaItem
                              collapsible={false}
                              name={"current"}
                              required={true}
                              schemaName={"number"}
                              qualifierMessage={undefined}
                              schema={{"type":"number"}}
                            >
                              
                            </SchemaItem><SchemaItem
                              collapsible={false}
                              name={"total_pages"}
                              required={true}
                              schemaName={"number"}
                              qualifierMessage={undefined}
                              schema={{"type":"number"}}
                            >
                              
                            </SchemaItem><SchemaItem
                              collapsible={false}
                              name={"start_index"}
                              required={true}
                              schemaName={"number"}
                              qualifierMessage={undefined}
                              schema={{"type":"number"}}
                            >
                              
                            </SchemaItem><SchemaItem
                              collapsible={false}
                              name={"end_index"}
                              required={true}
                              schemaName={"number"}
                              qualifierMessage={undefined}
                              schema={{"type":"number"}}
                            >
                              
                            </SchemaItem>
                          </div>
                        </details>
                      </SchemaItem><SchemaItem
                        collapsible={true}
                        className={"schemaItem"}
                      >
                        <details
                          style={{}}
                          className={"openapi-markdown__details"}
                        >
                          <summary
                            style={{}}
                          >
                            <span
                              className={"openapi-schema__container"}
                            >
                              <strong
                                className={"openapi-schema__property"}
                              >
                                results
                              </strong><span
                                className={"openapi-schema__name"}
                              >
                                 object[]
                              </span><span
                                className={"openapi-schema__divider"}
                              >
                                
                              </span><span
                                className={"openapi-schema__required"}
                              >
                                required
                              </span>
                            </span>
                          </summary><div
                            style={{"marginLeft":"1rem"}}
                          >
                            <li>
                              <div
                                style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}
                              >
                                Array [
                              </div>
                            </li><SchemaItem
                              collapsible={false}
                              name={"id"}
                              required={true}
                              schemaName={"uuid"}
                              qualifierMessage={undefined}
                              schema={{"type":"string","format":"uuid","readOnly":true}}
                            >
                              
                            </SchemaItem><SchemaItem
                              collapsible={false}
                              name={"scim_id"}
                              required={true}
                              schemaName={"string"}
                              qualifierMessage={undefined}
                              schema={{"type":"string"}}
                            >
                              
                            </SchemaItem><SchemaItem
                              collapsible={false}
                              name={"group"}
                              required={true}
                              schemaName={"uuid"}
                              qualifierMessage={undefined}
                              schema={{"type":"string","format":"uuid"}}
                            >
                              
                            </SchemaItem><SchemaItem
                              collapsible={true}
                              className={"schemaItem"}
                            >
                              <details
                                style={{}}
                                className={"openapi-markdown__details"}
                              >
                                <summary
                                  style={{}}
                                >
                                  <span
                                    className={"openapi-schema__container"}
                                  >
                                    <strong
                                      className={"openapi-schema__property"}
                                    >
                                      group_obj
                                    </strong><span
                                      className={"openapi-schema__name"}
                                    >
                                       object
                                    </span><span
                                      className={"openapi-schema__divider"}
                                    >
                                      
                                    </span><span
                                      className={"openapi-schema__required"}
                                    >
                                      required
                                    </span>
                                  </span>
                                </summary><div
                                  style={{"marginLeft":"1rem"}}
                                >
                                  <div
                                    style={{"marginTop":".5rem","marginBottom":".5rem"}}
                                  >
                                    
                                    
                                    Simplified Group Serializer for user's groups
                                    
                                    
                                  </div><SchemaItem
                                    collapsible={false}
                                    name={"pk"}
                                    required={true}
                                    schemaName={"uuid"}
                                    qualifierMessage={undefined}
                                    schema={{"type":"string","format":"uuid","readOnly":true,"title":"Group uuid"}}
                                  >
                                    
                                  </SchemaItem><SchemaItem
                                    collapsible={false}
                                    name={"num_pk"}
                                    required={true}
                                    schemaName={"integer"}
                                    qualifierMessage={undefined}
                                    schema={{"type":"integer","description":"Get a numerical, int32 ID for the group","readOnly":true}}
                                  >
                                    
                                  </SchemaItem><SchemaItem
                                    collapsible={false}
                                    name={"name"}
                                    required={true}
                                    schemaName={"string"}
                                    qualifierMessage={undefined}
                                    schema={{"type":"string"}}
                                  >
                                    
                                  </SchemaItem><SchemaItem
                                    collapsible={false}
                                    name={"is_superuser"}
                                    required={false}
                                    schemaName={"boolean"}
                                    qualifierMessage={undefined}
                                    schema={{"type":"boolean","description":"Users added to this group will be superusers."}}
                                  >
                                    
                                  </SchemaItem><SchemaItem
                                    collapsible={false}
                                    name={"parent"}
                                    required={false}
                                    schemaName={"uuid"}
                                    qualifierMessage={undefined}
                                    schema={{"type":"string","format":"uuid","nullable":true}}
                                  >
                                    
                                  </SchemaItem><SchemaItem
                                    collapsible={false}
                                    name={"parent_name"}
                                    required={true}
                                    schemaName={"string"}
                                    qualifierMessage={undefined}
                                    schema={{"type":"string","readOnly":true,"nullable":true}}
                                  >
                                    
                                  </SchemaItem><SchemaItem
                                    collapsible={false}
                                    name={"attributes"}
                                    required={false}
                                    schemaName={"object"}
                                    qualifierMessage={undefined}
                                    schema={{"type":"object"}}
                                  >
                                    
                                  </SchemaItem>
                                </div>
                              </details>
                            </SchemaItem><SchemaItem
                              collapsible={false}
                              name={"provider"}
                              required={true}
                              schemaName={"integer"}
                              qualifierMessage={undefined}
                              schema={{"type":"integer"}}
                            >
                              
                            </SchemaItem><li>
                              <div
                                style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}
                              >
                                ]
                              </div>
                            </li>
                          </div>
                        </details>
                      </SchemaItem>
                    </ul>
                  </details>
                </TabItem><TabItem
                  label={"Example (from schema)"}
                  value={"Example (from schema)"}
                >
                  <ResponseSamples
                    responseExample={"{\n  \"pagination\": {\n    \"next\": 0,\n    \"previous\": 0,\n    \"count\": 0,\n    \"current\": 0,\n    \"total_pages\": 0,\n    \"start_index\": 0,\n    \"end_index\": 0\n  },\n  \"results\": [\n    {\n      \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n      \"scim_id\": \"string\",\n      \"group\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n      \"group_obj\": {\n        \"pk\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n        \"num_pk\": 0,\n        \"name\": \"string\",\n        \"is_superuser\": true,\n        \"parent\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n        \"parent_name\": \"string\",\n        \"attributes\": {}\n      },\n      \"provider\": 0\n    }\n  ]\n}"}
                    language={"json"}
                  >
                    
                  </ResponseSamples>
                </TabItem>
              </SchemaTabs>
            </TabItem>
          </MimeTabs>
        </div>
      </TabItem><TabItem
        label={"400"}
        value={"400"}
      >
        <div>
          
          
          
          
          
        </div><div>
          <MimeTabs
            className={"openapi-tabs__mime"}
            schemaType={"response"}
          >
            <TabItem
              label={"application/json"}
              value={"application/json"}
            >
              <SchemaTabs
                className={"openapi-tabs__schema"}
              >
                <TabItem
                  label={"Schema"}
                  value={"Schema"}
                >
                  <details
                    style={{}}
                    className={"openapi-markdown__details response"}
                    data-collapsed={false}
                    open={true}
                  >
                    <summary
                      style={{}}
                      className={"openapi-markdown__details-summary-response"}
                    >
                      <strong>
                        Schema
                      </strong>
                    </summary><div
                      style={{"textAlign":"left","marginLeft":"1rem"}}
                    >
                      
                    </div><ul
                      style={{"marginLeft":"1rem"}}
                    >
                      <SchemaItem
                        collapsible={false}
                        name={"non_field_errors"}
                        required={false}
                        schemaName={"string[]"}
                        qualifierMessage={undefined}
                        schema={{"type":"array","items":{"type":"string"}}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={false}
                        name={"code"}
                        required={false}
                        schemaName={"string"}
                        qualifierMessage={undefined}
                        schema={{"type":"string"}}
                      >
                        
                      </SchemaItem><SchemaItem
                        name={"property name*"}
                        required={false}
                        schemaName={"any"}
                        qualifierMessage={undefined}
                        schema={{"type":"object","description":"Validation Error","properties":{"non_field_errors":{"type":"array","items":{"type":"string"}},"code":{"type":"string"}},"additionalProperties":{},"title":"ValidationError"}}
                        collapsible={false}
                        discriminator={false}
                      >
                        
                      </SchemaItem>
                    </ul>
                  </details>
                </TabItem><TabItem
                  label={"Example (from schema)"}
                  value={"Example (from schema)"}
                >
                  <ResponseSamples
                    responseExample={"{\n  \"non_field_errors\": [\n    \"string\"\n  ],\n  \"code\": \"string\"\n}"}
                    language={"json"}
                  >
                    
                  </ResponseSamples>
                </TabItem>
              </SchemaTabs>
            </TabItem>
          </MimeTabs>
        </div>
      </TabItem><TabItem
        label={"403"}
        value={"403"}
      >
        <div>
          
          
          
          
          
        </div><div>
          <MimeTabs
            className={"openapi-tabs__mime"}
            schemaType={"response"}
          >
            <TabItem
              label={"application/json"}
              value={"application/json"}
            >
              <SchemaTabs
                className={"openapi-tabs__schema"}
              >
                <TabItem
                  label={"Schema"}
                  value={"Schema"}
                >
                  <details
                    style={{}}
                    className={"openapi-markdown__details response"}
                    data-collapsed={false}
                    open={true}
                  >
                    <summary
                      style={{}}
                      className={"openapi-markdown__details-summary-response"}
                    >
                      <strong>
                        Schema
                      </strong>
                    </summary><div
                      style={{"textAlign":"left","marginLeft":"1rem"}}
                    >
                      
                    </div><ul
                      style={{"marginLeft":"1rem"}}
                    >
                      <SchemaItem
                        collapsible={false}
                        name={"detail"}
                        required={true}
                        schemaName={"string"}
                        qualifierMessage={undefined}
                        schema={{"type":"string"}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={false}
                        name={"code"}
                        required={false}
                        schemaName={"string"}
                        qualifierMessage={undefined}
                        schema={{"type":"string"}}
                      >
                        
                      </SchemaItem>
                    </ul>
                  </details>
                </TabItem><TabItem
                  label={"Example (from schema)"}
                  value={"Example (from schema)"}
                >
                  <ResponseSamples
                    responseExample={"{\n  \"detail\": \"string\",\n  \"code\": \"string\"\n}"}
                    language={"json"}
                  >
                    
                  </ResponseSamples>
                </TabItem>
              </SchemaTabs>
            </TabItem>
          </MimeTabs>
        </div>
      </TabItem>
    </ApiTabs>
  </div>
</div>