Documentation ¶
Index ¶
- Constants
- func GeneratePassword(passwordLength, minSpecialChar, minNum, minUpperCase int) string
- type AppMetadata
- type Auth0ClientConfig
- type Auth0Credentials
- type Auth0Manager
- func (am *Auth0Manager) CreateUser(email, name, accountID, invitedByEmail string) (*UserData, error)
- func (am *Auth0Manager) DeleteUser(userID string) error
- func (am *Auth0Manager) GetAccount(accountID string) ([]*UserData, error)
- func (am *Auth0Manager) GetAllAccounts() (map[string][]*UserData, error)
- func (am *Auth0Manager) GetUserByEmail(email string) ([]*UserData, error)
- func (am *Auth0Manager) GetUserDataByID(userID string, appMetadata AppMetadata) (*UserData, error)
- func (am *Auth0Manager) InviteUserByID(userID string) error
- func (am *Auth0Manager) UpdateUserAppMetadata(userID string, appMetadata AppMetadata) error
- type AuthentikClientConfig
- type AuthentikCredentials
- type AuthentikManager
- func (am *AuthentikManager) CreateUser(_, _, _, _ string) (*UserData, error)
- func (am *AuthentikManager) DeleteUser(userID string) error
- func (am *AuthentikManager) GetAccount(accountID string) ([]*UserData, error)
- func (am *AuthentikManager) GetAllAccounts() (map[string][]*UserData, error)
- func (am *AuthentikManager) GetUserByEmail(email string) ([]*UserData, error)
- func (am *AuthentikManager) GetUserDataByID(userID string, appMetadata AppMetadata) (*UserData, error)
- func (am *AuthentikManager) InviteUserByID(_ string) error
- func (am *AuthentikManager) UpdateUserAppMetadata(_ string, _ AppMetadata) error
- type AzureClientConfig
- type AzureCredentials
- type AzureManager
- func (am *AzureManager) CreateUser(_, _, _, _ string) (*UserData, error)
- func (am *AzureManager) DeleteUser(userID string) error
- func (am *AzureManager) GetAccount(accountID string) ([]*UserData, error)
- func (am *AzureManager) GetAllAccounts() (map[string][]*UserData, error)
- func (am *AzureManager) GetUserByEmail(email string) ([]*UserData, error)
- func (am *AzureManager) GetUserDataByID(userID string, appMetadata AppMetadata) (*UserData, error)
- func (am *AzureManager) InviteUserByID(_ string) error
- func (am *AzureManager) UpdateUserAppMetadata(_ string, _ AppMetadata) error
- type ClientConfig
- type Config
- type ExtraConfig
- type GoogleWorkspaceClientConfig
- type GoogleWorkspaceCredentials
- type GoogleWorkspaceManager
- func (gm *GoogleWorkspaceManager) CreateUser(_, _, _, _ string) (*UserData, error)
- func (gm *GoogleWorkspaceManager) DeleteUser(userID string) error
- func (gm *GoogleWorkspaceManager) GetAccount(accountID string) ([]*UserData, error)
- func (gm *GoogleWorkspaceManager) GetAllAccounts() (map[string][]*UserData, error)
- func (gm *GoogleWorkspaceManager) GetUserByEmail(email string) ([]*UserData, error)
- func (gm *GoogleWorkspaceManager) GetUserDataByID(userID string, appMetadata AppMetadata) (*UserData, error)
- func (gm *GoogleWorkspaceManager) InviteUserByID(_ string) error
- func (gm *GoogleWorkspaceManager) UpdateUserAppMetadata(_ string, _ AppMetadata) error
- type JWTToken
- type JsonParser
- type JumpCloudClientConfig
- type JumpCloudCredentials
- type JumpCloudManager
- func (jm *JumpCloudManager) CreateUser(_, _, _, _ string) (*UserData, error)
- func (jm *JumpCloudManager) DeleteUser(userID string) error
- func (jm *JumpCloudManager) GetAccount(accountID string) ([]*UserData, error)
- func (jm *JumpCloudManager) GetAllAccounts() (map[string][]*UserData, error)
- func (jm *JumpCloudManager) GetUserByEmail(email string) ([]*UserData, error)
- func (jm *JumpCloudManager) GetUserDataByID(userID string, appMetadata AppMetadata) (*UserData, error)
- func (jm *JumpCloudManager) InviteUserByID(_ string) error
- func (jm *JumpCloudManager) UpdateUserAppMetadata(_ string, _ AppMetadata) error
- type KeycloakClientConfig
- type KeycloakCredentials
- type KeycloakManager
- func (km *KeycloakManager) CreateUser(_, _, _, _ string) (*UserData, error)
- func (km *KeycloakManager) DeleteUser(userID string) error
- func (km *KeycloakManager) GetAccount(accountID string) ([]*UserData, error)
- func (km *KeycloakManager) GetAllAccounts() (map[string][]*UserData, error)
- func (km *KeycloakManager) GetUserByEmail(email string) ([]*UserData, error)
- func (km *KeycloakManager) GetUserDataByID(userID string, _ AppMetadata) (*UserData, error)
- func (km *KeycloakManager) InviteUserByID(_ string) error
- func (km *KeycloakManager) UpdateUserAppMetadata(_ string, _ AppMetadata) error
- type Manager
- type ManagerCredentials
- type ManagerHTTPClient
- type ManagerHelper
- type MockIDP
- func (m *MockIDP) CreateUser(email, name, accountID, invitedByEmail string) (*UserData, error)
- func (m *MockIDP) DeleteUser(userID string) error
- func (m *MockIDP) GetAccount(accountId string) ([]*UserData, error)
- func (m *MockIDP) GetAllAccounts() (map[string][]*UserData, error)
- func (m *MockIDP) GetUserByEmail(email string) ([]*UserData, error)
- func (m *MockIDP) GetUserDataByID(userId string, appMetadata AppMetadata) (*UserData, error)
- func (m *MockIDP) InviteUserByID(userID string) error
- func (m *MockIDP) UpdateUserAppMetadata(userId string, appMetadata AppMetadata) error
- type OktaClientConfig
- type OktaCredentials
- type OktaManager
- func (om *OktaManager) CreateUser(_, _, _, _ string) (*UserData, error)
- func (om *OktaManager) DeleteUser(userID string) error
- func (om *OktaManager) GetAccount(accountID string) ([]*UserData, error)
- func (om *OktaManager) GetAllAccounts() (map[string][]*UserData, error)
- func (om *OktaManager) GetUserByEmail(email string) ([]*UserData, error)
- func (om *OktaManager) GetUserDataByID(userID string, appMetadata AppMetadata) (*UserData, error)
- func (om *OktaManager) InviteUserByID(_ string) error
- func (om *OktaManager) UpdateUserAppMetadata(userID string, appMetadata AppMetadata) error
- type UserData
- type ZitadelClientConfig
- type ZitadelCredentials
- type ZitadelManager
- func (zm *ZitadelManager) CreateUser(_, _, _, _ string) (*UserData, error)
- func (zm *ZitadelManager) DeleteUser(userID string) error
- func (zm *ZitadelManager) GetAccount(accountID string) ([]*UserData, error)
- func (zm *ZitadelManager) GetAllAccounts() (map[string][]*UserData, error)
- func (zm *ZitadelManager) GetUserByEmail(email string) ([]*UserData, error)
- func (zm *ZitadelManager) GetUserDataByID(userID string, appMetadata AppMetadata) (*UserData, error)
- func (zm *ZitadelManager) InviteUserByID(_ string) error
- func (zm *ZitadelManager) UpdateUserAppMetadata(_ string, _ AppMetadata) error
Constants ¶
const (
// UnsetAccountID is a special key to map users without an account ID
UnsetAccountID = "unset"
)
Variables ¶
This section is empty.
Functions ¶
func GeneratePassword ¶ added in v0.9.8
GeneratePassword generates user password
Types ¶
type AppMetadata ¶
type AppMetadata struct { // WTAccountID is a NetBird (previously Wiretrustee) account id to update in the IDP // maps to wt_account_id when json.marshal WTAccountID string `json:"wt_account_id,omitempty"` WTPendingInvite *bool `json:"wt_pending_invite,omitempty"` WTInvitedBy string `json:"wt_invited_by_email,omitempty"` }
AppMetadata user app metadata to associate with a profile
type Auth0ClientConfig ¶
type Auth0ClientConfig struct { Audience string AuthIssuer string ClientID string ClientSecret string GrantType string }
Auth0ClientConfig auth0 manager client configurations
type Auth0Credentials ¶
type Auth0Credentials struct {
// contains filtered or unexported fields
}
Auth0Credentials auth0 authentication information
func (*Auth0Credentials) Authenticate ¶
func (c *Auth0Credentials) Authenticate() (JWTToken, error)
Authenticate retrieves access token to use the Auth0 Management API
type Auth0Manager ¶
type Auth0Manager struct {
// contains filtered or unexported fields
}
Auth0Manager auth0 manager client instance
func NewAuth0Manager ¶
func NewAuth0Manager(config Auth0ClientConfig, appMetrics telemetry.AppMetrics) (*Auth0Manager, error)
NewAuth0Manager creates a new instance of the Auth0Manager
func (*Auth0Manager) CreateUser ¶ added in v0.9.8
func (am *Auth0Manager) CreateUser(email, name, accountID, invitedByEmail string) (*UserData, error)
CreateUser creates a new user in Auth0 Idp and sends an invite
func (*Auth0Manager) DeleteUser ¶ added in v0.23.2
func (am *Auth0Manager) DeleteUser(userID string) error
DeleteUser from Auth0
func (*Auth0Manager) GetAccount ¶ added in v0.6.4
func (am *Auth0Manager) GetAccount(accountID string) ([]*UserData, error)
GetAccount returns all the users for a given profile. Calls Auth0 API.
func (*Auth0Manager) GetAllAccounts ¶ added in v0.6.4
func (am *Auth0Manager) GetAllAccounts() (map[string][]*UserData, error)
GetAllAccounts gets all registered accounts with corresponding user data. It returns a list of users indexed by accountID.
func (*Auth0Manager) GetUserByEmail ¶ added in v0.9.8
func (am *Auth0Manager) GetUserByEmail(email string) ([]*UserData, error)
GetUserByEmail searches users with a given email. If no users have been found, this function returns an empty list. This function can return multiple users. This is due to the Auth0 internals - there could be multiple users with the same email but different connections that are considered as separate accounts (e.g., Google and username/password).
func (*Auth0Manager) GetUserDataByID ¶
func (am *Auth0Manager) GetUserDataByID(userID string, appMetadata AppMetadata) (*UserData, error)
GetUserDataByID requests user data from auth0 via ID
func (*Auth0Manager) InviteUserByID ¶ added in v0.21.9
func (am *Auth0Manager) InviteUserByID(userID string) error
InviteUserByID resend invitations to users who haven't activated, their accounts prior to the expiration period.
func (*Auth0Manager) UpdateUserAppMetadata ¶
func (am *Auth0Manager) UpdateUserAppMetadata(userID string, appMetadata AppMetadata) error
UpdateUserAppMetadata updates user app metadata based on userId and metadata map
type AuthentikClientConfig ¶ added in v0.21.0
type AuthentikClientConfig struct { Issuer string ClientID string Username string Password string TokenEndpoint string GrantType string }
AuthentikClientConfig authentik manager client configurations.
type AuthentikCredentials ¶ added in v0.21.0
type AuthentikCredentials struct {
// contains filtered or unexported fields
}
AuthentikCredentials authentik authentication information.
func (*AuthentikCredentials) Authenticate ¶ added in v0.21.0
func (ac *AuthentikCredentials) Authenticate() (JWTToken, error)
Authenticate retrieves access token to use the authentik management API.
type AuthentikManager ¶ added in v0.21.0
type AuthentikManager struct {
// contains filtered or unexported fields
}
AuthentikManager authentik manager client instance.
func NewAuthentikManager ¶ added in v0.21.0
func NewAuthentikManager(config AuthentikClientConfig, appMetrics telemetry.AppMetrics) (*AuthentikManager, error)
NewAuthentikManager creates a new instance of the AuthentikManager.
func (*AuthentikManager) CreateUser ¶ added in v0.21.0
func (am *AuthentikManager) CreateUser(_, _, _, _ string) (*UserData, error)
CreateUser creates a new user in authentik Idp and sends an invitation.
func (*AuthentikManager) DeleteUser ¶ added in v0.23.2
func (am *AuthentikManager) DeleteUser(userID string) error
DeleteUser from Authentik
func (*AuthentikManager) GetAccount ¶ added in v0.21.0
func (am *AuthentikManager) GetAccount(accountID string) ([]*UserData, error)
GetAccount returns all the users for a given profile.
func (*AuthentikManager) GetAllAccounts ¶ added in v0.21.0
func (am *AuthentikManager) GetAllAccounts() (map[string][]*UserData, error)
GetAllAccounts gets all registered accounts with corresponding user data. It returns a list of users indexed by accountID.
func (*AuthentikManager) GetUserByEmail ¶ added in v0.21.0
func (am *AuthentikManager) GetUserByEmail(email string) ([]*UserData, error)
GetUserByEmail searches users with a given email. If no users have been found, this function returns an empty list.
func (*AuthentikManager) GetUserDataByID ¶ added in v0.21.0
func (am *AuthentikManager) GetUserDataByID(userID string, appMetadata AppMetadata) (*UserData, error)
GetUserDataByID requests user data from authentik via ID.
func (*AuthentikManager) InviteUserByID ¶ added in v0.21.9
func (am *AuthentikManager) InviteUserByID(_ string) error
InviteUserByID resend invitations to users who haven't activated, their accounts prior to the expiration period.
func (*AuthentikManager) UpdateUserAppMetadata ¶ added in v0.21.0
func (am *AuthentikManager) UpdateUserAppMetadata(_ string, _ AppMetadata) error
UpdateUserAppMetadata updates user app metadata based on userID and metadata map.
type AzureClientConfig ¶ added in v0.19.0
type AzureClientConfig struct { ClientID string ClientSecret string ObjectID string GraphAPIEndpoint string TokenEndpoint string GrantType string }
AzureClientConfig azure manager client configurations.
type AzureCredentials ¶ added in v0.19.0
type AzureCredentials struct {
// contains filtered or unexported fields
}
AzureCredentials azure authentication information.
func (*AzureCredentials) Authenticate ¶ added in v0.19.0
func (ac *AzureCredentials) Authenticate() (JWTToken, error)
Authenticate retrieves access token to use the azure Management API.
type AzureManager ¶ added in v0.19.0
type AzureManager struct { ClientID string ObjectID string GraphAPIEndpoint string // contains filtered or unexported fields }
AzureManager azure manager client instance.
func NewAzureManager ¶ added in v0.19.0
func NewAzureManager(config AzureClientConfig, appMetrics telemetry.AppMetrics) (*AzureManager, error)
NewAzureManager creates a new instance of the AzureManager.
func (*AzureManager) CreateUser ¶ added in v0.19.0
func (am *AzureManager) CreateUser(_, _, _, _ string) (*UserData, error)
CreateUser creates a new user in azure AD Idp.
func (*AzureManager) DeleteUser ¶ added in v0.23.2
func (am *AzureManager) DeleteUser(userID string) error
DeleteUser from Azure.
func (*AzureManager) GetAccount ¶ added in v0.19.0
func (am *AzureManager) GetAccount(accountID string) ([]*UserData, error)
GetAccount returns all the users for a given profile.
func (*AzureManager) GetAllAccounts ¶ added in v0.19.0
func (am *AzureManager) GetAllAccounts() (map[string][]*UserData, error)
GetAllAccounts gets all registered accounts with corresponding user data. It returns a list of users indexed by accountID.
func (*AzureManager) GetUserByEmail ¶ added in v0.19.0
func (am *AzureManager) GetUserByEmail(email string) ([]*UserData, error)
GetUserByEmail searches users with a given email. If no users have been found, this function returns an empty list.
func (*AzureManager) GetUserDataByID ¶ added in v0.19.0
func (am *AzureManager) GetUserDataByID(userID string, appMetadata AppMetadata) (*UserData, error)
GetUserDataByID requests user data from keycloak via ID.
func (*AzureManager) InviteUserByID ¶ added in v0.21.9
func (am *AzureManager) InviteUserByID(_ string) error
InviteUserByID resend invitations to users who haven't activated, their accounts prior to the expiration period.
func (*AzureManager) UpdateUserAppMetadata ¶ added in v0.19.0
func (am *AzureManager) UpdateUserAppMetadata(_ string, _ AppMetadata) error
UpdateUserAppMetadata updates user app metadata based on userID.
type ClientConfig ¶ added in v0.21.0
type ClientConfig struct { Issuer string TokenEndpoint string ClientID string ClientSecret string GrantType string }
ClientConfig defines common client configuration for all IdP manager
type Config ¶
type Config struct { ManagerType string ClientConfig *ClientConfig ExtraConfig ExtraConfig Auth0ClientCredentials *Auth0ClientConfig AzureClientCredentials *AzureClientConfig KeycloakClientCredentials *KeycloakClientConfig ZitadelClientCredentials *ZitadelClientConfig }
Config an idp configuration struct to be loaded from management server's config file
type ExtraConfig ¶ added in v0.21.0
ExtraConfig stores IdP specific config that are unique to individual IdPs
type GoogleWorkspaceClientConfig ¶ added in v0.21.5
GoogleWorkspaceClientConfig Google Workspace manager client configurations.
type GoogleWorkspaceCredentials ¶ added in v0.21.5
type GoogleWorkspaceCredentials struct {
// contains filtered or unexported fields
}
GoogleWorkspaceCredentials Google Workspace authentication information.
func (*GoogleWorkspaceCredentials) Authenticate ¶ added in v0.21.5
func (gc *GoogleWorkspaceCredentials) Authenticate() (JWTToken, error)
type GoogleWorkspaceManager ¶ added in v0.21.5
type GoogleWorkspaceManager struct { CustomerID string // contains filtered or unexported fields }
GoogleWorkspaceManager Google Workspace manager client instance.
func NewGoogleWorkspaceManager ¶ added in v0.21.5
func NewGoogleWorkspaceManager(config GoogleWorkspaceClientConfig, appMetrics telemetry.AppMetrics) (*GoogleWorkspaceManager, error)
NewGoogleWorkspaceManager creates a new instance of the GoogleWorkspaceManager.
func (*GoogleWorkspaceManager) CreateUser ¶ added in v0.21.5
func (gm *GoogleWorkspaceManager) CreateUser(_, _, _, _ string) (*UserData, error)
CreateUser creates a new user in Google Workspace and sends an invitation.
func (*GoogleWorkspaceManager) DeleteUser ¶ added in v0.23.2
func (gm *GoogleWorkspaceManager) DeleteUser(userID string) error
DeleteUser from GoogleWorkspace.
func (*GoogleWorkspaceManager) GetAccount ¶ added in v0.21.5
func (gm *GoogleWorkspaceManager) GetAccount(accountID string) ([]*UserData, error)
GetAccount returns all the users for a given profile.
func (*GoogleWorkspaceManager) GetAllAccounts ¶ added in v0.21.5
func (gm *GoogleWorkspaceManager) GetAllAccounts() (map[string][]*UserData, error)
GetAllAccounts gets all registered accounts with corresponding user data. It returns a list of users indexed by accountID.
func (*GoogleWorkspaceManager) GetUserByEmail ¶ added in v0.21.5
func (gm *GoogleWorkspaceManager) GetUserByEmail(email string) ([]*UserData, error)
GetUserByEmail searches users with a given email. If no users have been found, this function returns an empty list.
func (*GoogleWorkspaceManager) GetUserDataByID ¶ added in v0.21.5
func (gm *GoogleWorkspaceManager) GetUserDataByID(userID string, appMetadata AppMetadata) (*UserData, error)
GetUserDataByID requests user data from Google Workspace via ID.
func (*GoogleWorkspaceManager) InviteUserByID ¶ added in v0.21.9
func (gm *GoogleWorkspaceManager) InviteUserByID(_ string) error
InviteUserByID resend invitations to users who haven't activated, their accounts prior to the expiration period.
func (*GoogleWorkspaceManager) UpdateUserAppMetadata ¶ added in v0.21.5
func (gm *GoogleWorkspaceManager) UpdateUserAppMetadata(_ string, _ AppMetadata) error
UpdateUserAppMetadata updates user app metadata based on userID and metadata map.
type JWTToken ¶
type JWTToken struct { AccessToken string `json:"access_token"` ExpiresIn int `json:"expires_in"` Scope string `json:"scope"` TokenType string `json:"token_type"` // contains filtered or unexported fields }
JWTToken a JWT object that holds information of a token
type JsonParser ¶
type JsonParser struct{}
func (JsonParser) Marshal ¶
func (JsonParser) Marshal(v interface{}) ([]byte, error)
func (JsonParser) Unmarshal ¶
func (JsonParser) Unmarshal(data []byte, v interface{}) error
type JumpCloudClientConfig ¶ added in v0.23.7
type JumpCloudClientConfig struct {
APIToken string
}
JumpCloudClientConfig JumpCloud manager client configurations.
type JumpCloudCredentials ¶ added in v0.23.7
type JumpCloudCredentials struct {
// contains filtered or unexported fields
}
JumpCloudCredentials JumpCloud authentication information.
func (*JumpCloudCredentials) Authenticate ¶ added in v0.23.7
func (jc *JumpCloudCredentials) Authenticate() (JWTToken, error)
Authenticate retrieves access token to use the JumpCloud user API.
type JumpCloudManager ¶ added in v0.23.7
type JumpCloudManager struct {
// contains filtered or unexported fields
}
JumpCloudManager JumpCloud manager client instance.
func NewJumpCloudManager ¶ added in v0.23.7
func NewJumpCloudManager(config JumpCloudClientConfig, appMetrics telemetry.AppMetrics) (*JumpCloudManager, error)
NewJumpCloudManager creates a new instance of the JumpCloudManager.
func (*JumpCloudManager) CreateUser ¶ added in v0.23.7
func (jm *JumpCloudManager) CreateUser(_, _, _, _ string) (*UserData, error)
CreateUser creates a new user in JumpCloud Idp and sends an invitation.
func (*JumpCloudManager) DeleteUser ¶ added in v0.23.7
func (jm *JumpCloudManager) DeleteUser(userID string) error
DeleteUser from jumpCloud directory
func (*JumpCloudManager) GetAccount ¶ added in v0.23.7
func (jm *JumpCloudManager) GetAccount(accountID string) ([]*UserData, error)
GetAccount returns all the users for a given profile.
func (*JumpCloudManager) GetAllAccounts ¶ added in v0.23.7
func (jm *JumpCloudManager) GetAllAccounts() (map[string][]*UserData, error)
GetAllAccounts gets all registered accounts with corresponding user data. It returns a list of users indexed by accountID.
func (*JumpCloudManager) GetUserByEmail ¶ added in v0.23.7
func (jm *JumpCloudManager) GetUserByEmail(email string) ([]*UserData, error)
GetUserByEmail searches users with a given email. If no users have been found, this function returns an empty list.
func (*JumpCloudManager) GetUserDataByID ¶ added in v0.23.7
func (jm *JumpCloudManager) GetUserDataByID(userID string, appMetadata AppMetadata) (*UserData, error)
GetUserDataByID requests user data from JumpCloud via ID.
func (*JumpCloudManager) InviteUserByID ¶ added in v0.23.7
func (jm *JumpCloudManager) InviteUserByID(_ string) error
InviteUserByID resend invitations to users who haven't activated, their accounts prior to the expiration period.
func (*JumpCloudManager) UpdateUserAppMetadata ¶ added in v0.23.7
func (jm *JumpCloudManager) UpdateUserAppMetadata(_ string, _ AppMetadata) error
UpdateUserAppMetadata updates user app metadata based on userID and metadata map.
type KeycloakClientConfig ¶ added in v0.14.5
type KeycloakClientConfig struct { ClientID string ClientSecret string AdminEndpoint string TokenEndpoint string GrantType string }
KeycloakClientConfig keycloak manager client configurations.
type KeycloakCredentials ¶ added in v0.14.5
type KeycloakCredentials struct {
// contains filtered or unexported fields
}
KeycloakCredentials keycloak authentication information.
func (*KeycloakCredentials) Authenticate ¶ added in v0.14.5
func (kc *KeycloakCredentials) Authenticate() (JWTToken, error)
Authenticate retrieves access token to use the keycloak Management API.
type KeycloakManager ¶ added in v0.14.5
type KeycloakManager struct {
// contains filtered or unexported fields
}
KeycloakManager keycloak manager client instance.
func NewKeycloakManager ¶ added in v0.14.5
func NewKeycloakManager(config KeycloakClientConfig, appMetrics telemetry.AppMetrics) (*KeycloakManager, error)
NewKeycloakManager creates a new instance of the KeycloakManager.
func (*KeycloakManager) CreateUser ¶ added in v0.14.5
func (km *KeycloakManager) CreateUser(_, _, _, _ string) (*UserData, error)
CreateUser creates a new user in keycloak Idp and sends an invite.
func (*KeycloakManager) DeleteUser ¶ added in v0.23.2
func (km *KeycloakManager) DeleteUser(userID string) error
DeleteUser from Keycloak by user ID.
func (*KeycloakManager) GetAccount ¶ added in v0.14.5
func (km *KeycloakManager) GetAccount(accountID string) ([]*UserData, error)
GetAccount returns all the users for a given account profile.
func (*KeycloakManager) GetAllAccounts ¶ added in v0.14.5
func (km *KeycloakManager) GetAllAccounts() (map[string][]*UserData, error)
GetAllAccounts gets all registered accounts with corresponding user data. It returns a list of users indexed by accountID.
func (*KeycloakManager) GetUserByEmail ¶ added in v0.14.5
func (km *KeycloakManager) GetUserByEmail(email string) ([]*UserData, error)
GetUserByEmail searches users with a given email. If no users have been found, this function returns an empty list.
func (*KeycloakManager) GetUserDataByID ¶ added in v0.14.5
func (km *KeycloakManager) GetUserDataByID(userID string, _ AppMetadata) (*UserData, error)
GetUserDataByID requests user data from keycloak via ID.
func (*KeycloakManager) InviteUserByID ¶ added in v0.21.9
func (km *KeycloakManager) InviteUserByID(_ string) error
InviteUserByID resend invitations to users who haven't activated, their accounts prior to the expiration period.
func (*KeycloakManager) UpdateUserAppMetadata ¶ added in v0.14.5
func (km *KeycloakManager) UpdateUserAppMetadata(_ string, _ AppMetadata) error
UpdateUserAppMetadata updates user app metadata based on userID and metadata map.
type Manager ¶
type Manager interface { UpdateUserAppMetadata(userId string, appMetadata AppMetadata) error GetUserDataByID(userId string, appMetadata AppMetadata) (*UserData, error) GetAccount(accountId string) ([]*UserData, error) GetAllAccounts() (map[string][]*UserData, error) CreateUser(email, name, accountID, invitedByEmail string) (*UserData, error) GetUserByEmail(email string) ([]*UserData, error) InviteUserByID(userID string) error DeleteUser(userID string) error }
Manager idp manager interface
func NewManager ¶
func NewManager(config Config, appMetrics telemetry.AppMetrics) (Manager, error)
NewManager returns a new idp manager based on the configuration that it receives
type ManagerCredentials ¶
ManagerCredentials interface that authenticates using the credential of each type of idp
type ManagerHTTPClient ¶
ManagerHTTPClient http client interface for API calls
type ManagerHelper ¶
type ManagerHelper interface { Marshal(v interface{}) ([]byte, error) Unmarshal(data []byte, v interface{}) error }
ManagerHelper helper
type MockIDP ¶ added in v0.24.4
type MockIDP struct { UpdateUserAppMetadataFunc func(userId string, appMetadata AppMetadata) error GetUserDataByIDFunc func(userId string, appMetadata AppMetadata) (*UserData, error) GetAccountFunc func(accountId string) ([]*UserData, error) GetAllAccountsFunc func() (map[string][]*UserData, error) CreateUserFunc func(email, name, accountID, invitedByEmail string) (*UserData, error) GetUserByEmailFunc func(email string) ([]*UserData, error) InviteUserByIDFunc func(userID string) error DeleteUserFunc func(userID string) error }
MockIDP is a mock implementation of the IDP interface
func (*MockIDP) CreateUser ¶ added in v0.24.4
CreateUser is a mock implementation of the IDP interface CreateUser method
func (*MockIDP) DeleteUser ¶ added in v0.24.4
DeleteUser is a mock implementation of the IDP interface DeleteUser method
func (*MockIDP) GetAccount ¶ added in v0.24.4
GetAccount is a mock implementation of the IDP interface GetAccount method
func (*MockIDP) GetAllAccounts ¶ added in v0.24.4
GetAllAccounts is a mock implementation of the IDP interface GetAllAccounts method
func (*MockIDP) GetUserByEmail ¶ added in v0.24.4
GetUserByEmail is a mock implementation of the IDP interface GetUserByEmail method
func (*MockIDP) GetUserDataByID ¶ added in v0.24.4
func (m *MockIDP) GetUserDataByID(userId string, appMetadata AppMetadata) (*UserData, error)
GetUserDataByID is a mock implementation of the IDP interface GetUserDataByID method
func (*MockIDP) InviteUserByID ¶ added in v0.24.4
InviteUserByID is a mock implementation of the IDP interface InviteUserByID method
func (*MockIDP) UpdateUserAppMetadata ¶ added in v0.24.4
func (m *MockIDP) UpdateUserAppMetadata(userId string, appMetadata AppMetadata) error
UpdateUserAppMetadata is a mock implementation of the IDP interface UpdateUserAppMetadata method
type OktaClientConfig ¶ added in v0.21.0
type OktaClientConfig struct { APIToken string Issuer string TokenEndpoint string GrantType string }
OktaClientConfig okta manager client configurations.
type OktaCredentials ¶ added in v0.21.0
type OktaCredentials struct {
// contains filtered or unexported fields
}
OktaCredentials okta authentication information.
func (*OktaCredentials) Authenticate ¶ added in v0.21.0
func (oc *OktaCredentials) Authenticate() (JWTToken, error)
Authenticate retrieves access token to use the okta user API.
type OktaManager ¶ added in v0.21.0
type OktaManager struct {
// contains filtered or unexported fields
}
OktaManager okta manager client instance.
func NewOktaManager ¶ added in v0.21.0
func NewOktaManager(config OktaClientConfig, appMetrics telemetry.AppMetrics) (*OktaManager, error)
NewOktaManager creates a new instance of the OktaManager.
func (*OktaManager) CreateUser ¶ added in v0.21.0
func (om *OktaManager) CreateUser(_, _, _, _ string) (*UserData, error)
CreateUser creates a new user in okta Idp and sends an invitation.
func (*OktaManager) DeleteUser ¶ added in v0.23.2
func (om *OktaManager) DeleteUser(userID string) error
DeleteUser from Okta
func (*OktaManager) GetAccount ¶ added in v0.21.0
func (om *OktaManager) GetAccount(accountID string) ([]*UserData, error)
GetAccount returns all the users for a given profile.
func (*OktaManager) GetAllAccounts ¶ added in v0.21.0
func (om *OktaManager) GetAllAccounts() (map[string][]*UserData, error)
GetAllAccounts gets all registered accounts with corresponding user data. It returns a list of users indexed by accountID.
func (*OktaManager) GetUserByEmail ¶ added in v0.21.0
func (om *OktaManager) GetUserByEmail(email string) ([]*UserData, error)
GetUserByEmail searches users with a given email. If no users have been found, this function returns an empty list.
func (*OktaManager) GetUserDataByID ¶ added in v0.21.0
func (om *OktaManager) GetUserDataByID(userID string, appMetadata AppMetadata) (*UserData, error)
GetUserDataByID requests user data from keycloak via ID.
func (*OktaManager) InviteUserByID ¶ added in v0.21.9
func (om *OktaManager) InviteUserByID(_ string) error
InviteUserByID resend invitations to users who haven't activated, their accounts prior to the expiration period.
func (*OktaManager) UpdateUserAppMetadata ¶ added in v0.21.0
func (om *OktaManager) UpdateUserAppMetadata(userID string, appMetadata AppMetadata) error
UpdateUserAppMetadata updates user app metadata based on userID and metadata map.
type UserData ¶
type UserData struct { Email string `json:"email"` Name string `json:"name"` ID string `json:"user_id"` AppMetadata AppMetadata `json:"app_metadata"` }
type ZitadelClientConfig ¶ added in v0.20.0
type ZitadelClientConfig struct { ClientID string ClientSecret string GrantType string TokenEndpoint string ManagementEndpoint string }
ZitadelClientConfig zitadel manager client configurations.
type ZitadelCredentials ¶ added in v0.20.0
type ZitadelCredentials struct {
// contains filtered or unexported fields
}
ZitadelCredentials zitadel authentication information.
func (*ZitadelCredentials) Authenticate ¶ added in v0.20.0
func (zc *ZitadelCredentials) Authenticate() (JWTToken, error)
Authenticate retrieves access token to use the Zitadel Management API.
type ZitadelManager ¶ added in v0.20.0
type ZitadelManager struct {
// contains filtered or unexported fields
}
ZitadelManager zitadel manager client instance.
func NewZitadelManager ¶ added in v0.20.0
func NewZitadelManager(config ZitadelClientConfig, appMetrics telemetry.AppMetrics) (*ZitadelManager, error)
NewZitadelManager creates a new instance of the ZitadelManager.
func (*ZitadelManager) CreateUser ¶ added in v0.20.0
func (zm *ZitadelManager) CreateUser(_, _, _, _ string) (*UserData, error)
CreateUser creates a new user in zitadel Idp and sends an invite.
func (*ZitadelManager) DeleteUser ¶ added in v0.23.2
func (zm *ZitadelManager) DeleteUser(userID string) error
DeleteUser from Zitadel
func (*ZitadelManager) GetAccount ¶ added in v0.20.0
func (zm *ZitadelManager) GetAccount(accountID string) ([]*UserData, error)
GetAccount returns all the users for a given profile.
func (*ZitadelManager) GetAllAccounts ¶ added in v0.20.0
func (zm *ZitadelManager) GetAllAccounts() (map[string][]*UserData, error)
GetAllAccounts gets all registered accounts with corresponding user data. It returns a list of users indexed by accountID.
func (*ZitadelManager) GetUserByEmail ¶ added in v0.20.0
func (zm *ZitadelManager) GetUserByEmail(email string) ([]*UserData, error)
GetUserByEmail searches users with a given email. If no users have been found, this function returns an empty list.
func (*ZitadelManager) GetUserDataByID ¶ added in v0.20.0
func (zm *ZitadelManager) GetUserDataByID(userID string, appMetadata AppMetadata) (*UserData, error)
GetUserDataByID requests user data from zitadel via ID.
func (*ZitadelManager) InviteUserByID ¶ added in v0.21.9
func (zm *ZitadelManager) InviteUserByID(_ string) error
InviteUserByID resend invitations to users who haven't activated, their accounts prior to the expiration period.
func (*ZitadelManager) UpdateUserAppMetadata ¶ added in v0.20.0
func (zm *ZitadelManager) UpdateUserAppMetadata(_ string, _ AppMetadata) error
UpdateUserAppMetadata updates user app metadata based on userID and metadata map. Metadata values are base64 encoded.