ipa

package module

Go to main page

Versions in this module

v1

v1.1.0

Oct 28, 2026

Changes in this version

type Client

+ func (c *Client) HostAdd(h *Host, force, random bool) (*Host, error)

+ func (c *Client) HostAddContext(ctx context.Context, h *Host, force, random bool) (*Host, error)

+ func (c *Client) HostAddWithPassword(h *Host, force bool, password string) (*Host, error)

+ func (c *Client) HostAddWithPasswordContext(ctx context.Context, h *Host, force bool, password string) (*Host, error)

+ func (c *Client) HostDelete(updateDNS bool, fqdns ...string) error

+ func (c *Client) HostDeleteContext(ctx context.Context, updateDNS bool, fqdns ...string) error

+ func (c *Client) HostDisable(fqdn string) error

+ func (c *Client) HostDisableContext(ctx context.Context, fqdn string) error

+ func (c *Client) HostMod(h *Host) (*Host, error)

+ func (c *Client) HostModContext(ctx context.Context, h *Host) (*Host, error)

+ func (c *Client) StageUserAddWithPassword(user *User, password string) (*User, error)

+ func (c *Client) StageUserAddWithPasswordContext(ctx context.Context, user *User, password string) (*User, error)

type Host

+ RandomPassword string

type Option

+ func WithTruncationErrors() Option

v1.0.0

Oct 25, 2026

v0

v0.9.1

Oct 24, 2026

v0.9.0

Oct 24, 2026

Changes in this version

+ const AutomemberGroup

+ const AutomemberHostGroup

+ type AutomemberCondition struct

+ Key string

+ Regex string

+ type AutomemberRule struct

+ Description string

+ Exclusive []AutomemberCondition

+ Inclusive []AutomemberCondition

+ Name string

+ Type string

+ type Certificate struct

+ DER []byte

+ Issuer string

+ NotAfter time.Time

+ NotBefore time.Time

+ RevocationReason int

+ Revoked bool

+ SerialNumber string

+ Subject string

type Client

+ func (c *Client) AutomemberAdd(typ, name, description string) (*AutomemberRule, error)

+ func (c *Client) AutomemberAddCondition(typ, name, key string, inclusive, exclusive []string) (*AutomemberRule, error)

+ func (c *Client) AutomemberAddConditionContext(ctx context.Context, typ, name, key string, inclusive, exclusive []string) (*AutomemberRule, error)

+ func (c *Client) AutomemberAddContext(ctx context.Context, typ, name, description string) (*AutomemberRule, error)

+ func (c *Client) AutomemberDefaultGroup(typ string) (string, error)

+ func (c *Client) AutomemberDefaultGroupContext(ctx context.Context, typ string) (string, error)

+ func (c *Client) AutomemberDelete(typ string, names ...string) error

+ func (c *Client) AutomemberDeleteContext(ctx context.Context, typ string, names ...string) error

+ func (c *Client) AutomemberFind(typ string, options Options) ([]*AutomemberRule, error)

+ func (c *Client) AutomemberFindContext(ctx context.Context, typ string, options Options) ([]*AutomemberRule, error)

+ func (c *Client) AutomemberRebuild(typ string) error

+ func (c *Client) AutomemberRebuildContext(ctx context.Context, typ string) error

+ func (c *Client) AutomemberRemoveCondition(typ, name, key string, inclusive, exclusive []string) (*AutomemberRule, error)

+ func (c *Client) AutomemberRemoveConditionContext(ctx context.Context, typ, name, key string, inclusive, exclusive []string) (*AutomemberRule, error)

+ func (c *Client) AutomemberRemoveDefaultGroup(typ string) error

+ func (c *Client) AutomemberRemoveDefaultGroupContext(ctx context.Context, typ string) error

+ func (c *Client) AutomemberSetDefaultGroup(typ, group string) error

+ func (c *Client) AutomemberSetDefaultGroupContext(ctx context.Context, typ, group string) error

+ func (c *Client) AutomemberShow(typ, name string) (*AutomemberRule, error)

+ func (c *Client) AutomemberShowContext(ctx context.Context, typ, name string) (*AutomemberRule, error)

+ func (c *Client) CertRequest(principal, csrPEM string) (*Certificate, error)

+ func (c *Client) CertRequestContext(ctx context.Context, principal, csrPEM string) (*Certificate, error)

+ func (c *Client) CertRevoke(serial string, reason int) error

+ func (c *Client) CertRevokeContext(ctx context.Context, serial string, reason int) error

+ func (c *Client) CertShow(serial string) (*Certificate, error)

+ func (c *Client) CertShowContext(ctx context.Context, serial string) (*Certificate, error)

+ func (c *Client) DNSRecordAdd(zone, name, rtype string, values ...string) (*DNSRecord, error)

+ func (c *Client) DNSRecordAddContext(ctx context.Context, zone, name, rtype string, values ...string) (*DNSRecord, error)

+ func (c *Client) DNSRecordDelete(zone, name string) error

+ func (c *Client) DNSRecordDeleteContext(ctx context.Context, zone, name string) error

