# \ProvidersApi All URIs are relative to *http://localhost/api/v3* Method | HTTP request | Description ------------- | ------------- | ------------- [**providers_all_destroy**](ProvidersApi.md#providers_all_destroy) | **DELETE** /providers/all/{id}/ | [**providers_all_list**](ProvidersApi.md#providers_all_list) | **GET** /providers/all/ | [**providers_all_retrieve**](ProvidersApi.md#providers_all_retrieve) | **GET** /providers/all/{id}/ | [**providers_all_types_list**](ProvidersApi.md#providers_all_types_list) | **GET** /providers/all/types/ | [**providers_all_used_by_list**](ProvidersApi.md#providers_all_used_by_list) | **GET** /providers/all/{id}/used_by/ | [**providers_ldap_create**](ProvidersApi.md#providers_ldap_create) | **POST** /providers/ldap/ | [**providers_ldap_destroy**](ProvidersApi.md#providers_ldap_destroy) | **DELETE** /providers/ldap/{id}/ | [**providers_ldap_list**](ProvidersApi.md#providers_ldap_list) | **GET** /providers/ldap/ | [**providers_ldap_partial_update**](ProvidersApi.md#providers_ldap_partial_update) | **PATCH** /providers/ldap/{id}/ | [**providers_ldap_retrieve**](ProvidersApi.md#providers_ldap_retrieve) | **GET** /providers/ldap/{id}/ | [**providers_ldap_update**](ProvidersApi.md#providers_ldap_update) | **PUT** /providers/ldap/{id}/ | [**providers_ldap_used_by_list**](ProvidersApi.md#providers_ldap_used_by_list) | **GET** /providers/ldap/{id}/used_by/ | [**providers_oauth2_create**](ProvidersApi.md#providers_oauth2_create) | **POST** /providers/oauth2/ | [**providers_oauth2_destroy**](ProvidersApi.md#providers_oauth2_destroy) | **DELETE** /providers/oauth2/{id}/ | [**providers_oauth2_list**](ProvidersApi.md#providers_oauth2_list) | **GET** /providers/oauth2/ | [**providers_oauth2_partial_update**](ProvidersApi.md#providers_oauth2_partial_update) | **PATCH** /providers/oauth2/{id}/ | [**providers_oauth2_preview_user_retrieve**](ProvidersApi.md#providers_oauth2_preview_user_retrieve) | **GET** /providers/oauth2/{id}/preview_user/ | [**providers_oauth2_retrieve**](ProvidersApi.md#providers_oauth2_retrieve) | **GET** /providers/oauth2/{id}/ | [**providers_oauth2_setup_urls_retrieve**](ProvidersApi.md#providers_oauth2_setup_urls_retrieve) | **GET** /providers/oauth2/{id}/setup_urls/ | [**providers_oauth2_update**](ProvidersApi.md#providers_oauth2_update) | **PUT** /providers/oauth2/{id}/ | [**providers_oauth2_used_by_list**](ProvidersApi.md#providers_oauth2_used_by_list) | **GET** /providers/oauth2/{id}/used_by/ | [**providers_proxy_create**](ProvidersApi.md#providers_proxy_create) | **POST** /providers/proxy/ | [**providers_proxy_destroy**](ProvidersApi.md#providers_proxy_destroy) | **DELETE** /providers/proxy/{id}/ | [**providers_proxy_list**](ProvidersApi.md#providers_proxy_list) | **GET** /providers/proxy/ | [**providers_proxy_partial_update**](ProvidersApi.md#providers_proxy_partial_update) | **PATCH** /providers/proxy/{id}/ | [**providers_proxy_retrieve**](ProvidersApi.md#providers_proxy_retrieve) | **GET** /providers/proxy/{id}/ | [**providers_proxy_update**](ProvidersApi.md#providers_proxy_update) | **PUT** /providers/proxy/{id}/ | [**providers_proxy_used_by_list**](ProvidersApi.md#providers_proxy_used_by_list) | **GET** /providers/proxy/{id}/used_by/ | [**providers_rac_create**](ProvidersApi.md#providers_rac_create) | **POST** /providers/rac/ | [**providers_rac_destroy**](ProvidersApi.md#providers_rac_destroy) | **DELETE** /providers/rac/{id}/ | [**providers_rac_list**](ProvidersApi.md#providers_rac_list) | **GET** /providers/rac/ | [**providers_rac_partial_update**](ProvidersApi.md#providers_rac_partial_update) | **PATCH** /providers/rac/{id}/ | [**providers_rac_retrieve**](ProvidersApi.md#providers_rac_retrieve) | **GET** /providers/rac/{id}/ | [**providers_rac_update**](ProvidersApi.md#providers_rac_update) | **PUT** /providers/rac/{id}/ | [**providers_rac_used_by_list**](ProvidersApi.md#providers_rac_used_by_list) | **GET** /providers/rac/{id}/used_by/ | [**providers_radius_create**](ProvidersApi.md#providers_radius_create) | **POST** /providers/radius/ | [**providers_radius_destroy**](ProvidersApi.md#providers_radius_destroy) | **DELETE** /providers/radius/{id}/ | [**providers_radius_list**](ProvidersApi.md#providers_radius_list) | **GET** /providers/radius/ | [**providers_radius_partial_update**](ProvidersApi.md#providers_radius_partial_update) | **PATCH** /providers/radius/{id}/ | [**providers_radius_retrieve**](ProvidersApi.md#providers_radius_retrieve) | **GET** /providers/radius/{id}/ | [**providers_radius_update**](ProvidersApi.md#providers_radius_update) | **PUT** /providers/radius/{id}/ | [**providers_radius_used_by_list**](ProvidersApi.md#providers_radius_used_by_list) | **GET** /providers/radius/{id}/used_by/ | [**providers_saml_create**](ProvidersApi.md#providers_saml_create) | **POST** /providers/saml/ | [**providers_saml_destroy**](ProvidersApi.md#providers_saml_destroy) | **DELETE** /providers/saml/{id}/ | [**providers_saml_import_metadata_create**](ProvidersApi.md#providers_saml_import_metadata_create) | **POST** /providers/saml/import_metadata/ | [**providers_saml_list**](ProvidersApi.md#providers_saml_list) | **GET** /providers/saml/ | [**providers_saml_metadata_retrieve**](ProvidersApi.md#providers_saml_metadata_retrieve) | **GET** /providers/saml/{id}/metadata/ | [**providers_saml_partial_update**](ProvidersApi.md#providers_saml_partial_update) | **PATCH** /providers/saml/{id}/ | [**providers_saml_preview_user_retrieve**](ProvidersApi.md#providers_saml_preview_user_retrieve) | **GET** /providers/saml/{id}/preview_user/ | [**providers_saml_retrieve**](ProvidersApi.md#providers_saml_retrieve) | **GET** /providers/saml/{id}/ | [**providers_saml_update**](ProvidersApi.md#providers_saml_update) | **PUT** /providers/saml/{id}/ | [**providers_saml_used_by_list**](ProvidersApi.md#providers_saml_used_by_list) | **GET** /providers/saml/{id}/used_by/ | [**providers_scim_create**](ProvidersApi.md#providers_scim_create) | **POST** /providers/scim/ | [**providers_scim_destroy**](ProvidersApi.md#providers_scim_destroy) | **DELETE** /providers/scim/{id}/ | [**providers_scim_list**](ProvidersApi.md#providers_scim_list) | **GET** /providers/scim/ | [**providers_scim_partial_update**](ProvidersApi.md#providers_scim_partial_update) | **PATCH** /providers/scim/{id}/ | [**providers_scim_retrieve**](ProvidersApi.md#providers_scim_retrieve) | **GET** /providers/scim/{id}/ | [**providers_scim_sync_status_retrieve**](ProvidersApi.md#providers_scim_sync_status_retrieve) | **GET** /providers/scim/{id}/sync_status/ | [**providers_scim_update**](ProvidersApi.md#providers_scim_update) | **PUT** /providers/scim/{id}/ | [**providers_scim_used_by_list**](ProvidersApi.md#providers_scim_used_by_list) | **GET** /providers/scim/{id}/used_by/ | ## providers_all_destroy > providers_all_destroy(id) Provider Viewset ### Parameters Name | Type | Description | Required | Notes ------------- | ------------- | ------------- | ------------- | ------------- **id** | **i32** | A unique integer value identifying this provider. | [required] | ### Return type (empty response body) ### Authorization [authentik](../README.md#authentik) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) ## providers_all_list > models::PaginatedProviderList providers_all_list(application__isnull, backchannel_only, ordering, page, page_size, search) Provider Viewset ### Parameters Name | Type | Description | Required | Notes ------------- | ------------- | ------------- | ------------- | ------------- **application__isnull** | Option<**bool**> | | | **backchannel_only** | Option<**bool**> | | | **ordering** | Option<**String**> | Which field to use when ordering the results. | | **page** | Option<**i32**> | A page number within the paginated result set. | | **page_size** | Option<**i32**> | Number of results to return per page. | | **search** | Option<**String**> | A search term. | | ### Return type [**models::PaginatedProviderList**](PaginatedProviderList.md) ### Authorization [authentik](../README.md#authentik) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) ## providers_all_retrieve > models::Provider providers_all_retrieve(id) Provider Viewset ### Parameters Name | Type | Description | Required | Notes ------------- | ------------- | ------------- | ------------- | ------------- **id** | **i32** | A unique integer value identifying this provider. | [required] | ### Return type [**models::Provider**](Provider.md) ### Authorization [authentik](../README.md#authentik) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) ## providers_all_types_list > Vec providers_all_types_list() Get all creatable provider types ### Parameters This endpoint does not need any parameter. ### Return type [**Vec**](TypeCreate.md) ### Authorization [authentik](../README.md#authentik) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) ## providers_all_used_by_list > Vec providers_all_used_by_list(id) Get a list of all objects that use this object ### Parameters Name | Type | Description | Required | Notes ------------- | ------------- | ------------- | ------------- | ------------- **id** | **i32** | A unique integer value identifying this provider. | [required] | ### Return type [**Vec**](UsedBy.md) ### Authorization [authentik](../README.md#authentik) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) ## providers_ldap_create > models::LdapProvider providers_ldap_create(ldap_provider_request) LDAPProvider Viewset ### Parameters Name | Type | Description | Required | Notes ------------- | ------------- | ------------- | ------------- | ------------- **ldap_provider_request** | [**LdapProviderRequest**](LdapProviderRequest.md) | | [required] | ### Return type [**models::LdapProvider**](LDAPProvider.md) ### Authorization [authentik](../README.md#authentik) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) ## providers_ldap_destroy > providers_ldap_destroy(id) LDAPProvider Viewset ### Parameters Name | Type | Description | Required | Notes ------------- | ------------- | ------------- | ------------- | ------------- **id** | **i32** | A unique integer value identifying this LDAP Provider. | [required] | ### Return type (empty response body) ### Authorization [authentik](../README.md#authentik) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) ## providers_ldap_list > models::PaginatedLdapProviderList providers_ldap_list(application__isnull, authorization_flow__slug__iexact, base_dn__iexact, certificate__kp_uuid__iexact, certificate__name__iexact, gid_start_number__iexact, name__iexact, ordering, page, page_size, search, search_group__group_uuid__iexact, search_group__name__iexact, tls_server_name__iexact, uid_start_number__iexact) LDAPProvider Viewset ### Parameters Name | Type | Description | Required | Notes ------------- | ------------- | ------------- | ------------- | ------------- **application__isnull** | Option<**bool**> | | | **authorization_flow__slug__iexact** | Option<**String**> | | | **base_dn__iexact** | Option<**String**> | | | **certificate__kp_uuid__iexact** | Option<**uuid::Uuid**> | | | **certificate__name__iexact** | Option<**String**> | | | **gid_start_number__iexact** | Option<**i32**> | | | **name__iexact** | Option<**String**> | | | **ordering** | Option<**String**> | Which field to use when ordering the results. | | **page** | Option<**i32**> | A page number within the paginated result set. | | **page_size** | Option<**i32**> | Number of results to return per page. | | **search** | Option<**String**> | A search term. | | **search_group__group_uuid__iexact** | Option<**uuid::Uuid**> | | | **search_group__name__iexact** | Option<**String**> | | | **tls_server_name__iexact** | Option<**String**> | | | **uid_start_number__iexact** | Option<**i32**> | | | ### Return type [**models::PaginatedLdapProviderList**](PaginatedLDAPProviderList.md) ### Authorization [authentik](../README.md#authentik) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) ## providers_ldap_partial_update > models::LdapProvider providers_ldap_partial_update(id, patched_ldap_provider_request) LDAPProvider Viewset ### Parameters Name | Type | Description | Required | Notes ------------- | ------------- | ------------- | ------------- | ------------- **id** | **i32** | A unique integer value identifying this LDAP Provider. | [required] | **patched_ldap_provider_request** | Option<[**PatchedLdapProviderRequest**](PatchedLdapProviderRequest.md)> | | | ### Return type [**models::LdapProvider**](LDAPProvider.md) ### Authorization [authentik](../README.md#authentik) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) ## providers_ldap_retrieve > models::LdapProvider providers_ldap_retrieve(id) LDAPProvider Viewset ### Parameters Name | Type | Description | Required | Notes ------------- | ------------- | ------------- | ------------- | ------------- **id** | **i32** | A unique integer value identifying this LDAP Provider. | [required] | ### Return type [**models::LdapProvider**](LDAPProvider.md) ### Authorization [authentik](../README.md#authentik) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) ## providers_ldap_update > models::LdapProvider providers_ldap_update(id, ldap_provider_request) LDAPProvider Viewset ### Parameters Name | Type | Description | Required | Notes ------------- | ------------- | ------------- | ------------- | ------------- **id** | **i32** | A unique integer value identifying this LDAP Provider. | [required] | **ldap_provider_request** | [**LdapProviderRequest**](LdapProviderRequest.md) | | [required] | ### Return type [**models::LdapProvider**](LDAPProvider.md) ### Authorization [authentik](../README.md#authentik) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) ## providers_ldap_used_by_list > Vec providers_ldap_used_by_list(id) Get a list of all objects that use this object ### Parameters Name | Type | Description | Required | Notes ------------- | ------------- | ------------- | ------------- | ------------- **id** | **i32** | A unique integer value identifying this LDAP Provider. | [required] | ### Return type [**Vec**](UsedBy.md) ### Authorization [authentik](../README.md#authentik) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) ## providers_oauth2_create > models::OAuth2Provider providers_oauth2_create(o_auth2_provider_request) OAuth2Provider Viewset ### Parameters Name | Type | Description | Required | Notes ------------- | ------------- | ------------- | ------------- | ------------- **o_auth2_provider_request** | [**OAuth2ProviderRequest**](OAuth2ProviderRequest.md) | | [required] | ### Return type [**models::OAuth2Provider**](OAuth2Provider.md) ### Authorization [authentik](../README.md#authentik) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) ## providers_oauth2_destroy > providers_oauth2_destroy(id) OAuth2Provider Viewset ### Parameters Name | Type | Description | Required | Notes ------------- | ------------- | ------------- | ------------- | ------------- **id** | **i32** | A unique integer value identifying this OAuth2/OpenID Provider. | [required] | ### Return type (empty response body) ### Authorization [authentik](../README.md#authentik) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) ## providers_oauth2_list > models::PaginatedOAuth2ProviderList providers_oauth2_list(access_code_validity, access_token_validity, application, authorization_flow, client_id, client_type, include_claims_in_id_token, issuer_mode, name, ordering, page, page_size, property_mappings, redirect_uris, refresh_token_validity, search, signing_key, sub_mode) OAuth2Provider Viewset ### Parameters Name | Type | Description | Required | Notes ------------- | ------------- | ------------- | ------------- | ------------- **access_code_validity** | Option<**String**> | | | **access_token_validity** | Option<**String**> | | | **application** | Option<**uuid::Uuid**> | | | **authorization_flow** | Option<**uuid::Uuid**> | | | **client_id** | Option<**String**> | | | **client_type** | Option<**String**> | Confidential clients are capable of maintaining the confidentiality of their credentials. Public clients are incapable * `confidential` - Confidential * `public` - Public | | **include_claims_in_id_token** | Option<**bool**> | | | **issuer_mode** | Option<**String**> | Configure how the issuer field of the ID Token should be filled. * `global` - Same identifier is used for all providers * `per_provider` - Each provider has a different issuer, based on the application slug. | | **name** | Option<**String**> | | | **ordering** | Option<**String**> | Which field to use when ordering the results. | | **page** | Option<**i32**> | A page number within the paginated result set. | | **page_size** | Option<**i32**> | Number of results to return per page. | | **property_mappings** | Option<[**Vec**](uuid::Uuid.md)> | | | **redirect_uris** | Option<**String**> | | | **refresh_token_validity** | Option<**String**> | | | **search** | Option<**String**> | A search term. | | **signing_key** | Option<**uuid::Uuid**> | | | **sub_mode** | Option<**String**> | Configure what data should be used as unique User Identifier. For most cases, the default should be fine. * `hashed_user_id` - Based on the Hashed User ID * `user_id` - Based on user ID * `user_uuid` - Based on user UUID * `user_username` - Based on the username * `user_email` - Based on the User's Email. This is recommended over the UPN method. * `user_upn` - Based on the User's UPN, only works if user has a 'upn' attribute set. Use this method only if you have different UPN and Mail domains. | | ### Return type [**models::PaginatedOAuth2ProviderList**](PaginatedOAuth2ProviderList.md) ### Authorization [authentik](../README.md#authentik) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) ## providers_oauth2_partial_update > models::OAuth2Provider providers_oauth2_partial_update(id, patched_o_auth2_provider_request) OAuth2Provider Viewset ### Parameters Name | Type | Description | Required | Notes ------------- | ------------- | ------------- | ------------- | ------------- **id** | **i32** | A unique integer value identifying this OAuth2/OpenID Provider. | [required] | **patched_o_auth2_provider_request** | Option<[**PatchedOAuth2ProviderRequest**](PatchedOAuth2ProviderRequest.md)> | | | ### Return type [**models::OAuth2Provider**](OAuth2Provider.md) ### Authorization [authentik](../README.md#authentik) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) ## providers_oauth2_preview_user_retrieve > models::PropertyMappingPreview providers_oauth2_preview_user_retrieve(id, for_user) Preview user data for provider ### Parameters Name | Type | Description | Required | Notes ------------- | ------------- | ------------- | ------------- | ------------- **id** | **i32** | A unique integer value identifying this OAuth2/OpenID Provider. | [required] | **for_user** | Option<**i32**> | | | ### Return type [**models::PropertyMappingPreview**](PropertyMappingPreview.md) ### Authorization [authentik](../README.md#authentik) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) ## providers_oauth2_retrieve > models::OAuth2Provider providers_oauth2_retrieve(id) OAuth2Provider Viewset ### Parameters Name | Type | Description | Required | Notes ------------- | ------------- | ------------- | ------------- | ------------- **id** | **i32** | A unique integer value identifying this OAuth2/OpenID Provider. | [required] | ### Return type [**models::OAuth2Provider**](OAuth2Provider.md) ### Authorization [authentik](../README.md#authentik) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) ## providers_oauth2_setup_urls_retrieve > models::OAuth2ProviderSetupUrls providers_oauth2_setup_urls_retrieve(id) Get Providers setup URLs ### Parameters Name | Type | Description | Required | Notes ------------- | ------------- | ------------- | ------------- | ------------- **id** | **i32** | A unique integer value identifying this OAuth2/OpenID Provider. | [required] | ### Return type [**models::OAuth2ProviderSetupUrls**](OAuth2ProviderSetupURLs.md) ### Authorization [authentik](../README.md#authentik) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) ## providers_oauth2_update > models::OAuth2Provider providers_oauth2_update(id, o_auth2_provider_request) OAuth2Provider Viewset ### Parameters Name | Type | Description | Required | Notes ------------- | ------------- | ------------- | ------------- | ------------- **id** | **i32** | A unique integer value identifying this OAuth2/OpenID Provider. | [required] | **o_auth2_provider_request** | [**OAuth2ProviderRequest**](OAuth2ProviderRequest.md) | | [required] | ### Return type [**models::OAuth2Provider**](OAuth2Provider.md) ### Authorization [authentik](../README.md#authentik) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) ## providers_oauth2_used_by_list > Vec providers_oauth2_used_by_list(id) Get a list of all objects that use this object ### Parameters Name | Type | Description | Required | Notes ------------- | ------------- | ------------- | ------------- | ------------- **id** | **i32** | A unique integer value identifying this OAuth2/OpenID Provider. | [required] | ### Return type [**Vec**](UsedBy.md) ### Authorization [authentik](../README.md#authentik) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) ## providers_proxy_create > models::ProxyProvider providers_proxy_create(proxy_provider_request) ProxyProvider Viewset ### Parameters Name | Type | Description | Required | Notes ------------- | ------------- | ------------- | ------------- | ------------- **proxy_provider_request** | [**ProxyProviderRequest**](ProxyProviderRequest.md) | | [required] | ### Return type [**models::ProxyProvider**](ProxyProvider.md) ### Authorization [authentik](../README.md#authentik) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) ## providers_proxy_destroy > providers_proxy_destroy(id) ProxyProvider Viewset ### Parameters Name | Type | Description | Required | Notes ------------- | ------------- | ------------- | ------------- | ------------- **id** | **i32** | A unique integer value identifying this Proxy Provider. | [required] | ### Return type (empty response body) ### Authorization [authentik](../README.md#authentik) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) ## providers_proxy_list > models::PaginatedProxyProviderList providers_proxy_list(application__isnull, authorization_flow__slug__iexact, basic_auth_enabled__iexact, basic_auth_password_attribute__iexact, basic_auth_user_attribute__iexact, certificate__kp_uuid__iexact, certificate__name__iexact, cookie_domain__iexact, external_host__iexact, internal_host__iexact, internal_host_ssl_validation__iexact, mode__iexact, name__iexact, ordering, page, page_size, property_mappings__iexact, redirect_uris__iexact, search, skip_path_regex__iexact) ProxyProvider Viewset ### Parameters Name | Type | Description | Required | Notes ------------- | ------------- | ------------- | ------------- | ------------- **application__isnull** | Option<**bool**> | | | **authorization_flow__slug__iexact** | Option<**String**> | | | **basic_auth_enabled__iexact** | Option<**bool**> | | | **basic_auth_password_attribute__iexact** | Option<**String**> | | | **basic_auth_user_attribute__iexact** | Option<**String**> | | | **certificate__kp_uuid__iexact** | Option<**uuid::Uuid**> | | | **certificate__name__iexact** | Option<**String**> | | | **cookie_domain__iexact** | Option<**String**> | | | **external_host__iexact** | Option<**String**> | | | **internal_host__iexact** | Option<**String**> | | | **internal_host_ssl_validation__iexact** | Option<**bool**> | | | **mode__iexact** | Option<**String**> | | | **name__iexact** | Option<**String**> | | | **ordering** | Option<**String**> | Which field to use when ordering the results. | | **page** | Option<**i32**> | A page number within the paginated result set. | | **page_size** | Option<**i32**> | Number of results to return per page. | | **property_mappings__iexact** | Option<[**Vec**](uuid::Uuid.md)> | | | **redirect_uris__iexact** | Option<**String**> | | | **search** | Option<**String**> | A search term. | | **skip_path_regex__iexact** | Option<**String**> | | | ### Return type [**models::PaginatedProxyProviderList**](PaginatedProxyProviderList.md) ### Authorization [authentik](../README.md#authentik) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) ## providers_proxy_partial_update > models::ProxyProvider providers_proxy_partial_update(id, patched_proxy_provider_request) ProxyProvider Viewset ### Parameters Name | Type | Description | Required | Notes ------------- | ------------- | ------------- | ------------- | ------------- **id** | **i32** | A unique integer value identifying this Proxy Provider. | [required] | **patched_proxy_provider_request** | Option<[**PatchedProxyProviderRequest**](PatchedProxyProviderRequest.md)> | | | ### Return type [**models::ProxyProvider**](ProxyProvider.md) ### Authorization [authentik](../README.md#authentik) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) ## providers_proxy_retrieve > models::ProxyProvider providers_proxy_retrieve(id) ProxyProvider Viewset ### Parameters Name | Type | Description | Required | Notes ------------- | ------------- | ------------- | ------------- | ------------- **id** | **i32** | A unique integer value identifying this Proxy Provider. | [required] | ### Return type [**models::ProxyProvider**](ProxyProvider.md) ### Authorization [authentik](../README.md#authentik) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) ## providers_proxy_update > models::ProxyProvider providers_proxy_update(id, proxy_provider_request) ProxyProvider Viewset ### Parameters Name | Type | Description | Required | Notes ------------- | ------------- | ------------- | ------------- | ------------- **id** | **i32** | A unique integer value identifying this Proxy Provider. | [required] | **proxy_provider_request** | [**ProxyProviderRequest**](ProxyProviderRequest.md) | | [required] | ### Return type [**models::ProxyProvider**](ProxyProvider.md) ### Authorization [authentik](../README.md#authentik) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) ## providers_proxy_used_by_list > Vec providers_proxy_used_by_list(id) Get a list of all objects that use this object ### Parameters Name | Type | Description | Required | Notes ------------- | ------------- | ------------- | ------------- | ------------- **id** | **i32** | A unique integer value identifying this Proxy Provider. | [required] | ### Return type [**Vec**](UsedBy.md) ### Authorization [authentik](../README.md#authentik) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) ## providers_rac_create > models::RacProvider providers_rac_create(rac_provider_request) RACProvider Viewset ### Parameters Name | Type | Description | Required | Notes ------------- | ------------- | ------------- | ------------- | ------------- **rac_provider_request** | [**RacProviderRequest**](RacProviderRequest.md) | | [required] | ### Return type [**models::RacProvider**](RACProvider.md) ### Authorization [authentik](../README.md#authentik) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) ## providers_rac_destroy > providers_rac_destroy(id) RACProvider Viewset ### Parameters Name | Type | Description | Required | Notes ------------- | ------------- | ------------- | ------------- | ------------- **id** | **i32** | A unique integer value identifying this RAC Provider. | [required] | ### Return type (empty response body) ### Authorization [authentik](../README.md#authentik) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) ## providers_rac_list > models::PaginatedRacProviderList providers_rac_list(application__isnull, name__iexact, ordering, page, page_size, search) RACProvider Viewset ### Parameters Name | Type | Description | Required | Notes ------------- | ------------- | ------------- | ------------- | ------------- **application__isnull** | Option<**bool**> | | | **name__iexact** | Option<**String**> | | | **ordering** | Option<**String**> | Which field to use when ordering the results. | | **page** | Option<**i32**> | A page number within the paginated result set. | | **page_size** | Option<**i32**> | Number of results to return per page. | | **search** | Option<**String**> | A search term. | | ### Return type [**models::PaginatedRacProviderList**](PaginatedRACProviderList.md) ### Authorization [authentik](../README.md#authentik) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) ## providers_rac_partial_update > models::RacProvider providers_rac_partial_update(id, patched_rac_provider_request) RACProvider Viewset ### Parameters Name | Type | Description | Required | Notes ------------- | ------------- | ------------- | ------------- | ------------- **id** | **i32** | A unique integer value identifying this RAC Provider. | [required] | **patched_rac_provider_request** | Option<[**PatchedRacProviderRequest**](PatchedRacProviderRequest.md)> | | | ### Return type [**models::RacProvider**](RACProvider.md) ### Authorization [authentik](../README.md#authentik) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) ## providers_rac_retrieve > models::RacProvider providers_rac_retrieve(id) RACProvider Viewset ### Parameters Name | Type | Description | Required | Notes ------------- | ------------- | ------------- | ------------- | ------------- **id** | **i32** | A unique integer value identifying this RAC Provider. | [required] | ### Return type [**models::RacProvider**](RACProvider.md) ### Authorization [authentik](../README.md#authentik) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) ## providers_rac_update > models::RacProvider providers_rac_update(id, rac_provider_request) RACProvider Viewset ### Parameters Name | Type | Description | Required | Notes ------------- | ------------- | ------------- | ------------- | ------------- **id** | **i32** | A unique integer value identifying this RAC Provider. | [required] | **rac_provider_request** | [**RacProviderRequest**](RacProviderRequest.md) | | [required] | ### Return type [**models::RacProvider**](RACProvider.md) ### Authorization [authentik](../README.md#authentik) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) ## providers_rac_used_by_list > Vec providers_rac_used_by_list(id) Get a list of all objects that use this object ### Parameters Name | Type | Description | Required | Notes ------------- | ------------- | ------------- | ------------- | ------------- **id** | **i32** | A unique integer value identifying this RAC Provider. | [required] | ### Return type [**Vec**](UsedBy.md) ### Authorization [authentik](../README.md#authentik) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) ## providers_radius_create > models::RadiusProvider providers_radius_create(radius_provider_request) RadiusProvider Viewset ### Parameters Name | Type | Description | Required | Notes ------------- | ------------- | ------------- | ------------- | ------------- **radius_provider_request** | [**RadiusProviderRequest**](RadiusProviderRequest.md) | | [required] | ### Return type [**models::RadiusProvider**](RadiusProvider.md) ### Authorization [authentik](../README.md#authentik) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) ## providers_radius_destroy > providers_radius_destroy(id) RadiusProvider Viewset ### Parameters Name | Type | Description | Required | Notes ------------- | ------------- | ------------- | ------------- | ------------- **id** | **i32** | A unique integer value identifying this Radius Provider. | [required] | ### Return type (empty response body) ### Authorization [authentik](../README.md#authentik) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) ## providers_radius_list > models::PaginatedRadiusProviderList providers_radius_list(application__isnull, authorization_flow__slug__iexact, client_networks__iexact, name__iexact, ordering, page, page_size, search) RadiusProvider Viewset ### Parameters Name | Type | Description | Required | Notes ------------- | ------------- | ------------- | ------------- | ------------- **application__isnull** | Option<**bool**> | | | **authorization_flow__slug__iexact** | Option<**String**> | | | **client_networks__iexact** | Option<**String**> | | | **name__iexact** | Option<**String**> | | | **ordering** | Option<**String**> | Which field to use when ordering the results. | | **page** | Option<**i32**> | A page number within the paginated result set. | | **page_size** | Option<**i32**> | Number of results to return per page. | | **search** | Option<**String**> | A search term. | | ### Return type [**models::PaginatedRadiusProviderList**](PaginatedRadiusProviderList.md) ### Authorization [authentik](../README.md#authentik) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) ## providers_radius_partial_update > models::RadiusProvider providers_radius_partial_update(id, patched_radius_provider_request) RadiusProvider Viewset ### Parameters Name | Type | Description | Required | Notes ------------- | ------------- | ------------- | ------------- | ------------- **id** | **i32** | A unique integer value identifying this Radius Provider. | [required] | **patched_radius_provider_request** | Option<[**PatchedRadiusProviderRequest**](PatchedRadiusProviderRequest.md)> | | | ### Return type [**models::RadiusProvider**](RadiusProvider.md) ### Authorization [authentik](../README.md#authentik) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) ## providers_radius_retrieve > models::RadiusProvider providers_radius_retrieve(id) RadiusProvider Viewset ### Parameters Name | Type | Description | Required | Notes ------------- | ------------- | ------------- | ------------- | ------------- **id** | **i32** | A unique integer value identifying this Radius Provider. | [required] | ### Return type [**models::RadiusProvider**](RadiusProvider.md) ### Authorization [authentik](../README.md#authentik) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) ## providers_radius_update > models::RadiusProvider providers_radius_update(id, radius_provider_request) RadiusProvider Viewset ### Parameters Name | Type | Description | Required | Notes ------------- | ------------- | ------------- | ------------- | ------------- **id** | **i32** | A unique integer value identifying this Radius Provider. | [required] | **radius_provider_request** | [**RadiusProviderRequest**](RadiusProviderRequest.md) | | [required] | ### Return type [**models::RadiusProvider**](RadiusProvider.md) ### Authorization [authentik](../README.md#authentik) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) ## providers_radius_used_by_list > Vec providers_radius_used_by_list(id) Get a list of all objects that use this object ### Parameters Name | Type | Description | Required | Notes ------------- | ------------- | ------------- | ------------- | ------------- **id** | **i32** | A unique integer value identifying this Radius Provider. | [required] | ### Return type [**Vec**](UsedBy.md) ### Authorization [authentik](../README.md#authentik) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) ## providers_saml_create > models::SamlProvider providers_saml_create(saml_provider_request) SAMLProvider Viewset ### Parameters Name | Type | Description | Required | Notes ------------- | ------------- | ------------- | ------------- | ------------- **saml_provider_request** | [**SamlProviderRequest**](SamlProviderRequest.md) | | [required] | ### Return type [**models::SamlProvider**](SAMLProvider.md) ### Authorization [authentik](../README.md#authentik) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) ## providers_saml_destroy > providers_saml_destroy(id) SAMLProvider Viewset ### Parameters Name | Type | Description | Required | Notes ------------- | ------------- | ------------- | ------------- | ------------- **id** | **i32** | A unique integer value identifying this SAML Provider. | [required] | ### Return type (empty response body) ### Authorization [authentik](../README.md#authentik) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) ## providers_saml_import_metadata_create > providers_saml_import_metadata_create(name, authorization_flow, file) Create provider from SAML Metadata ### Parameters Name | Type | Description | Required | Notes ------------- | ------------- | ------------- | ------------- | ------------- **name** | **String** | | [required] | **authorization_flow** | **uuid::Uuid** | | [required] | **file** | **std::path::PathBuf** | | [required] | ### Return type (empty response body) ### Authorization [authentik](../README.md#authentik) ### HTTP request headers - **Content-Type**: multipart/form-data - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) ## providers_saml_list > models::PaginatedSamlProviderList providers_saml_list(acs_url, assertion_valid_not_before, assertion_valid_not_on_or_after, audience, authentication_flow, authorization_flow, backchannel_application, default_relay_state, digest_algorithm, is_backchannel, issuer, name, name_id_mapping, ordering, page, page_size, property_mappings, search, session_valid_not_on_or_after, signature_algorithm, signing_kp, sp_binding, verification_kp) SAMLProvider Viewset ### Parameters Name | Type | Description | Required | Notes ------------- | ------------- | ------------- | ------------- | ------------- **acs_url** | Option<**String**> | | | **assertion_valid_not_before** | Option<**String**> | | | **assertion_valid_not_on_or_after** | Option<**String**> | | | **audience** | Option<**String**> | | | **authentication_flow** | Option<**uuid::Uuid**> | | | **authorization_flow** | Option<**uuid::Uuid**> | | | **backchannel_application** | Option<**uuid::Uuid**> | | | **default_relay_state** | Option<**String**> | | | **digest_algorithm** | Option<**String**> | * `http://www.w3.org/2000/09/xmldsig#sha1` - SHA1 * `http://www.w3.org/2001/04/xmlenc#sha256` - SHA256 * `http://www.w3.org/2001/04/xmldsig-more#sha384` - SHA384 * `http://www.w3.org/2001/04/xmlenc#sha512` - SHA512 | | **is_backchannel** | Option<**bool**> | | | **issuer** | Option<**String**> | | | **name** | Option<**String**> | | | **name_id_mapping** | Option<**uuid::Uuid**> | | | **ordering** | Option<**String**> | Which field to use when ordering the results. | | **page** | Option<**i32**> | A page number within the paginated result set. | | **page_size** | Option<**i32**> | Number of results to return per page. | | **property_mappings** | Option<[**Vec**](uuid::Uuid.md)> | | | **search** | Option<**String**> | A search term. | | **session_valid_not_on_or_after** | Option<**String**> | | | **signature_algorithm** | Option<**String**> | * `http://www.w3.org/2000/09/xmldsig#rsa-sha1` - RSA-SHA1 * `http://www.w3.org/2001/04/xmldsig-more#rsa-sha256` - RSA-SHA256 * `http://www.w3.org/2001/04/xmldsig-more#rsa-sha384` - RSA-SHA384 * `http://www.w3.org/2001/04/xmldsig-more#rsa-sha512` - RSA-SHA512 * `http://www.w3.org/2000/09/xmldsig#dsa-sha1` - DSA-SHA1 | | **signing_kp** | Option<**uuid::Uuid**> | | | **sp_binding** | Option<**String**> | This determines how authentik sends the response back to the Service Provider. * `redirect` - Redirect * `post` - Post | | **verification_kp** | Option<**uuid::Uuid**> | | | ### Return type [**models::PaginatedSamlProviderList**](PaginatedSAMLProviderList.md) ### Authorization [authentik](../README.md#authentik) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) ## providers_saml_metadata_retrieve > models::SamlMetadata providers_saml_metadata_retrieve(id, download, force_binding) Return metadata as XML string ### Parameters Name | Type | Description | Required | Notes ------------- | ------------- | ------------- | ------------- | ------------- **id** | **i32** | A unique integer value identifying this SAML Provider. | [required] | **download** | Option<**bool**> | | | **force_binding** | Option<**String**> | Optionally force the metadata to only include one binding. | | ### Return type [**models::SamlMetadata**](SAMLMetadata.md) ### Authorization [authentik](../README.md#authentik) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) ## providers_saml_partial_update > models::SamlProvider providers_saml_partial_update(id, patched_saml_provider_request) SAMLProvider Viewset ### Parameters Name | Type | Description | Required | Notes ------------- | ------------- | ------------- | ------------- | ------------- **id** | **i32** | A unique integer value identifying this SAML Provider. | [required] | **patched_saml_provider_request** | Option<[**PatchedSamlProviderRequest**](PatchedSamlProviderRequest.md)> | | | ### Return type [**models::SamlProvider**](SAMLProvider.md) ### Authorization [authentik](../README.md#authentik) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) ## providers_saml_preview_user_retrieve > models::PropertyMappingPreview providers_saml_preview_user_retrieve(id, for_user) Preview user data for provider ### Parameters Name | Type | Description | Required | Notes ------------- | ------------- | ------------- | ------------- | ------------- **id** | **i32** | A unique integer value identifying this SAML Provider. | [required] | **for_user** | Option<**i32**> | | | ### Return type [**models::PropertyMappingPreview**](PropertyMappingPreview.md) ### Authorization [authentik](../README.md#authentik) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) ## providers_saml_retrieve > models::SamlProvider providers_saml_retrieve(id) SAMLProvider Viewset ### Parameters Name | Type | Description | Required | Notes ------------- | ------------- | ------------- | ------------- | ------------- **id** | **i32** | A unique integer value identifying this SAML Provider. | [required] | ### Return type [**models::SamlProvider**](SAMLProvider.md) ### Authorization [authentik](../README.md#authentik) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) ## providers_saml_update > models::SamlProvider providers_saml_update(id, saml_provider_request) SAMLProvider Viewset ### Parameters Name | Type | Description | Required | Notes ------------- | ------------- | ------------- | ------------- | ------------- **id** | **i32** | A unique integer value identifying this SAML Provider. | [required] | **saml_provider_request** | [**SamlProviderRequest**](SamlProviderRequest.md) | | [required] | ### Return type [**models::SamlProvider**](SAMLProvider.md) ### Authorization [authentik](../README.md#authentik) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) ## providers_saml_used_by_list > Vec providers_saml_used_by_list(id) Get a list of all objects that use this object ### Parameters Name | Type | Description | Required | Notes ------------- | ------------- | ------------- | ------------- | ------------- **id** | **i32** | A unique integer value identifying this SAML Provider. | [required] | ### Return type [**Vec**](UsedBy.md) ### Authorization [authentik](../README.md#authentik) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) ## providers_scim_create > models::ScimProvider providers_scim_create(scim_provider_request) SCIMProvider Viewset ### Parameters Name | Type | Description | Required | Notes ------------- | ------------- | ------------- | ------------- | ------------- **scim_provider_request** | [**ScimProviderRequest**](ScimProviderRequest.md) | | [required] | ### Return type [**models::ScimProvider**](SCIMProvider.md) ### Authorization [authentik](../README.md#authentik) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) ## providers_scim_destroy > providers_scim_destroy(id) SCIMProvider Viewset ### Parameters Name | Type | Description | Required | Notes ------------- | ------------- | ------------- | ------------- | ------------- **id** | **i32** | A unique integer value identifying this SCIM Provider. | [required] | ### Return type (empty response body) ### Authorization [authentik](../README.md#authentik) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) ## providers_scim_list > models::PaginatedScimProviderList providers_scim_list(exclude_users_service_account, filter_group, name, ordering, page, page_size, search, url) SCIMProvider Viewset ### Parameters Name | Type | Description | Required | Notes ------------- | ------------- | ------------- | ------------- | ------------- **exclude_users_service_account** | Option<**bool**> | | | **filter_group** | Option<**uuid::Uuid**> | | | **name** | Option<**String**> | | | **ordering** | Option<**String**> | Which field to use when ordering the results. | | **page** | Option<**i32**> | A page number within the paginated result set. | | **page_size** | Option<**i32**> | Number of results to return per page. | | **search** | Option<**String**> | A search term. | | **url** | Option<**String**> | | | ### Return type [**models::PaginatedScimProviderList**](PaginatedSCIMProviderList.md) ### Authorization [authentik](../README.md#authentik) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) ## providers_scim_partial_update > models::ScimProvider providers_scim_partial_update(id, patched_scim_provider_request) SCIMProvider Viewset ### Parameters Name | Type | Description | Required | Notes ------------- | ------------- | ------------- | ------------- | ------------- **id** | **i32** | A unique integer value identifying this SCIM Provider. | [required] | **patched_scim_provider_request** | Option<[**PatchedScimProviderRequest**](PatchedScimProviderRequest.md)> | | | ### Return type [**models::ScimProvider**](SCIMProvider.md) ### Authorization [authentik](../README.md#authentik) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) ## providers_scim_retrieve > models::ScimProvider providers_scim_retrieve(id) SCIMProvider Viewset ### Parameters Name | Type | Description | Required | Notes ------------- | ------------- | ------------- | ------------- | ------------- **id** | **i32** | A unique integer value identifying this SCIM Provider. | [required] | ### Return type [**models::ScimProvider**](SCIMProvider.md) ### Authorization [authentik](../README.md#authentik) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) ## providers_scim_sync_status_retrieve > models::ScimSyncStatus providers_scim_sync_status_retrieve(id) Get provider's sync status ### Parameters Name | Type | Description | Required | Notes ------------- | ------------- | ------------- | ------------- | ------------- **id** | **i32** | A unique integer value identifying this SCIM Provider. | [required] | ### Return type [**models::ScimSyncStatus**](SCIMSyncStatus.md) ### Authorization [authentik](../README.md#authentik) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) ## providers_scim_update > models::ScimProvider providers_scim_update(id, scim_provider_request) SCIMProvider Viewset ### Parameters Name | Type | Description | Required | Notes ------------- | ------------- | ------------- | ------------- | ------------- **id** | **i32** | A unique integer value identifying this SCIM Provider. | [required] | **scim_provider_request** | [**ScimProviderRequest**](ScimProviderRequest.md) | | [required] | ### Return type [**models::ScimProvider**](SCIMProvider.md) ### Authorization [authentik](../README.md#authentik) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) ## providers_scim_used_by_list > Vec providers_scim_used_by_list(id) Get a list of all objects that use this object ### Parameters Name | Type | Description | Required | Notes ------------- | ------------- | ------------- | ------------- | ------------- **id** | **i32** | A unique integer value identifying this SCIM Provider. | [required] | ### Return type [**Vec**](UsedBy.md) ### Authorization [authentik](../README.md#authentik) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)