Documentation
¶
Overview ¶
Package dirauthentik implements an Authentik directory provider.
Index ¶
- type Provider
- func (p *Provider) Configure(ctx context.Context, req diragentapi.DirAgentConfigureRequest) (*diragentapi.DirAgentConfigureResponse, error)
- func (p *Provider) GetAccount(ctx context.Context, req diragentapi.DirAgentGetAccountRequest) (*diragentapi.DirAgentGetAccountResponse, error)
- func (p *Provider) ListAccounts(ctx context.Context, req diragentapi.DirAgentListAccountsRequest) (*diragentapi.DirAgentListAccountsResponse, error)
- func (p *Provider) ListGroups(ctx context.Context, req diragentapi.DirAgentListGroupsRequest) (*diragentapi.DirAgentListGroupsResponse, error)
- func (p *Provider) PerformOperation(ctx context.Context, req diragentapi.DirAgentPerformOperationRequest) (*diragentapi.DirAgentPerformOperationResponse, error)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Provider ¶
type Provider struct {
URL string
Token string
HTTPClient *http.Client
Path string
GroupsByName []string
Types []string
NameAttribute string
BirthDateAttribute string
MFAResetFlowUUID string
}
Provider represents the configuration details required to connect to Authentik.
func (*Provider) Configure ¶
func (p *Provider) Configure(ctx context.Context, req diragentapi.DirAgentConfigureRequest) (*diragentapi.DirAgentConfigureResponse, error)
Configure returns static information about the integration.
func (*Provider) GetAccount ¶
func (p *Provider) GetAccount(ctx context.Context, req diragentapi.DirAgentGetAccountRequest) (*diragentapi.DirAgentGetAccountResponse, error)
GetAccount fetches accounts given one of its external IDs.
Because multiple accounts could match an external ID, it is possible than multiple accounts could be returned. The caller must handle this case, which is probably an error.
func (*Provider) ListAccounts ¶
func (p *Provider) ListAccounts(ctx context.Context, req diragentapi.DirAgentListAccountsRequest) (*diragentapi.DirAgentListAccountsResponse, error)
ListAccounts returns a partial list of accounts. Callers should use Cursor to page through multiple pages of results.
func (*Provider) ListGroups ¶
func (p *Provider) ListGroups(ctx context.Context, req diragentapi.DirAgentListGroupsRequest) (*diragentapi.DirAgentListGroupsResponse, error)
ListGroups returns the directory groups that match the given name prefix.
func (*Provider) PerformOperation ¶
func (p *Provider) PerformOperation(ctx context.Context, req diragentapi.DirAgentPerformOperationRequest) (*diragentapi.DirAgentPerformOperationResponse, error)
PerformOperation performs the specified recovery operation.
Source Files