---
id: providers-scim-list
title: "providers_scim_list"
description: "SCIMProvider Viewset"
sidebar_label: "providers_scim_list"
hide_title: true
hide_table_of_contents: true
api: eJytV0tv4zYQ/iuELr0YVprdQ5FT020QGEjSYLO7PSwCgZbGFtcUqSUpJ27g/94ZUrJpW36lPQSxTc6D38x8M/OW6BoMd0KrUZFcJbXRc1GAsZnNRZVJYV0ySAqwuRE13cI7T59G94/tPfZNwIsFulRzwytwKJtcfX9LBF392YBZ4JnCE/wKr7lsCsga6y2AmYscMp7nulGkwuYlVDy5ekvcoiaBsdYSuEqWy0G/xomQaDGbGt3UfQqsM0JN8WSiTcUd/tI0otivz//br8fLtVe1wfcH5QZ+NsIAAjjh0sJgU/Umen+XIi/ZRIAsmNMMoWAvJSjWqWOuBGbANtLZ4Ymu1HwKZ7pxzUiIqaYaYxRfhCuF8qbxZ6G4g6J1gmF0e/0QysEUzI4jmRX/nOvNQ3BDT7qXEzQGXGMUw/z0vp7shAVu8vJsPIIYw3SqjuLelzqNkQfFngeJ41MqjnWVJfijhbwxwi181fAGY6CcmOG3ZxJBPGqtLFhSeXlxQf9yja/GgsGPvK6lyH39pj8sveRt1wU9/gG5L1FD1e5E0NZGWgSpw3cVvLroVkibZEnXYC50Y3sPQ133njTGwJ4zpx2XGYW8X6t13LhMqAJee89BFXtPl3FWfA/Pih7Rubx2cNOdTeOxKYqucJJsPa5x9eZ8Qke+cGM45Y1wUNk+6A/Q7RNyBJdYYGY3nLOeuiD7vPhLSUwvZxpYezn6k7wLubuTrCvdi6zCFMPfTnnAfrLdVddS9vuVbsP02FpgnQWi1oKhFPOmWI5I+Dpp6gI/qOkwpGiF9bWZiiuTmxZuwbEQI7aSYlYja3LHXoDNlH5hJf4hd0EhnKfTVVA344CWubViqqDIxjyf5SVXCmQW1XNmZTM97tUII20UlywSZRTWQQAAaf3r5zvfSs53oT89drhzLfGLZYWwteQL9oCyvVbnYMbawonKP4cuEHBE9RvSR7RntWwMl+cbCXJHbeG4w7NKF4jaWY8RXcy8LNunnjrKUZV/cJwgMMKUdUQVjPgNrLMU/4ZLuWDIUpbyIJ1fBn6dgTohqm0ralMqSBG9Hhziema3weaUdrS0kZUaKfmYaMojsUXap2XtqQUWU8BuRAfdRIjs2iE3aFv9Vnb0JV7UFWIaR0rcelPUi9ctY7enQBGruaPp3KvajBxB/vE/jgqbGr9hzylCHtwYo3ebj0I4/UybAZ2f0S2WnoSLvi5EDFUgkaJZLh9je8s1MmvXgmd78fjwP+JxCwobcc6uH0d7ACkwkURP+R58bZwRrYIoB1qjB54ZKKnUtMlN26XMlfglXU2cKe11KQ0yWLjdruaJJkl5LdL5hzRZRlPpEyESnhTNpivnS+dWe5cvehyi2zlLqIn2N1v31+K+Vmxw+vLi8uPwt+GvOxDf8xltQ3yThayoaunbCkWS5z6SGDKCOilBSv37VK8sDYUmwDHMgCO0z9Mwq9+PvrRlHJ5gr9J0ijtQMx4iG6SRinT9aSz1OEVTKr0bfbp5eLoJk422ruIqUr7CmhHWrG+HjhJx3zrdAuxwQk2xnwpPpG1HCFGN9wgKgajwHyVMiS7R8dvbGJvDVyOXS/o57CsUb2zRRK/rxWgGixPW8zmXDYR62qtjayE/RaTjz4NX98J37j7di2twJNro3+nM2Vv1AW/apf6dnpy6UR9xoFvm343H1lZ9wNxqbT8lZ9oOvLr5TF9wNfJDA27OWAQ4TSETUboHkes8hzpO450GQFpW/Hl7QxRB1R/PNIHeBt0H0t61ObWIdGPp+RtfaGLA8uv8bqeoZ6TvfwHbAsfe
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_list"}
>
</Heading>

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