+ func (c *Client) DNSRecordFind(zone string, options Options) ([]*DNSRecord, error)

+ func (c *Client) DNSRecordFindContext(ctx context.Context, zone string, options Options) ([]*DNSRecord, error)

+ func (c *Client) DNSRecordRemove(zone, name, rtype string, values ...string) error

+ func (c *Client) DNSRecordRemoveContext(ctx context.Context, zone, name, rtype string, values ...string) error

+ func (c *Client) DNSRecordShow(zone, name string) (*DNSRecord, error)

+ func (c *Client) DNSRecordShowContext(ctx context.Context, zone, name string) (*DNSRecord, error)

+ func (c *Client) DNSZoneAdd(name string, force bool) (*DNSZone, error)

+ func (c *Client) DNSZoneAddContext(ctx context.Context, name string, force bool) (*DNSZone, error)

+ func (c *Client) DNSZoneDelete(names ...string) error

+ func (c *Client) DNSZoneDeleteContext(ctx context.Context, names ...string) error

+ func (c *Client) DNSZoneDisable(name string) error

+ func (c *Client) DNSZoneDisableContext(ctx context.Context, name string) error

+ func (c *Client) DNSZoneEnable(name string) error

+ func (c *Client) DNSZoneEnableContext(ctx context.Context, name string) error

+ func (c *Client) DNSZoneFind(options Options) ([]*DNSZone, error)

+ func (c *Client) DNSZoneFindContext(ctx context.Context, options Options) ([]*DNSZone, error)

+ func (c *Client) DNSZoneShow(name string) (*DNSZone, error)

+ func (c *Client) DNSZoneShowContext(ctx context.Context, name string) (*DNSZone, error)

+ func (c *Client) HBACRuleAdd(r *HBACRule) (*HBACRule, error)

+ func (c *Client) HBACRuleAddContext(ctx context.Context, r *HBACRule) (*HBACRule, error)

+ func (c *Client) HBACRuleAddHost(name string, hosts, hostgroups []string) (*HBACRule, error)

+ func (c *Client) HBACRuleAddHostContext(ctx context.Context, name string, hosts, hostgroups []string) (*HBACRule, error)

+ func (c *Client) HBACRuleAddService(name string, services, servicegroups []string) (*HBACRule, error)

+ func (c *Client) HBACRuleAddServiceContext(ctx context.Context, name string, services, servicegroups []string) (*HBACRule, error)

+ func (c *Client) HBACRuleAddUser(name string, users, groups []string) (*HBACRule, error)

+ func (c *Client) HBACRuleAddUserContext(ctx context.Context, name string, users, groups []string) (*HBACRule, error)

+ func (c *Client) HBACRuleDelete(names ...string) error

+ func (c *Client) HBACRuleDeleteContext(ctx context.Context, names ...string) error

+ func (c *Client) HBACRuleDisable(name string) error

+ func (c *Client) HBACRuleDisableContext(ctx context.Context, name string) error

+ func (c *Client) HBACRuleEnable(name string) error

+ func (c *Client) HBACRuleEnableContext(ctx context.Context, name string) error

+ func (c *Client) HBACRuleRemoveHost(name string, hosts, hostgroups []string) (*HBACRule, error)

+ func (c *Client) HBACRuleRemoveHostContext(ctx context.Context, name string, hosts, hostgroups []string) (*HBACRule, error)

+ func (c *Client) HBACRuleRemoveService(name string, services, servicegroups []string) (*HBACRule, error)

+ func (c *Client) HBACRuleRemoveServiceContext(ctx context.Context, name string, services, servicegroups []string) (*HBACRule, error)

+ func (c *Client) HBACRuleRemoveUser(name string, users, groups []string) (*HBACRule, error)

+ func (c *Client) HBACRuleRemoveUserContext(ctx context.Context, name string, users, groups []string) (*HBACRule, error)

+ func (c *Client) HBACRuleShow(name string) (*HBACRule, error)

+ func (c *Client) HBACRuleShowContext(ctx context.Context, name string) (*HBACRule, error)

+ func (c *Client) HostGroupAdd(g *HostGroup) (*HostGroup, error)

+ func (c *Client) HostGroupAddContext(ctx context.Context, g *HostGroup) (*HostGroup, error)

+ func (c *Client) HostGroupAddMember(name string, hosts, hostgroups []string) (*HostGroup, error)

+ func (c *Client) HostGroupAddMemberContext(ctx context.Context, name string, hosts, hostgroups []string) (*HostGroup, error)

+ func (c *Client) HostGroupAddMemberManager(name string, users, groups []string) (*HostGroup, error)

+ func (c *Client) HostGroupAddMemberManagerContext(ctx context.Context, name string, users, groups []string) (*HostGroup, error)

+ func (c *Client) HostGroupDelete(names ...string) error

+ func (c *Client) HostGroupDeleteContext(ctx context.Context, names ...string) error

+ func (c *Client) HostGroupFind(options Options) ([]*HostGroup, error)

+ func (c *Client) HostGroupFindContext(ctx context.Context, options Options) ([]*HostGroup, error)

