Sign in
providers

SCIMProvider Viewset

patch/providers/scim/{id}/

Path parameters

idinteger required

A unique integer value identifying this SCIM Provider.

Request body

namestring
property_mappingsstring[]
property_mappings_groupstring[]

Property mappings used for group creation/updating.

urlstring

Base URL to SCIM requests, usually ends in /v2

verify_certificatesboolean
tokenstring

Authentication token

auth_mode'token' | 'basic' | 'oauth' | 'oauth_interactive'
auth_basic_userstring

Username used for Basic authentication

auth_basic_passwordstring

Password used for Basic authentication

auth_oauthstring uuid nullable

OAuth Source used for authentication

auth_oauth_paramsobject

Additional OAuth parameters, such as grant_type

compatibility_mode'default' | 'aws' | 'slack' | 'sfdc' | 'gitlab' | 'webex' | 'vcenter'
service_provider_config_cache_timeoutstring

Cache duration for ServiceProviderConfig responses. Set minutes=0 to disable.

exclude_users_service_accountboolean
sync_page_sizeinteger

Controls the number of objects synced in a single task

sync_page_timeoutstring

Timeout for synchronization of a single page

discovery_enabledboolean

When enabled, authentik will attempt to discover existing resources in the remote system.

group_filtersstring[]

Group filters used to define sync-scope for groups.

dry_runboolean

When enabled, provider will not modify or create objects in the remote system.

Response

pkinteger required
namestring required
property_mappingsstring[]
property_mappings_groupstring[]

Property mappings used for group creation/updating.

componentstring required

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

assigned_backchannel_application_slugstring nullable required

Internal application name, used in URLs.

assigned_backchannel_application_namestring nullable required

Application's display Name.

verbose_namestring required

Return object's verbose_name

verbose_name_pluralstring required

Return object's plural verbose_name

meta_model_namestring required

Return internal model name

urlstring required

Base URL to SCIM requests, usually ends in /v2

verify_certificatesboolean
auth_mode'token' | 'basic' | 'oauth' | 'oauth_interactive'
auth_basic_userstring

Username used for Basic authentication

auth_oauthstring uuid nullable

OAuth Source used for authentication

auth_oauth_paramsobject

Additional OAuth parameters, such as grant_type

auth_oauth_token_last_updatedstring date-time nullable required
auth_oauth_token_expiresstring date-time nullable required
auth_oauth_url_callbackstring nullable required
auth_oauth_url_startstring nullable required
compatibility_mode'default' | 'aws' | 'slack' | 'sfdc' | 'gitlab' | 'webex' | 'vcenter'
service_provider_config_cache_timeoutstring

Cache duration for ServiceProviderConfig responses. Set minutes=0 to disable.

exclude_users_service_accountboolean
sync_page_sizeinteger

Controls the number of objects synced in a single task

sync_page_timeoutstring

Timeout for synchronization of a single page

discovery_enabledboolean

When enabled, authentik will attempt to discover existing resources in the remote system.

group_filtersstring[]

Group filters used to define sync-scope for groups.

dry_runboolean

When enabled, provider will not modify or create objects in the remote system.

Changes

Changed in 2 of the 11 revisions of this API.25

  • 740428af675214See the full diff
    • ●

      added the new basic enum value to the response property for the response status

      response-property-enum-value-added

    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the new basic enum value to the request property

      request-property-enum-value-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

  • a5be6c74184e11See the full diff
    • ●

      removed the optional property from the response with the status

      response-optional-property-removed

    • ○

      the request optional property became write-only

      request-optional-property-became-write-only