SCIMProvider 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":"exclude_users_service_account","schema":{"type":"boolean"}}}
      >
        
      </ParamsItem><ParamsItem
        className={"paramsItem"}
        param={{"in":"query","name":"filter_group","schema":{"type":"string","format":"uuid"}}}
      >
        
      </ParamsItem><ParamsItem
        className={"paramsItem"}
        param={{"in":"query","name":"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={{"name":"search","required":false,"in":"query","description":"A search term.","schema":{"type":"string"}}}
      >
        
      </ParamsItem><ParamsItem
        className={"paramsItem"}
        param={{"in":"query","name":"url","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={"pk"}
                              required={true}
                              schemaName={"ID (integer)"}
                              qualifierMessage={undefined}
                              schema={{"type":"integer","readOnly":true,"title":"ID"}}
                            >
                              
                            </SchemaItem><SchemaItem
                              collapsible={false}
                              name={"name"}
                              required={true}
                              schemaName={"string"}
                              qualifierMessage={undefined}
                              schema={{"type":"string"}}
                            >
                              
                            </SchemaItem><SchemaItem
                              collapsible={false}
                              name={"property_mappings"}
                              required={false}
                              schemaName={"uuid[]"}
                              qualifierMessage={undefined}
                              schema={{"type":"array","items":{"type":"string","format":"uuid"}}}
                            >
                              
                            </SchemaItem><SchemaItem
                              collapsible={false}
                              name={"property_mappings_group"}
                              required={false}
                              schemaName={"uuid[]"}
                              qualifierMessage={undefined}
                              schema={{"type":"array","items":{"type":"string","format":"uuid"},"description":"Property mappings used for group creation/updating."}}
                            >
                              
                            </SchemaItem><SchemaItem
                              collapsible={false}
                              name={"component"}
                              required={true}
                              schemaName={"string"}
                              qualifierMessage={undefined}
                              schema={{"type":"string","description":"Get object component so that we know how to edit the object","readOnly":true}}
                            >
                              
                            </SchemaItem><SchemaItem
                              collapsible={false}
                              name={"assigned_backchannel_application_slug"}
                              required={true}
                              schemaName={"string"}
                              qualifierMessage={undefined}
                              schema={{"type":"string","description":"Internal application name, used in URLs.","readOnly":true}}
                            >
                              
                            </SchemaItem><SchemaItem
                              collapsible={false}
                              name={"assigned_backchannel_application_name"}
                              required={true}
                              schemaName={"string"}
                              qualifierMessage={undefined}
                              schema={{"type":"string","description":"Application's display Name.","readOnly":true}}
                            >
                              
                            </SchemaItem><SchemaItem
                              collapsible={false}
                              name={"verbose_name"}
                              required={true}
                              schemaName={"string"}
                              qualifierMessage={undefined}
                              schema={{"type":"string","description":"Return object's verbose_name","readOnly":true}}
                            >
                              
                            </SchemaItem><SchemaItem
                              collapsible={false}
                              name={"verbose_name_plural"}
                              required={true}
                              schemaName={"string"}
                              qualifierMessage={undefined}
                              schema={{"type":"string","description":"Return object's plural verbose_name","readOnly":true}}
                            >
                              
                            </SchemaItem><SchemaItem
                              collapsible={false}
                              name={"meta_model_name"}
                              required={true}
                              schemaName={"string"}
                              qualifierMessage={undefined}
                              schema={{"type":"string","description":"Return internal model name","readOnly":true}}
                            >
                              
                            </SchemaItem><SchemaItem
                              collapsible={false}
                              name={"url"}
                              required={true}
                              schemaName={"string"}
                              qualifierMessage={undefined}
                              schema={{"type":"string","description":"Base URL to SCIM requests, usually ends in /v2"}}
                            >
                              
                            </SchemaItem><SchemaItem
                              collapsible={false}
                              name={"token"}
                              required={true}
                              schemaName={"string"}
                              qualifierMessage={undefined}
                              schema={{"type":"string","description":"Authentication token"}}
                            >
                              
                            </SchemaItem><SchemaItem
                              collapsible={false}
                              name={"exclude_users_service_account"}
                              required={false}
                              schemaName={"boolean"}
                              qualifierMessage={undefined}
                              schema={{"type":"boolean"}}
                            >
                              
                            </SchemaItem><SchemaItem
                              collapsible={false}
                              name={"filter_group"}
                              required={false}
                              schemaName={"uuid"}
                              qualifierMessage={undefined}
                              schema={{"type":"string","format":"uuid","nullable":true}}
                            >
                              
                            </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      \"pk\": 0,\n      \"name\": \"string\",\n      \"property_mappings\": [\n        \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n      ],\n      \"property_mappings_group\": [\n        \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n      ],\n      \"component\": \"string\",\n      \"assigned_backchannel_application_slug\": \"string\",\n      \"assigned_backchannel_application_name\": \"string\",\n      \"verbose_name\": \"string\",\n      \"verbose_name_plural\": \"string\",\n      \"meta_model_name\": \"string\",\n      \"url\": \"string\",\n      \"token\": \"string\",\n      \"exclude_users_service_account\": true,\n      \"filter_group\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\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>