---
id: providers-scim-users-create
title: "providers_scim_users_create"
description: "SCIMProviderUser Viewset"
sidebar_label: "providers_scim_users_create"
hide_title: true
hide_table_of_contents: true
api: eJzFVk1v4zYQ/SuEUKCHKJKTTYAip6RZY2EgaYJ87CWbGpQ0lrihSJWk7LiG/3tnKMVSHNnbAgv0YtDUcPjmzZvhrAJdgeFOaDXJgrOgMnouMjB2alNRTmtLy9QAdxCEQQY2NaIia7S9v5xc37b2j2jIvgpYWHBo6Hhug7Onzl3wHAYG/qrBut91tgzOVkGqlQPlaMmrSorUo4i/W3K+CmxaQMlp5ZYV4HU6+Q6p+zGKezCCS/E3GLRFABifE2AbnxiTyHpOrTNC5WhYCnUFKndFcHa0DgMKvGcmEGqOO+twE9LQ13UTpDCQ9aNH9283t56RDSechAH8dw1L6OydN2dqwA0LaW2EQwKfkLbaFcigeMF/z2vPsK20sk2wx6Oj/4nmYYZn2pQccQR17YlAUWU3Si672HZlZ28+6MsUQfsApbyZeWp+EAz6rSrIWKYXipEHZjfhMKeZLfSCGZAw58p5A8sQP8uNriv7IeDqZQDbdoRdyief34ArXsIQV+/h3rUqiNjR6YilBTc8dQQJEc1gASZiV+BoJ2SZyIWzjKuMncdRfBAfxlOmEUREqDlZkcs/n759W0TnB4fPB7+Q+vnrRv2nIwT374CREH61eKetJF8yOhRRaMJOEaGY910kWkvgKuhouGhMtp1+BityhQ3HskUBqHDMSCFsm6ZC1zJjCTDnm1LGOAbrHUXsEaUvMd+NvVDWYQKYnrEMtx0GgJaprpWzHqXk1k2lzoXaK9cMrzl0oiSkqpaSJ4S+1SzWjpB7jzcWXdRj+s94lmGx2vfUH5+eoEvMkRFJ7RppbQsZDwoiisvbvgSpWdTDdbdVZ1s9yic6JAU3Dnq67DWpL6T7aygTqrnngdr9D13RX7K7NfYqek+XbNrje+FQTk9Go5/Y9L5iR8j8UTY2Rn/sdEqr6UyAzKZA3/sZ48bwJR4QDko70NMQbKqzgSKjL7uy3BHSQWuQ7eTj00/k4wsobJMpu7id7CAkAzdYEHuj7aujddDXXnPpnjBxq8RGof0Ao61rOh0WVBBvBpC4m2diEh2YOY0l9FbURpIpr0Q8/xR7fb89s/dETBNZ77HdxFA4V3kFkxX1OOCmVTxRe9cNPONXXlYS3g0hXYk2r9uoX0bUhIWaaX9by0QHIQwIfRP/8ej4JPotOv6QrWv+4ntee6rJObOCgNBrQKLA1kk3tG0sKEBKfZ7rzU2R0L5VihSwuXrJ+5chuJ48EHBPHdFgz+IYX56iTqJUl3HPRdytEqmTGK9S8dXkcvzH/dhTRSkrueo532SNEVnt+zs8hfa0vXcgbRLm4NXF+FZhy1+36FetVvrDatuU/L34h9RYkK7QaLVKuIVHI9dr2sYEGxrGcDnnOEH4twGHMTyALZISiQJ7ATQJLhuchw8Ehcxl7ZO6XY/r8O3ERZpC5fbaPvekf3tzTzlJ2vm69PUWGL6gRwB/sVRCHPfptFe031vhM6jymudk2/j0DagmTrrHuxF2+LbojVhcLXsIkR5v8aBfQCFFYRuKo/8IF53/AxDlTgY=
sidebar_class_name: "post 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_users_create"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/providers/scim_users/"}
>
  
</MethodEndpoint>



SCIMProviderUser Viewset

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

<MimeTabs
  className={"openapi-tabs__mime"}
