directory

package
v0.1.28 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 26, 2026 License: Apache-2.0 Imports: 3 Imported by: 0

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 AccountVerifier added in v0.1.28

type AccountVerifier interface {
	VerifyAccounts(ctx context.Context, req diragentapi.DirAgentVerifyAccountsRequest) (*diragentapi.DirAgentVerifyAccountsResponse, error)
}

AccountVerifier is implemented by providers that can report whether accounts the server already holds still exist and are still eligible.

type CodedError

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 that 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. With DryRun, the provider performs
	// only the non-mutating validation it supports.
	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 dirauthentik implements an Authentik directory provider.
Package dirauthentik implements an Authentik directory provider.
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.

Jump to

Keyboard shortcuts

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