+ func (c *Client) HostGroupRemoveMember(name string, hosts, hostgroups []string) (*HostGroup, error)

+ func (c *Client) HostGroupRemoveMemberContext(ctx context.Context, name string, hosts, hostgroups []string) (*HostGroup, error)

+ func (c *Client) HostGroupRemoveMemberManager(name string, users, groups []string) (*HostGroup, error)

+ func (c *Client) HostGroupRemoveMemberManagerContext(ctx context.Context, name string, users, groups []string) (*HostGroup, error)

+ func (c *Client) HostGroupShow(name string) (*HostGroup, error)

+ func (c *Client) HostGroupShowContext(ctx context.Context, name string) (*HostGroup, error)

+ func (c *Client) PermissionFind(options Options) ([]*Permission, error)

+ func (c *Client) PermissionFindContext(ctx context.Context, options Options) ([]*Permission, error)

+ func (c *Client) PermissionShow(name string) (*Permission, error)

+ func (c *Client) PermissionShowContext(ctx context.Context, name string) (*Permission, error)

+ func (c *Client) PrivilegeFind(options Options) ([]*Privilege, error)

+ func (c *Client) PrivilegeFindContext(ctx context.Context, options Options) ([]*Privilege, error)

+ func (c *Client) PrivilegeShow(name string) (*Privilege, error)

+ func (c *Client) PrivilegeShowContext(ctx context.Context, name string) (*Privilege, error)

+ func (c *Client) RoleFind(options Options) ([]*Role, error)

+ func (c *Client) RoleFindContext(ctx context.Context, options Options) ([]*Role, error)

+ func (c *Client) RoleShow(name string) (*Role, error)

+ func (c *Client) RoleShowContext(ctx context.Context, name string) (*Role, error)

+ func (c *Client) ServiceAdd(principal string, force bool) (*Service, error)

+ func (c *Client) ServiceAddContext(ctx context.Context, principal string, force bool) (*Service, error)

+ func (c *Client) ServiceAddHost(principal string, hosts []string) (*Service, error)

+ func (c *Client) ServiceAddHostContext(ctx context.Context, principal string, hosts []string) (*Service, error)

+ func (c *Client) ServiceAllowCreateKeytab(principal string, a KeytabAccess) (*Service, error)

+ func (c *Client) ServiceAllowCreateKeytabContext(ctx context.Context, principal string, a KeytabAccess) (*Service, error)

+ func (c *Client) ServiceAllowRetrieveKeytab(principal string, a KeytabAccess) (*Service, error)

+ func (c *Client) ServiceAllowRetrieveKeytabContext(ctx context.Context, principal string, a KeytabAccess) (*Service, error)

+ func (c *Client) ServiceDelete(principals ...string) error

+ func (c *Client) ServiceDeleteContext(ctx context.Context, principals ...string) error

+ func (c *Client) ServiceDisable(principal string) error

+ func (c *Client) ServiceDisableContext(ctx context.Context, principal string) error

+ func (c *Client) ServiceDisallowCreateKeytab(principal string, a KeytabAccess) (*Service, error)

+ func (c *Client) ServiceDisallowCreateKeytabContext(ctx context.Context, principal string, a KeytabAccess) (*Service, error)

+ func (c *Client) ServiceDisallowRetrieveKeytab(principal string, a KeytabAccess) (*Service, error)

+ func (c *Client) ServiceDisallowRetrieveKeytabContext(ctx context.Context, principal string, a KeytabAccess) (*Service, error)

+ func (c *Client) ServiceFind(options Options) ([]*Service, error)

+ func (c *Client) ServiceFindContext(ctx context.Context, options Options) ([]*Service, error)

+ func (c *Client) ServiceRemoveHost(principal string, hosts []string) (*Service, error)

+ func (c *Client) ServiceRemoveHostContext(ctx context.Context, principal string, hosts []string) (*Service, error)

+ func (c *Client) ServiceShow(principal string) (*Service, error)

+ func (c *Client) ServiceShowContext(ctx context.Context, principal string) (*Service, error)

+ func (c *Client) SudoRuleAdd(r *SudoRule) (*SudoRule, error)

+ func (c *Client) SudoRuleAddAllowCommand(name string, cmds, cmdgroups []string) (*SudoRule, error)

+ func (c *Client) SudoRuleAddAllowCommandContext(ctx context.Context, name string, cmds, cmdgroups []string) (*SudoRule, error)

+ func (c *Client) SudoRuleAddContext(ctx context.Context, r *SudoRule) (*SudoRule, error)

+ func (c *Client) SudoRuleAddDenyCommand(name string, cmds, cmdgroups []string) (*SudoRule, error)

+ func (c *Client) SudoRuleAddDenyCommandContext(ctx context.Context, name string, cmds, cmdgroups []string) (*SudoRule, error)

+ func (c *Client) SudoRuleAddHost(name string, hosts, hostgroups []string) (*SudoRule, error)

+ func (c *Client) SudoRuleAddHostContext(ctx context.Context, name string, hosts, hostgroups []string) (*SudoRule, error)

