---
id: providers-scim-retrieve
title: "providers_scim_retrieve"
description: "SCIMProvider Viewset"
sidebar_label: "providers_scim_retrieve"
hide_title: true
hide_table_of_contents: true
api: eJytVttu2zgQ/RVCL7sLGFaQ9mHhp812g8BA0w2Sti+FIdDiWGJNkSovTr2G/r0zpGwrsZ1Ltw+GKYlzO2d4OJvMtGC5l0ZPRTbJWmtWUoB1hStlU1jwVsIKslEmwJVWtrQT9929m17f9HvZZwn3DjxuarnlDXi0zyZfNpmkrS33NX7S+AGfpMC1K2toeDbZZH7dxrfaQwU26x7HuWBBy28BWL+DrbiiJwHay8Va6or5WjpG+bBtQmMMYeFbkBawJm8DdLNR5nlFWe1LzPClgzJY6dcxXR58TX6X+DQjEwuuNdqBo1TPz87orzSYifa05G2rZBnBy786yndzWJqZf4XSPw3gHVjJlfwPERhRfkiJlylquzwCE2XGxb9arVN5WJz0inZM/yEME9Y7M4ck6oo+9L7XRYO54zs32MWt5Wt0LT007tB6lC2MbTgWnoWALHbH3BWVNaH9H04fw3TTR2DbCCw4EAytWAzFSkQiEhBagQtdjclJaRokrqfpcciHEa7As8QR21kxZ7CtuGf3wJba3LMaf94wENLjB2A7Uh/ygJG5c7LSIIo5L5dlzbUGVQwapXAqVM9nNUWmreaKDUwZ0TpKAEjNPt2+d+OfSuF4exwcvb3Fb44J6VrF1+wD2h6NugI7Nw5e6PwWfLC6xxHdP7B+xnvRqmC5en2QZPdsLBQwXjRGIGqvKkZuOYu27JT7YF+Q+t/cATFMXRe1jfQMnHfEf+BKrRlo4agP8tU5tbw3S9AvYLXXuL6lkhWaw/dSBQEFdheJP9iVLKHgZWnCg1M0N0YBjyYLqbDggyN/4mijKgWl+JxkKiLRDUX6ywu79qUHbCgBh4z2Cjkidd0il4h51MfHG2+219uhjKMkHugX4fT2l14cn/GiEIm8S2vN4Y2hEYOFBCUKoO+vkPguKqc4dnWQrAhUPwzL1c0wXrcHY59ayuwkHm9+IR5XoPH2LNnFzfQEIALZl0fO3JPVDluzdzCgvQ/6RJlJR2pDQ1XVz0Y4B02yfDd/5DRi5RspupxmIjxy27kpSkSW81bmqzd51g0GlTuCJdU1GFd2FdTet9sBKx5X4DZ2JpKuFybu7GvYm8cudynz87Pzt+M/x+cHOF/zJU1b/KF+ONm0Kl4IRCcvI53IG+Gd1aCU+asyu0hjaQh15BpwqorNmqbC6+nH/gCmEtwkzyvp6zAf4znOBy7y/WquzDzHUDp/P313+eHuMs0kxvmG64HzHeCMAGenZtpBR54ab3uQPXz3Od6GMspgr+eJ3uF4STTIBv8mUf6of2pMjjZtNnMU+E9WdR29Rmm3NILicsVxFIwiiX2Aly6tsYcWXDl4IuHfb/t+/YP99Mh8tLqtcmjSjeiJ2nuULWGdpvluhrtqvOSwzSjn9OGiLKH1A5ODI05NvTshV5fEP1E7vGpS7462C/J+NB1EM+74SEKOiG6z6y+3GR7QH5XShTA=
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 Heading from "@theme/Heading";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

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

<MethodEndpoint
  method={"get"}
  path={"/providers/scim/{id}/"}
>
  
</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"}
    >
      Path Parameters
    </h3>
  </summary><div>
    <ul>
      <ParamsItem
        className={"paramsItem"}
        param={{"in":"path","name":"id","schema":{"type":"integer"},"description":"A unique integer value identifying this SCIM Provider.","required":true}}
      >
        
      </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={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>
                    </ul>
                  </details>
                </TabItem><TabItem
                  label={"Example (from schema)"}
                  value={"Example (from schema)"}
                >
                  <ResponseSamples
                    responseExample={"{\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}"}
                    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>