>
  <TabItem
    label={"application/json"}
    value={"application/json-schema"}
  >
    <details
      style={{}}
      className={"openapi-markdown__details mime"}
      data-collapsed={false}
      open={true}
    >
      <summary
        style={{}}
        className={"openapi-markdown__details-summary-mime"}
      >
        <h3
          className={"openapi-markdown__details-summary-header-body"}
        >
          Body
        </h3><strong
          className={"openapi-schema__required"}
        >
          required
        </strong>
      </summary><div
        style={{"textAlign":"left","marginLeft":"1rem"}}
      >
        
      </div><ul
        style={{"marginLeft":"1rem"}}
      >
        <SchemaItem
          collapsible={false}
          name={"scim_id"}
          required={true}
          schemaName={"string"}
          qualifierMessage={"**Possible values:** `non-empty`"}
          schema={{"type":"string","minLength":1}}
        >
          
        </SchemaItem><SchemaItem
          collapsible={false}
          name={"user"}
          required={true}
          schemaName={"integer"}
          qualifierMessage={undefined}
          schema={{"type":"integer"}}
        >
          
        </SchemaItem><SchemaItem
          collapsible={false}
          name={"provider"}
          required={true}
          schemaName={"integer"}
          qualifierMessage={undefined}
          schema={{"type":"integer"}}
        >
          
        </SchemaItem>
      </ul>
    </details>
  </TabItem>
</MimeTabs><div>
  <div>
    <ApiTabs
      label={undefined}
      id={undefined}
    >
      <TabItem
        label={"201"}
        value={"201"}
      >
        <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={"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={"user"}
                        required={true}
                        schemaName={"integer"}
                        qualifierMessage={undefined}
                        schema={{"type":"integer"}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={true}
                        className={"schemaItem"}
                      >
                        <details
                          style={{}}
                          className={"openapi-markdown__details"}
                        >
                          <summary
                            style={{}}
                          >
                            <span
                              className={"openapi-schema__container"}
                            >
                              <strong
                                className={"openapi-schema__property"}
                              >
                                user_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"}}
                            >
                              
                              
                              Stripped down user serializer to show relevant users for groups
                              
                              
                            </div><SchemaItem
                              collapsible={false}
                              name={"pk"}
                              required={true}
                              schemaName={"ID (integer)"}
                              qualifierMessage={undefined}
                              schema={{"type":"integer","readOnly":true,"title":"ID"}}
                            >
                              
                            </SchemaItem><SchemaItem
                              collapsible={false}
                              name={"username"}
                              required={true}
                              schemaName={"string"}
                              qualifierMessage={"**Possible values:** `<= 150 characters`, Value must match regular expression `^[\\w.@+-]+$`"}
                              schema={{"type":"string","description":"Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.","pattern":"^[\\w.@+-]+$","maxLength":150}}
                            >
                              
                            </SchemaItem><SchemaItem
                              collapsible={false}
                              name={"name"}
                              required={true}
                              schemaName={"string"}
                              qualifierMessage={undefined}
                              schema={{"type":"string","description":"User's display name."}}
                            >
                              
                            </SchemaItem><SchemaItem
                              collapsible={false}
                              name={"is_active"}
                              required={false}
                              schemaName={"Active (boolean)"}
                              qualifierMessage={undefined}
                              schema={{"type":"boolean","title":"Active","description":"Designates whether this user should be treated as active. Unselect this instead of deleting accounts."}}
                            >
                              
                            </SchemaItem><SchemaItem
                              collapsible={false}
                              name={"last_login"}
                              required={false}
                              schemaName={"date-time"}
                              qualifierMessage={undefined}
                              schema={{"type":"string","format":"date-time","nullable":true}}
                            >
                              
                            </SchemaItem><SchemaItem
                              collapsible={false}
                              name={"email"}
                              required={false}
                              schemaName={"email"}
                              qualifierMessage={"**Possible values:** `<= 254 characters`"}
                              schema={{"type":"string","format":"email","title":"Email address","maxLength":254}}
                            >
                              
                            </SchemaItem><SchemaItem
                              collapsible={false}
                              name={"attributes"}
                              required={false}
                              schemaName={"object"}
                              qualifierMessage={undefined}
                              schema={{"type":"object"}}
                            >
                              
                            </SchemaItem><SchemaItem
                              collapsible={false}
                              name={"uid"}
                              required={true}
                              schemaName={"string"}
                              qualifierMessage={undefined}
                              schema={{"type":"string","readOnly":true}}
                            >
                              
                            </SchemaItem>
                          </div>
                        </details>
                      </SchemaItem><SchemaItem
                        collapsible={false}
                        name={"provider"}
                        required={true}
                        schemaName={"integer"}
                        qualifierMessage={undefined}
                        schema={{"type":"integer"}}
                      >
                        
                      </SchemaItem>
                    </ul>
                  </details>
                </TabItem><TabItem
                  label={"Example (from schema)"}
                  value={"Example (from schema)"}
                >
                  <ResponseSamples
                    responseExample={"{\n  \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n  \"scim_id\": \"string\",\n  \"user\": 0,\n  \"user_obj\": {\n    \"pk\": 0,\n    \"username\": \"string\",\n    \"name\": \"string\",\n    \"is_active\": true,\n    \"last_login\": \"2024-07-29T15:51:28.071Z\",\n    \"email\": \"user@example.com\",\n    \"attributes\": {},\n    \"uid\": \"string\"\n  },\n  \"provider\": 0\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>
      