# \LDAPApi All URIs are relative to *http://your-mattermost-url.com/api/v4* Method | HTTP request | Description ------------- | ------------- | ------------- [**delete_ldap_private_certificate**](LDAPApi.md#delete_ldap_private_certificate) | **DELETE** /ldap/certificate/private | Remove private key [**delete_ldap_public_certificate**](LDAPApi.md#delete_ldap_public_certificate) | **DELETE** /ldap/certificate/public | Remove public certificate [**migrate_auth_to_ldap**](LDAPApi.md#migrate_auth_to_ldap) | **POST** /users/migrate_auth/ldap | Migrate user accounts authentication type to LDAP. [**migrate_id_ldap**](LDAPApi.md#migrate_id_ldap) | **POST** /ldap/migrateid | Migrate Id LDAP [**sync_ldap**](LDAPApi.md#sync_ldap) | **POST** /ldap/sync | Sync with LDAP [**test_ldap**](LDAPApi.md#test_ldap) | **POST** /ldap/test | Test LDAP configuration [**upload_ldap_private_certificate**](LDAPApi.md#upload_ldap_private_certificate) | **POST** /ldap/certificate/private | Upload private key [**upload_ldap_public_certificate**](LDAPApi.md#upload_ldap_public_certificate) | **POST** /ldap/certificate/public | Upload public certificate ## delete_ldap_private_certificate > crate::models::StatusOk delete_ldap_private_certificate() Remove private key Delete the current private key being used with your TLS verification. ##### Permissions Must have `manage_system` permission. ### Parameters This endpoint does not need any parameter. ### Return type [**crate::models::StatusOk**](StatusOK.md) ### Authorization [bearerAuth](../README.md#bearerAuth) ### 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) ## delete_ldap_public_certificate > crate::models::StatusOk delete_ldap_public_certificate() Remove public certificate Delete the current public certificate being used for TLS verification. ##### Permissions Must have `manage_system` permission. ### Parameters This endpoint does not need any parameter. ### Return type [**crate::models::StatusOk**](StatusOK.md) ### Authorization [bearerAuth](../README.md#bearerAuth) ### 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) ## migrate_auth_to_ldap > migrate_auth_to_ldap(inline_object26) Migrate user accounts authentication type to LDAP. Migrates accounts from one authentication provider to another. For example, you can upgrade your authentication provider from email to LDAP. __Minimum server version__: 5.28 ##### Permissions Must have `manage_system` permission. ### Parameters Name | Type | Description | Required | Notes ------------- | ------------- | ------------- | ------------- | ------------- **inline_object26** | Option<[**InlineObject26**](InlineObject26.md)> | | | ### Return type (empty response body) ### Authorization [bearerAuth](../README.md#bearerAuth) ### 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) ## migrate_id_ldap > crate::models::StatusOk migrate_id_ldap(inline_object84) Migrate Id LDAP Migrate LDAP IdAttribute to new value. ##### Permissions Must have `manage_system` permission. __Minimum server version__: 5.26 ### Parameters Name | Type | Description | Required | Notes ------------- | ------------- | ------------- | ------------- | ------------- **inline_object84** | [**InlineObject84**](InlineObject84.md) | | [required] | ### Return type [**crate::models::StatusOk**](StatusOK.md) ### Authorization [bearerAuth](../README.md#bearerAuth) ### 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) ## sync_ldap > crate::models::StatusOk sync_ldap() Sync with LDAP Synchronize any user attribute changes in the configured AD/LDAP server with Mattermost. ##### Permissions Must have `manage_system` permission. ### Parameters This endpoint does not need any parameter. ### Return type [**crate::models::StatusOk**](StatusOK.md) ### Authorization [bearerAuth](../README.md#bearerAuth) ### 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) ## test_ldap > crate::models::StatusOk test_ldap() Test LDAP configuration Test the current AD/LDAP configuration to see if the AD/LDAP server can be contacted successfully. ##### Permissions Must have `manage_system` permission. ### Parameters This endpoint does not need any parameter. ### Return type [**crate::models::StatusOk**](StatusOK.md) ### Authorization [bearerAuth](../README.md#bearerAuth) ### 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) ## upload_ldap_private_certificate > crate::models::StatusOk upload_ldap_private_certificate(certificate) Upload private key Upload the private key to be used for TLS verification. The server will pick a hard-coded filename for the PrivateKeyFile setting in your `config.json`. ##### Permissions Must have `manage_system` permission. ### Parameters Name | Type | Description | Required | Notes ------------- | ------------- | ------------- | ------------- | ------------- **certificate** | **std::path::PathBuf** | The private key file | [required] | ### Return type [**crate::models::StatusOk**](StatusOK.md) ### Authorization [bearerAuth](../README.md#bearerAuth) ### 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) ## upload_ldap_public_certificate > crate::models::StatusOk upload_ldap_public_certificate(certificate) Upload public certificate Upload the public certificate to be used for TLS verification. The server will pick a hard-coded filename for the PublicCertificateFile setting in your `config.json`. ##### Permissions Must have `manage_system` permission. ### Parameters Name | Type | Description | Required | Notes ------------- | ------------- | ------------- | ------------- | ------------- **certificate** | **std::path::PathBuf** | The public certificate file | [required] | ### Return type [**crate::models::StatusOk**](StatusOK.md) ### Authorization [bearerAuth](../README.md#bearerAuth) ### 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)