+ func (c *Client) SudoRuleAddOption(name string, options ...string) (*SudoRule, error)

+ func (c *Client) SudoRuleAddOptionContext(ctx context.Context, name string, options ...string) (*SudoRule, error)

+ func (c *Client) SudoRuleAddRunAsGroup(name string, groups []string) (*SudoRule, error)

+ func (c *Client) SudoRuleAddRunAsGroupContext(ctx context.Context, name string, groups []string) (*SudoRule, error)

+ func (c *Client) SudoRuleAddRunAsUser(name string, users, groups []string) (*SudoRule, error)

+ func (c *Client) SudoRuleAddRunAsUserContext(ctx context.Context, name string, users, groups []string) (*SudoRule, error)

+ func (c *Client) SudoRuleAddUser(name string, users, groups []string) (*SudoRule, error)

+ func (c *Client) SudoRuleAddUserContext(ctx context.Context, name string, users, groups []string) (*SudoRule, error)

+ func (c *Client) SudoRuleDelete(names ...string) error

+ func (c *Client) SudoRuleDeleteContext(ctx context.Context, names ...string) error

+ func (c *Client) SudoRuleDisable(name string) error

+ func (c *Client) SudoRuleDisableContext(ctx context.Context, name string) error

+ func (c *Client) SudoRuleEnable(name string) error

+ func (c *Client) SudoRuleEnableContext(ctx context.Context, name string) error

+ func (c *Client) SudoRuleRemoveAllowCommand(name string, cmds, cmdgroups []string) (*SudoRule, error)

+ func (c *Client) SudoRuleRemoveAllowCommandContext(ctx context.Context, name string, cmds, cmdgroups []string) (*SudoRule, error)

+ func (c *Client) SudoRuleRemoveDenyCommand(name string, cmds, cmdgroups []string) (*SudoRule, error)

+ func (c *Client) SudoRuleRemoveDenyCommandContext(ctx context.Context, name string, cmds, cmdgroups []string) (*SudoRule, error)

+ func (c *Client) SudoRuleRemoveHost(name string, hosts, hostgroups []string) (*SudoRule, error)

+ func (c *Client) SudoRuleRemoveHostContext(ctx context.Context, name string, hosts, hostgroups []string) (*SudoRule, error)

+ func (c *Client) SudoRuleRemoveOption(name string, options ...string) (*SudoRule, error)

+ func (c *Client) SudoRuleRemoveOptionContext(ctx context.Context, name string, options ...string) (*SudoRule, error)

+ func (c *Client) SudoRuleRemoveRunAsGroup(name string, groups []string) (*SudoRule, error)

+ func (c *Client) SudoRuleRemoveRunAsGroupContext(ctx context.Context, name string, groups []string) (*SudoRule, error)

+ func (c *Client) SudoRuleRemoveRunAsUser(name string, users, groups []string) (*SudoRule, error)

+ func (c *Client) SudoRuleRemoveRunAsUserContext(ctx context.Context, name string, users, groups []string) (*SudoRule, error)

+ func (c *Client) SudoRuleRemoveUser(name string, users, groups []string) (*SudoRule, error)

+ func (c *Client) SudoRuleRemoveUserContext(ctx context.Context, name string, users, groups []string) (*SudoRule, error)

+ func (c *Client) SudoRuleShow(name string) (*SudoRule, error)

+ func (c *Client) SudoRuleShowContext(ctx context.Context, name string) (*SudoRule, error)

+ type DNSRecord struct

+ Name string

+ Records map[string][]string

+ type DNSZone struct

+ Active bool

+ AdminEmail string

+ DynamicUpdate bool

+ Expire int64

+ Minimum int64

+ Name string

+ NameServer string

+ Refresh int64

+ Retry int64

+ Serial int64

+ TTL int64

+ type HostGroup struct

+ Description string

+ HostGroups []string

+ Hosts []string

+ IndirectHostGroups []string

+ IndirectHosts []string

+ ManagerGroups []string

+ ManagerUsers []string

+ MemberOf []string

+ Name string

+ type KeytabAccess struct

+ Groups []string

+ HostGroups []string

+ Hosts []string

+ Users []string

+ type Permission struct

+ Attrs []string

+ BindType string

+ Filters []string

+ Location string

+ Name string

+ Privileges []string

+ Rights []string

+ TargetGroup string

+ Type string

+ type Privilege struct

+ Description string

+ Name string

+ Permissions []string

+ Roles []string

+ type Role struct

+ Description string

+ Groups []string

+ HostGroups []string

+ Hosts []string

+ Name string

+ Privileges []string

+ Services []string

+ Users []string

+ type Service struct

+ Aliases []string

+ AuthIndicators []string

+ Certificates [][]byte

+ HasKeytab bool

+ KeytabCreate KeytabAccess

+ KeytabRetrieve KeytabAccess

+ ManagedBy []string

+ OKAsDelegate bool

+ OKToAuthAsDelegate bool

+ Principal string

+ RequiresPreAuth bool

type SudoRule

+ RunAsUserGroups []string

v0.8.0

Oct 24, 2026

Changes in this version

