Documentation
¶
Overview ¶
Package directory contains type definitions for directory providers.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type CodedError ¶
type CodedError diragentapi.DirAgentErrorResponse
CodedError is an alias for diragentapi.DirAgentErrorResponse that implements the error interface so it can be returned from Provider methods. When this error is returned, the diragentapi.DirAgentResponse will have the corresponding Error field set.
func (CodedError) Error ¶
func (c CodedError) Error() string
type Provider ¶
type Provider interface {
// Configure returns static information about the integration
Configure(ctx context.Context, req diragentapi.DirAgentConfigureRequest) (*diragentapi.DirAgentConfigureResponse, error)
// ListAccounts returns a partial list of accounts. Callers should use Cursor to page
// through multiple pages of results.
ListAccounts(ctx context.Context, req diragentapi.DirAgentListAccountsRequest) (*diragentapi.DirAgentListAccountsResponse, 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.
GetAccount(ctx context.Context, req diragentapi.DirAgentGetAccountRequest) (*diragentapi.DirAgentGetAccountResponse, error)
// ListGroups returns the directory groups that match the given name prefix.
ListGroups(ctx context.Context, req diragentapi.DirAgentListGroupsRequest) (*diragentapi.DirAgentListGroupsResponse, error)
// PerformOperation executes a recovery operation, unless DryRun is specified, in which case it
// checked the preconditions for the operation.
PerformOperation(ctx context.Context, req diragentapi.DirAgentPerformOperationRequest) (*diragentapi.DirAgentPerformOperationResponse, error)
}
Provider is an interface that represents a directory provider (e.g. Azure AD, Okta, etc.)
Directories
¶
| Path | Synopsis |
|---|---|
|
Package dirad implements an Active Directory agent
|
Package dirad implements an Active Directory agent |
|
adclient
Package adclient interacts with AD domain controllers
|
Package adclient interacts with AD domain controllers |
|
Package dirldap implements an LDAP agent
|
Package dirldap implements an LDAP agent |
|
Package dirokta impements an Okta directory provider.
|
Package dirokta impements an Okta directory provider. |
Click to show internal directories.
Click to hide internal directories.