Skip to main content

sources_scim_create

POST 
/sources/scim/

SCIMSource Viewset

Request​

Body

required

    name stringrequired

    Source's display Name.

    Possible values: non-empty

    slug stringrequired

    Internal source name, used in URLs.

    Possible values: non-empty and <= 50 characters, Value must match regular expression ^[-a-zA-Z0-9_]+$

    enabled boolean
    user_property_mappings uuid[]
    group_property_mappings uuid[]
    user_path_template string

    Possible values: non-empty

Responses​

Schema

    pk uuidrequired
    name stringrequired

    Source's display Name.

    slug stringrequired

    Internal source name, used in URLs.

    Possible values: <= 50 characters, Value must match regular expression ^[-a-zA-Z0-9_]+$

    enabled boolean
    user_property_mappings uuid[]
    group_property_mappings uuid[]
    component stringrequired

    Get object component so that we know how to edit the object

    verbose_name stringrequired

    Return object's verbose_name

    verbose_name_plural stringrequired

    Return object's plural verbose_name

    meta_model_name stringrequired

    Return internal model name

    managed Managed by authentik (string)nullablerequired

    Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.

    user_path_template string
    root_url stringrequired

    Get Root URL

    token_obj

    object

    required

    Token Serializer

    pk uuidrequired
    managed Managed by authentik (string)nullable

    Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.

    identifier stringrequired

    Possible values: <= 255 characters, Value must match regular expression ^[-a-zA-Z0-9_]+$

    intent IntentEnum (string)

    Possible values: [verification, api, recovery, app_password]

    user integer

    user_obj

    object

    required

    User Serializer

    pk ID (integer)required
    username stringrequired

    Possible values: <= 150 characters

    name stringrequired

    User's display name.

    is_active Active (boolean)

    Designates whether this user should be treated as active. Unselect this instead of deleting accounts.

    last_login date-timenullable
    is_superuser booleanrequired
    groups uuid[]

    groups_obj

    object[]

    nullable

    required

  • Array [

    • pk uuidrequired
    num_pk integerrequired

    Get a numerical, int32 ID for the group

    name stringrequired
    is_superuser boolean

    Users added to this group will be superusers.

    parent uuidnullable
    parent_name stringnullablerequired
    attributes object

  • ]

    • email email

    Possible values: <= 254 characters

    avatar stringrequired

    User's avatar, either a http/https URL or a data URI

    attributes object
    uid stringrequired
    path string
    type UserTypeEnum (string)

    Possible values: [internal, external, service_account, internal_service_account]

    uuid uuidrequired
    description string
    expires date-timenullable
    expiring boolean
Loading...