---
id: providers-scim-sync-status-retrieve
title: "providers_scim_sync_status_retrieve"
description: "Get provider's sync status"
sidebar_label: "providers_scim_sync_status_retrieve"
hide_title: true
hide_table_of_contents: true
api: eJytV0tvIzcM/ivCXNoCrifI5lD41GBrBAaSNlhne1kEhjxD21prpFk9nLjG/PclpRlbtifZR3OyNBLJj+RHit5lugbDndBqUmajrDZ6I0owdmYLUc3sVhUz67jzdmbAGQEbyAZZCbYwoiYplLkBxzq5XywjGRZl8GrNDa/AocZs9GmXCRKouVvhkcID3IkS17ZYQcWz0S5z2zp8VQ6WYLLm1No180p88cDaG2zDJe1KUE4stkItmVsJy6bvJ3fsvoU1RBMGvnhhAL10xkPzOMgcXxKqg9MZfrRQeCPcNsDl3q1I7xp3jyRiwNZaWbAE9fLign4KjUiUoyWvaymKEM78syW8u3PX9PwzFO4sjB3W0wAaypAT0aTAPHil0MtE4VxrCVwFH3n5j5Lb1kdy0a5tcpUbw7d4UTio7LcxTcEILsV/wB5Q0UQtNOOqDJsPYL10ZwC9x3we9FrkDGIdZAttKo4xihd6kEY2nAriwcJLOes/7WMiXWd0nT0Jt2IfJ3/1WetFecq1nnNMi3EzJyrAVVW/6mnJHfxOV/sALIQSdvUWmkof6zfRoHw1x9pJNWg/l73iLdFQGFCMysGrtdJPRCfriwKsxZDi5okbFXGBMdpQrZwCdsJJ+jDdWuQXsWQatI9JM9pCXy1fwv8hJBqSwKReslZZTDPHpIc6fHZ0uIRyeEbNH401AkZVM4k9T6bxQTgOi5xiAs8FRGhdVGKcjsIlsGyCI3NPW6WdBfda+G718paMdmELDplePuK12HnOTrjD5dw76I0qL0tBuLm8T2PUNE3aKD+lWjpjaVT22AZJdB+PPBkHIdILzzWqtd/NdIWVzIm1HVWDgv7Wd4o7ZU1SIj11lzaYhKFtQzqv+H3FDGIre+yjfdacVdoJwKSRd136SJMqYulkISXHRUDar9707fkXm3wZRNm4pfFx7SitZgsBspwFmn9PBXdURLCFLvt6e/MyDw+hOECLyF6Mx7s3jMcNKHz5CnZ9P3khICU4LmRv5b3s7TFDg4Ik6a3Rb7h5Fa2nB8Q4hm2FLbRXZbCEI9dK00C3hPBG08Q1yvL9pJPTeJfvRNnkNG7kkdM5sRvMppvWvJEkxWuRb97lWZOMR1OKZAxFMiTtnV45V3djXahT4IamuaZth6EdR7cP4oOMLEefLi8ur4Z/DC/PUnPH1zTjdVIxwcyKqpZAPZ8YwIvAAEw1pShbgZT6z6XeWxoKHfqqKABnucDvOIveTR6oroPb5IId5fkS3xc/Hxa6yhMV+WE1l3qeoymV307ej/+ejoObtbau4ipRvg8+o+CnYx57abZOCP36mN2Gnd6/vJaIhfwLfuza5KdjLiVGVPgzisM3qkr7GpFyhfBJaLebcwsfjWwa+oyDt6HRGJcbjrNhaM/IlFJYWiPjFlxaeMWNXz+0RfAb++lRvtfbrh0pakZBE9XMIFvDNv7LaB7x1gq7Mr2liDkeXBf0hCciZ32DaL+vp5sxMYSSn75Ckd2DbkHae+FgNMONB70GhRHt0DnaE8Cm+Qri0LTK
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_sync_status_retrieve"}
>
</Heading>

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



Get provider's sync status

