Documentation
¶
Overview ¶
Copyright 2020 ForgeRock AS.
Package ldap provides ldap client access to our DS deployment. Used to manage users, etc.
Index ¶
- type DSConnection
- func (ds *DSConnection) Close()
- func (ds *DSConnection) Connect() error
- func (ds *DSConnection) DeleteBackupTask(id string) error
- func (ds *DSConnection) GetBackupTask(id string) (*dir.DirectoryBackup, error)
- func (ds *DSConnection) GetBackupTaskStatus(id string) ([]dir.DirectoryBackupStatus, error)
- func (ds *DSConnection) GetMonitorData() error
- func (ds *DSConnection) ScheduleBackup(id string, d *dir.DirectoryBackup) error
- func (ds *DSConnection) UpdatePassword(DN, newPassword string) error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type DSConnection ¶
type DSConnection struct {
URL string
DN string
Password string
// contains filtered or unexported fields
}
DSConnection parameters for managing the DS ldap service
func (*DSConnection) Connect ¶
func (ds *DSConnection) Connect() error
Connect to LDAP server via admin credentials
func (*DSConnection) DeleteBackupTask ¶
func (ds *DSConnection) DeleteBackupTask(id string) error
DeleteBackupTask deletes a scheduled backup and purge tasks in DS. deletes the backup and the purge tasks in DS TODO: Check for Not found error code- which we can ignore and not consider an error
func (*DSConnection) GetBackupTask ¶
func (ds *DSConnection) GetBackupTask(id string) (*dir.DirectoryBackup, error)
GetBackupTask reads the directory and gets the current state of the backup task.
func (*DSConnection) GetBackupTaskStatus ¶
func (ds *DSConnection) GetBackupTaskStatus(id string) ([]dir.DirectoryBackupStatus, error)
GetBackupTaskStatus queries for the completed backup tasks for the given id
func (*DSConnection) GetMonitorData ¶
func (ds *DSConnection) GetMonitorData() error
GetMonitorData returns cn=monitor data. We use thi for status updates. todo: What kinds of data do we want?
func (*DSConnection) ScheduleBackup ¶
func (ds *DSConnection) ScheduleBackup(id string, d *dir.DirectoryBackup) error
ScheduleBackup - create or update a backup and purge tasks
func (*DSConnection) UpdatePassword ¶
func (ds *DSConnection) UpdatePassword(DN, newPassword string) error
UpdatePassword changes the password for the user identified by the DN. This is done as an administrative password change The old password is not required.
Source Files