+ var ErrInvalidCall = errors.New("ipa: call does not match the FreeIPA command catalogue")

+ type Command struct

+ Args []Param

+ Name string

+ Options []Param

+ Since string

+ func Commands(version string) []Command

+ func LookupCommand(name, version string) (Command, bool)

type Option

+ func WithValidation() Option

+ type Param struct

+ Multi bool

+ Name string

+ Required bool

+ Since string

+ Type string

v0.7.0

Oct 24, 2026

Changes in this version

+ const CodeConversion

+ const CodeObjectclassViolation

+ const CodeOnlyOneValueAllowed

+ var ErrNotSupported = errors.New("ipa: not supported by this FreeIPA server")

+ var ErrTruncated = errors.New("ipa: search truncated; raise sizelimit or narrow the search")

+ type BatchCall struct

+ Args []string

+ Method string

+ Options Options

+ type BatchResult struct

+ Err error

+ Result *Result

type Client

+ func (c *Client) Batch(ctx context.Context, calls ...BatchCall) ([]BatchResult, error)

+ func (c *Client) Modify(command string, keys ...string) *Modification

+ func (c *Client) ServerVersion() string

+ type Entry struct

+ func FindEntries(ctx context.Context, c *Client, method string, args []string, opts Options, ...) ([]Entry, error)

+ func (e *Entry) UnmarshalJSON(b []byte) error

+ func (e Entry) Bool(attr string) bool

+ func (e Entry) Bytes(attr string) []byte

+ func (e Entry) DN(attr string) string

+ func (e Entry) Has(attr string) bool

+ func (e Entry) Int(attr string) (int64, bool)

+ func (e Entry) MarshalJSON() ([]byte, error)

+ func (e Entry) Raw() json.RawMessage

+ func (e Entry) Str(attr string) string

+ func (e Entry) Strs(attr string) []string

+ func (e Entry) Time(attr string) time.Time

+ type Modification struct

+ func (m *Modification) Add(attr, value string) *Modification

+ func (m *Modification) Del(attr, value string) *Modification

+ func (m *Modification) Run(ctx context.Context) (*Response, error)

+ func (m *Modification) Set(attr, value string) *Modification

type Result

+ func Call[T any](ctx context.Context, c *Client, method string, args []string, opts Options) (T, *Result, error)

v0.6.0

Oct 24, 2026

Changes in this version

type Client

+ func New(opts ...Option) (*Client, error)

+ func (c *Client) LoginFromCCacheData(ccache []byte) error

+ func (c *Client) LoginWithKeytabData(ktab []byte, username string) error

+ func (c *Client) WhoAmI() (*Identity, error)

+ func (c *Client) WhoAmIContext(ctx context.Context) (*Identity, error)

+ type Identity struct

+ Arguments []string

+ Command string

+ Object string

+ type Option func(*settings) error

+ func WithCACert(pem []byte) Option

+ func WithHTTPClient(hc *http.Client) Option

+ func WithHost(host string) Option

+ func WithKrb5Config(path string) Option

+ func WithKrb5ConfigData(data []byte) Option

+ func WithPasswordRelogin() Option

+ func WithRealm(realm string) Option

v0.5.0

Oct 24, 2026

Changes in this version

+ const CodeOption

+ var ErrInvalidCredentials = errors.New("invalid user, password or OTP codes")

type Client

+ func (c *Client) HBACRuleFind(options Options) ([]*HBACRule, error)

+ func (c *Client) HBACRuleFindContext(ctx context.Context, options Options) ([]*HBACRule, error)

+ func (c *Client) HBACTest(user, host, service string, rules ...string) (*HBACTestResult, error)

+ func (c *Client) HBACTestContext(ctx context.Context, user, host, service string, rules ...string) (*HBACTestResult, error)

+ func (c *Client) PwPolicyShow(group string) (*PwPolicy, error)

+ func (c *Client) PwPolicyShowContext(ctx context.Context, group string) (*PwPolicy, error)

+ func (c *Client) StageUserActivate(username string) (*User, error)

+ func (c *Client) StageUserActivateContext(ctx context.Context, username string) (*User, error)

+ func (c *Client) StageUserAdd(user *User) (*User, error)

+ func (c *Client) StageUserAddContext(ctx context.Context, user *User) (*User, error)

+ func (c *Client) StageUserDelete(usernames ...string) error

+ func (c *Client) StageUserDeleteContext(ctx context.Context, usernames ...string) error

+ func (c *Client) StageUserFind(options Options) ([]*User, error)

+ func (c *Client) StageUserFindContext(ctx context.Context, options Options) ([]*User, error)

+ func (c *Client) StageUserMod(user *User) (*User, error)

+ func (c *Client) StageUserModContext(ctx context.Context, user *User) (*User, error)

+ func (c *Client) StageUserShow(username string) (*User, error)

+ func (c *Client) StageUserShowContext(ctx context.Context, username string) (*User, error)

+ func (c *Client) SubIDFind(options Options) ([]*SubID, error)

+ func (c *Client) SubIDFindContext(ctx context.Context, options Options) ([]*SubID, error)

