Ldap

class matterapi.endpoints.async_api.LdapApi(client: matterapi.client.base.BaseClient, skip_response_parsing: bool = False)

Endpoints for configuring and interacting with LDAP.

async delete_ldap_private_certificate() → matterapi.models.StatusOK

Remove private key

Delete the current private key being used with your TLS verification.

Permissions:: Must have manage_system permission.
Api Reference:: DeleteLdapPrivateCertificate

async delete_ldap_public_certificate() → matterapi.models.StatusOK

Remove public certificate

Delete the current public certificate being used for TLS verification.

Permissions:: Must have manage_system permission.
Api Reference:: DeleteLdapPublicCertificate

async get_ldap_groups(*, q: Optional[str] = None, page: Optional[int] = 0, per_page: Optional[int] = 60) → List[matterapi.models.LDAPGroupsPaged]

Returns a list of LDAP groups

Permissions:: Must have manage_system permission.
Minimum Server Version:: 5.11
Api Reference:: GetLdapGroups

async link_ldap_group(remote_id: str) → matterapi.models.StatusOK

Link a LDAP group

Permissions:: Must have manage_system permission.
Minimum Server Version:: 5.11
Api Reference:: LinkLdapGroup

async migrate_auth_to_ldap(*, json_body: Union[matterapi.models.MigrateAuthToLdapJsonBody, Dict]) → None

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.

Permissions:: Must have manage_system permission.
Minimum Server Version:: 5.28
Api Reference:: MigrateAuthToLdap

async migrate_id_ldap(*, json_body: Union[matterapi.models.MigrateIdLdapJsonBody, Dict]) → matterapi.models.StatusOK

Migrate Id LDAP

Migrate LDAP IdAttribute to new value.

Permissions:: Must have manage_system permission.
Minimum Server Version:: 5.26
Api Reference:: MigrateIdLdap

async sync_ldap() → matterapi.models.StatusOK

Sync with LDAP

Synchronize any user attribute changes in the configured AD/LDAP server with Mattermost.

Permissions:: Must have manage_system permission.
Api Reference:: SyncLdap

async test_ldap() → matterapi.models.StatusOK

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.
Api Reference:: TestLdap

async upload_ldap_private_certificate(*, multipart_data: Union[matterapi.models.UploadLdapPrivateCertificateMultipartData, Dict]) → matterapi.models.StatusOK

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.
Api Reference:: UploadLdapPrivateCertificate

async upload_ldap_public_certificate(*, multipart_data: Union[matterapi.models.UploadLdapPublicCertificateMultipartData, Dict]) → matterapi.models.StatusOK

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.
Api Reference:: UploadLdapPublicCertificate