<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={"is_running"}
                        required={true}
                        schemaName={"boolean"}
                        qualifierMessage={undefined}
                        schema={{"type":"boolean","readOnly":true}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={true}
                        className={"schemaItem"}
                      >
                        <details
                          style={{}}
                          className={"openapi-markdown__details"}
                        >
                          <summary
                            style={{}}
                          >
                            <span
                              className={"openapi-schema__container"}
                            >
                              <strong
                                className={"openapi-schema__property"}
                              >
                                tasks
                              </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={"uuid"}
                              required={true}
                              schemaName={"uuid"}
                              qualifierMessage={undefined}
                              schema={{"type":"string","format":"uuid","readOnly":true}}
                            >
                              
                            </SchemaItem><SchemaItem
                              collapsible={false}
                              name={"name"}
                              required={true}
                              schemaName={"string"}
                              qualifierMessage={undefined}
                              schema={{"type":"string"}}
                            >
                              
                            </SchemaItem><SchemaItem
                              collapsible={false}
                              name={"full_name"}
                              required={true}
                              schemaName={"string"}
                              qualifierMessage={undefined}
                              schema={{"type":"string","description":"Get full name with UID","readOnly":true}}
                            >
                              
                            </SchemaItem><SchemaItem
                              collapsible={false}
                              name={"uid"}
                              required={false}
                              schemaName={"string"}
                              qualifierMessage={undefined}
                              schema={{"type":"string"}}
                            >
                              
                            </SchemaItem><SchemaItem
                              collapsible={false}
                              name={"description"}
                              required={true}
                              schemaName={"string"}
                              qualifierMessage={undefined}
                              schema={{"type":"string"}}
                            >
                              
                            </SchemaItem><SchemaItem
                              collapsible={false}
                              name={"start_timestamp"}
                              required={true}
                              schemaName={"date-time"}
                              qualifierMessage={undefined}
                              schema={{"type":"string","format":"date-time","readOnly":true}}
                            >
                              
                            </SchemaItem><SchemaItem
                              collapsible={false}
                              name={"finish_timestamp"}
                              required={true}
                              schemaName={"date-time"}
                              qualifierMessage={undefined}
                              schema={{"type":"string","format":"date-time","readOnly":true}}
                            >
                              
                            </SchemaItem><SchemaItem
                              collapsible={false}
                              name={"duration"}
                              required={true}
                              schemaName={"double"}
                              qualifierMessage={undefined}
                              schema={{"type":"number","format":"double","readOnly":true}}
                            >
                              
                            </SchemaItem><SchemaItem
                              collapsible={false}
                              name={"status"}
                              required={true}
                              schemaName={"SystemTaskStatusEnum (string)"}
                              qualifierMessage={"**Possible values:** [`unknown`, `successful`, `warning`, `error`]"}
                              schema={{"enum":["unknown","successful","warning","error"],"type":"string","title":"SystemTaskStatusEnum"}}
                            >
                              
                            </SchemaItem><SchemaItem
                              collapsible={true}
                              className={"schemaItem"}
                            >
                              <details
                                style={{}}
                                className={"openapi-markdown__details"}
                              >
                                <summary
                                  style={{}}
                                >
                                  <span
                                    className={"openapi-schema__container"}
                                  >
                                    <strong
                                      className={"openapi-schema__property"}
                                    >
                                      messages
                                    </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={"timestamp"}
                                    required={true}
                                    schemaName={"date-time"}
                                    qualifierMessage={undefined}
                                    schema={{"type":"string","format":"date-time"}}
                                  >
                                    
                                  </SchemaItem><SchemaItem
                                    collapsible={false}
                                    name={"log_level"}
                                    required={true}
                                    schemaName={"LogLevelEnum (string)"}
                                    qualifierMessage={"**Possible values:** [`critical`, `exception`, `error`, `warn`, `warning`, `info`, `debug`, `notset`]"}
                                    schema={{"enum":["critical","exception","error","warn","warning","info","debug","notset"],"type":"string","title":"LogLevelEnum"}}
                                  >
                                    
                                  </SchemaItem><SchemaItem
                                    collapsible={false}
                                    name={"logger"}
                                    required={true}
                                    schemaName={"string"}
                                    qualifierMessage={undefined}
                                    schema={{"type":"string"}}
                                  >
                                    
                                  </SchemaItem><SchemaItem
                                    collapsible={false}
                                    name={"event"}
                                    required={true}
                                    schemaName={"string"}
                                    qualifierMessage={undefined}
                                    schema={{"type":"string"}}
                                  >
                                    
                                  </SchemaItem><SchemaItem
                                    collapsible={true}
                                    className={"schemaItem"}
                                  >
                                    <details
                                      style={{}}
                                      className={"openapi-markdown__details"}
                                    >
                                      <summary
                                        style={{}}
                                      >
                                        <span
                                          className={"openapi-schema__container"}
                                        >
                                          <strong
                                            className={"openapi-schema__property"}
                                          >
                                            attributes
                                          </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
                                          name={"property name*"}
                                          required={false}
                                          schemaName={"any"}
                                          qualifierMessage={undefined}
                                          schema={{"type":"object","additionalProperties":{}}}
                                          collapsible={false}
                                          discriminator={false}
                                        >
                                          
                                        </SchemaItem>
                                      </div>
                                    </details>
                                  </SchemaItem><li>
                                    <div
                                      style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}
                                    >
                                      ]
                                    </div>
                                  </li>
                                </div>
                              </details>
                            </SchemaItem><SchemaItem
                              collapsible={false}
                              name={"expires"}
                              required={false}
                              schemaName={"date-time"}
                              qualifierMessage={undefined}
                              schema={{"type":"string","format":"date-time","nullable":true}}
                            >
                              
                            </SchemaItem><SchemaItem
                              collapsible={false}
                              name={"expiring"}
                              required={false}
                              schemaName={"boolean"}
                              qualifierMessage={undefined}
                              schema={{"type":"boolean"}}
                            >
                              
                            </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  \"is_running\": true,\n  \"tasks\": [\n    {\n      \"uuid\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n      \"name\": \"string\",\n      \"full_name\": \"string\",\n      \"uid\": \"string\",\n      \"description\": \"string\",\n      \"start_timestamp\": \"2024-07-29T15:51:28.071Z\",\n      \"finish_timestamp\": \"2024-07-29T15:51:28.071Z\",\n      \"duration\": 0,\n      \"status\": \"unknown\",\n      \"messages\": [\n        {\n          \"timestamp\": \"2024-07-29T15:51:28.071Z\",\n          \"log_level\": \"critical\",\n          \"logger\": \"string\",\n          \"event\": \"string\",\n          \"attributes\": {}\n        }\n      ],\n      \"expires\": \"2024-07-29T15:51:28.071Z\",\n      \"expiring\": true\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><TabItem
        label={"404"}
        value={"404"}
      >
        <div>
          
          
          Task not found
          
          
        </div><div>
          
        </div>
      </TabItem>
    </ApiTabs>
  </div>
</div>