+ func (c *Client) SubIDGenerate(owner string) (*SubID, error)

+ func (c *Client) SubIDGenerateContext(ctx context.Context, owner string) (*SubID, error)

+ func (c *Client) SudoRuleFind(options Options) ([]*SudoRule, error)

+ func (c *Client) SudoRuleFindContext(ctx context.Context, options Options) ([]*SudoRule, error)

+ func (c *Client) SyncOTPToken(username, password, firstCode, secondCode, tokenID string) error

+ func (c *Client) SyncOTPTokenContext(ctx context.Context, username, password, firstCode, secondCode, tokenID string) error

+ func (c *Client) UserAddPasskey(username, mapping string) error

+ func (c *Client) UserAddPasskeyContext(ctx context.Context, username, mapping string) error

+ func (c *Client) UserPwPolicy(username string) (*PwPolicy, error)

+ func (c *Client) UserPwPolicyContext(ctx context.Context, username string) (*PwPolicy, error)

+ func (c *Client) UserRemovePasskey(username, mapping string) error

+ func (c *Client) UserRemovePasskeyContext(ctx context.Context, username, mapping string) error

+ func (c *Client) UserStatus(username string) ([]*ReplicaStatus, error)

+ func (c *Client) UserStatusContext(ctx context.Context, username string) ([]*ReplicaStatus, error)

+ func (c *Client) UserUnlock(username string) error

+ func (c *Client) UserUnlockContext(ctx context.Context, username string) error

+ type HBACRule struct

+ Description string

+ Enabled bool

+ Groups []string

+ HostCategory string

+ HostGroups []string

+ Hosts []string

+ Name string

+ ServiceCategory string

+ ServiceGroups []string

+ Services []string

+ UserCategory string

+ Users []string

+ type HBACTestResult struct

+ Errors []string

+ Granted bool

+ Matched []string

+ NotMatched []string

+ Warnings []string

+ type PwPolicy struct

+ DictCheck bool

+ DigitCredit int

+ FailureInterval time.Duration

+ GraceLimit int

+ HistoryLength int

+ LockoutDuration time.Duration

+ LowerCredit int

+ MaxFailures int

+ MaxLife time.Duration

+ MaxRepeat int

+ MaxSequence int

+ MinClasses int

+ MinLength int

+ MinLife time.Duration

+ Name string

+ OtherCredit int

+ Priority int

+ UpperCredit int

+ UserCheck bool

+ type ReplicaStatus struct

+ Err string

+ FailedLogins int

+ LastFailure time.Time

+ LastSuccess time.Time

+ Now time.Time

+ Server string

+ type SubID struct

+ Description string

+ GIDCount int64

+ GIDStart int64

+ ID string

+ Owner string

+ UIDCount int64

+ UIDStart int64

+ type SudoRule struct

+ AllowCommandGroups []string

+ AllowCommands []string

+ CmdCategory string

+ DenyCommandGroups []string

+ DenyCommands []string

+ Description string

+ Enabled bool

+ Groups []string

+ HostCategory string

+ HostGroups []string

+ Hosts []string

+ Name string

+ Options []string

+ Order int

+ RunAsGroupCategory string

+ RunAsGroups []string

+ RunAsUserCategory string

+ RunAsUsers []string

+ UserCategory string

+ Users []string

v0.4.0

Oct 23, 2026

Changes in this version

type Client

+ func (c *Client) GroupAdd(group *Group) (*Group, error)

+ func (c *Client) GroupAddContext(ctx context.Context, group *Group) (*Group, error)

+ func (c *Client) GroupAddMember(group string, users, groups []string) (*Group, error)

+ func (c *Client) GroupAddMemberContext(ctx context.Context, group string, users, groups []string) (*Group, error)

+ func (c *Client) GroupAddMemberManager(group string, users, groups []string) (*Group, error)

+ func (c *Client) GroupAddMemberManagerContext(ctx context.Context, group string, users, groups []string) (*Group, error)

+ func (c *Client) GroupDelete(names ...string) error

+ func (c *Client) GroupDeleteContext(ctx context.Context, names ...string) error

+ func (c *Client) GroupFind(options Options) ([]*Group, error)

+ func (c *Client) GroupFindContext(ctx context.Context, options Options) ([]*Group, error)

+ func (c *Client) GroupMod(group *Group) (*Group, error)

+ func (c *Client) GroupModContext(ctx context.Context, group *Group) (*Group, error)

+ func (c *Client) GroupRemoveMember(group string, users, groups []string) (*Group, error)

+ func (c *Client) GroupRemoveMemberContext(ctx context.Context, group string, users, groups []string) (*Group, error)

+ func (c *Client) GroupRemoveMemberManager(group string, users, groups []string) (*Group, error)

+ func (c *Client) GroupRemoveMemberManagerContext(ctx context.Context, group string, users, groups []string) (*Group, error)

+ func (c *Client) GroupShow(name string) (*Group, error)

+ func (c *Client) GroupShowContext(ctx context.Context, name string) (*Group, error)

+ func (c *Client) HostFind(options Options) ([]*Host, error)

+ func (c *Client) HostFindContext(ctx context.Context, options Options) ([]*Host, error)

+ func (c *Client) HostShow(fqdn string) (*Host, error)

+ func (c *Client) HostShowContext(ctx context.Context, fqdn string) (*Host, error)

+ type Group struct

+ Description string

+ External bool

+ GID string

+ Groups []string

+ IndirectGroups []string

+ IndirectUsers []string

+ ManagerGroups []string

+ ManagerUsers []string

+ MemberOf []string

+ Name string

+ NonPOSIX bool

+ Users []string

+ type Host struct

+ Description string

+ FQDN string

+ HasKeytab bool

+ HasPassword bool

+ HostGroups []string

+ IndirectHostGroups []string

+ Locality string

+ Location string

+ MACAddresses []string

+ ManagedBy []string

+ OSVersion string

+ Platform string

+ Principal string

+ UserClass []string

+ type MemberError struct

+ Failures []MemberFailure

+ func (e *MemberError) Error() string

+ type MemberFailure struct

+ Kind string

+ Message string

+ Name string

+ Type string

type User

+ City string

+ Emails []string

+ IndirectGroups []string

+ OrgUnit string

+ Passkeys []string

+ PostalCode string

+ PreferredLanguage string

+ State string

+ Street string

+ Title string

v0.3.0

Oct 23, 2026

Changes in this version

type IpaError

+ func (e *IpaError) MarshalJSON() ([]byte, error)

v0.2.1

Oct 23, 2026

v0.2.0

Oct 23, 2026

Changes in this version

+ const CodeACI

+ const CodeAlreadyActive

+ const CodeAlreadyContainsValue

+ const CodeAlreadyGroupMember

+ const CodeAlreadyInactive

+ const CodeAttrValueNotFound

+ const CodeCommand

+ const CodeDatabase

+ const CodeDuplicateEntry

+ const CodeEmptyModlist

+ const CodeNotFound

+ const CodeNotGroupMember

+ const CodeReferer

+ const CodeRequirement

+ const CodeValidation

+ const CodeVersion

+ var ErrACI = &IpaError

+ var ErrDuplicateEntry = &IpaError

+ var ErrEmptyModlist = &IpaError

+ var ErrNotFound = &IpaError

type Client

+ func (c *Client) AddOTPTokenContext(ctx context.Context, token *OTPToken) (*OTPToken, error)

+ func (c *Client) ChangePasswordContext(ctx context.Context, username, oldPasswd, newPasswd, otpcode string) error

+ func (c *Client) DisableOTPTokenContext(ctx context.Context, tokenUUID string) error

+ func (c *Client) EnableOTPTokenContext(ctx context.Context, tokenUUID string) error

+ func (c *Client) FetchOTPTokensContext(ctx context.Context, owner string) ([]*OTPToken, error)

+ func (c *Client) PingContext(ctx context.Context) (*Response, error)

+ func (c *Client) RPC(method string, args []string, options Options) (*Response, error)

+ func (c *Client) RPCContext(ctx context.Context, method string, args []string, options Options) (*Response, error)

+ func (c *Client) RemoteLoginContext(ctx context.Context, uid, passwd string) error

+ func (c *Client) RemoveOTPTokenContext(ctx context.Context, tokenUUID string) error

+ func (c *Client) ResetPasswordContext(ctx context.Context, username string) (string, error)

+ func (c *Client) SetAuthTypesContext(ctx context.Context, username string, types []string) error

+ func (c *Client) SetPasswordContext(ctx context.Context, username, oldPasswd, newPasswd, otpcode string) error

+ func (c *Client) SetSessionID(sessionID string)

+ func (c *Client) UserAddContext(ctx context.Context, user *User, random bool) (*User, error)

+ func (c *Client) UserAddWithPasswordContext(ctx context.Context, user *User, password string) (*User, error)

+ func (c *Client) UserDeleteContext(ctx context.Context, preserve, stopOnError bool, usernames ...string) error

+ func (c *Client) UserDisableContext(ctx context.Context, username string) error

+ func (c *Client) UserEnableContext(ctx context.Context, username string) error

+ func (c *Client) UserFindContext(ctx context.Context, options Options) ([]*User, error)

+ func (c *Client) UserModContext(ctx context.Context, user *User) (*User, error)

+ func (c *Client) UserShowContext(ctx context.Context, username string) (*User, error)

+ type HTTPError struct

+ Status string

+ StatusCode int

+ func (e *HTTPError) Error() string

+ func (e *HTTPError) Is(target error) bool

type IpaError

+ Data string

+ Name string

+ func (e *IpaError) Is(target error) bool

+ func (e *IpaError) UnmarshalJSON(b []byte) error

+ type Message struct

+ Code int

+ Data json.RawMessage

+ Message string

+ Name string

+ Type string

type Result

+ Completed int

+ Count int

+ Failed json.RawMessage

+ Messages []Message

+ Raw json.RawMessage

+ Truncated bool

+ func (r *Result) UnmarshalJSON(b []byte) error

v0.1.0

Oct 22, 2026

Changes in this version

+ const AlgorithmSHA1

+ const AlgorithmSHA256

+ const AlgorithmSHA384

+ const AlgorithmSHA512

+ const DefaultKerbConf

+ const IpaClientVersion

+ const IpaDatetimeFormat

+ const TokenTypeHOTP

+ const TokenTypeTOTP

+ var ErrExpiredPassword = errors.New("password expired")

+ var ErrInvalidPassword = errors.New("invalid current password")

+ var ErrPasswordPolicy = errors.New("password does not conform to policy")

+ var ErrUnauthorized = errors.New("unauthorized")

+ var ErrUserExists = errors.New("user exists")

+ func ParseDateTime(str string) time.Time

+ type Client struct

+ func NewClient(host, realm string) *Client

+ func NewClientCustomHttp(host, realm string, httpClient *http.Client) *Client

+ func NewDefaultClient() *Client

+ func NewDefaultClientWithSession(sessionID string) *Client

+ func (c *Client) AddOTPToken(token *OTPToken) (*OTPToken, error)

+ func (c *Client) ChangePassword(username, old_passwd, new_passwd, otpcode string) error

+ func (c *Client) ClearSession()

+ func (c *Client) DisableOTPToken(tokenUUID string) error

+ func (c *Client) EnableOTPToken(tokenUUID string) error

+ func (c *Client) FetchOTPTokens(owner string) ([]*OTPToken, error)

+ func (c *Client) Host() string

+ func (c *Client) Login(username, password string) error

+ func (c *Client) LoginFromCCache(cpath string) error

+ func (c *Client) LoginWithKeytab(ktab, username string) error

+ func (c *Client) Ping() (*Response, error)

+ func (c *Client) Realm() string

+ func (c *Client) RemoteLogin(uid, passwd string) error

+ func (c *Client) RemoveOTPToken(tokenUUID string) error

+ func (c *Client) ResetPassword(username string) (string, error)

+ func (c *Client) SessionID() string

+ func (c *Client) SetAuthTypes(username string, types []string) error

+ func (c *Client) SetPassword(username, old_passwd, new_passwd, otpcode string) error

+ func (c *Client) StickySession(enable bool)

+ func (c *Client) UserAdd(user *User, random bool) (*User, error)

+ func (c *Client) UserAddWithPassword(user *User, password string) (*User, error)

+ func (c *Client) UserDelete(preserve, stopOnError bool, usernames ...string) error

+ func (c *Client) UserDisable(username string) error

+ func (c *Client) UserEnable(username string) error

+ func (c *Client) UserFind(options Options) ([]*User, error)

+ func (c *Client) UserMod(user *User) (*User, error)

+ func (c *Client) UserShow(username string) (*User, error)

+ type IpaError struct

+ Code int

+ Message string

+ func (e *IpaError) Error() string

+ type OTPToken struct

+ Algorithm string

+ ClockOffest int

+ DN string

+ Description string

+ Digits int

+ Enabled bool

+ ManagedBy string

+ Model string

+ NotAfter time.Time

+ NotBefore time.Time

+ Owner string

+ Serial string

+ TimeStep int

+ Type string

+ URI string

+ UUID string

+ Vendor string

+ var DefaultTOTPToken *OTPToken = &OTPToken{ ... }

+ func (t *OTPToken) DisplayName() string

+ type Options map[string]interface

+ type Response struct

+ Error *IpaError

+ ID int

+ Principal string

+ Result *Result

+ Version string

+ type Result struct

+ Data json.RawMessage

+ Summary string

+ Value interface{}

+ type SSHAuthorizedKey struct

+ Comment string

+ Fingerprint string

+ Options []string

+ PublicKey ssh.PublicKey

+ func NewSSHAuthorizedKey(in string) (*SSHAuthorizedKey, error)

+ func (k *SSHAuthorizedKey) MarshalJSON() ([]byte, error)

+ func (k *SSHAuthorizedKey) String() string

+ type User struct

+ AuthTypes []string

+ Category string

+ DN string

+ DisplayName string

+ Email string

+ First string

+ Gid string

+ Groups []string

+ HasKeytab bool

+ HasPassword bool

+ HbacRules []string

+ HomeDir string

+ Last string

+ LastLoginFail time.Time

+ LastLoginSuccess time.Time

+ LastPasswdChange time.Time

+ Locked bool

+ Mobile string

+ PasswdExpire time.Time

+ Preserved bool

+ Principal string

+ PrincipalExpire time.Time

+ RandomPassword string

+ SSHAuthKeys []*SSHAuthorizedKey

+ Shell string

+ SudoRules []string

+ TelephoneNumber string

+ UUID string

+ Uid string

+ Username string

+ func (u *User) AddSSHAuthorizedKey(key *SSHAuthorizedKey)

+ func (u *User) FormatSSHAuthorizedKeys() []string

+ func (u *User) HasGroup(group string) bool

+ func (u *User) OTPOnly() bool

+ func (u *User) RemoveSSHAuthorizedKey(fingerprint string)

+ func (u *User) ToOptions() Options

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL