enidpsync
packageThis package is not in the latest version of its module.
Details
Validgo.mod file
The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license
Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version
Modules with tagged versions give importers more predictable builds.
Stable version
When a project reaches major version v1 it is considered stable.
- Learn more about best practices
Repository
Links
Documentation¶
Index¶
- type EnterpriseIDPSync
- func (e EnterpriseIDPSync) GroupSyncEntitled() bool
- func (e EnterpriseIDPSync) OrganizationRoleSyncEnabled(ctx context.Context, db database.Store, orgID uuid.UUID) (bool, error)
- func (e EnterpriseIDPSync) OrganizationSyncEnabled(ctx context.Context, db database.Store) bool
- func (e EnterpriseIDPSync) OrganizationSyncEntitled() bool
- func (e EnterpriseIDPSync) ParseGroupClaims(ctx context.Context, mergedClaims jwt.MapClaims) (idpsync.GroupParams, *idpsync.HTTPError)
- func (e EnterpriseIDPSync) ParseOrganizationClaims(ctx context.Context, mergedClaims jwt.MapClaims) (idpsync.OrganizationParams, *idpsync.HTTPError)
- func (e EnterpriseIDPSync) ParseRoleClaims(ctx context.Context, mergedClaims jwt.MapClaims) (idpsync.RoleParams, *idpsync.HTTPError)
- func (e EnterpriseIDPSync) RoleSyncEntitled() bool
- func (e EnterpriseIDPSync) SiteRoleSyncEnabled() bool
Constants¶
This section is empty.
Variables¶
This section is empty.
Functions¶
This section is empty.
Types¶
typeEnterpriseIDPSync¶
type EnterpriseIDPSync struct {*idpsync.AGPLIDPSync// contains filtered or unexported fields}
EnterpriseIDPSync enabled syncing user information from an external IDP.The sync is an enterprise feature, so this struct wraps the AGPL implementationand extends it with enterprise capabilities. These capabilities can entirelybe changed in the Parsing, and leaving the "syncing" part (which holds themore complex logic) to the shared AGPL implementation.
funcNewSync¶
func NewSync(loggerslog.Logger, manager *runtimeconfig.Manager, set *entitlements.Set, settingsidpsync.DeploymentSyncSettings) *EnterpriseIDPSync
func (EnterpriseIDPSync)GroupSyncEntitled¶added inv2.18.0
func (eEnterpriseIDPSync) GroupSyncEntitled()bool
func (EnterpriseIDPSync)OrganizationRoleSyncEnabled¶added inv2.16.0
func (EnterpriseIDPSync)OrganizationSyncEnabled¶
func (EnterpriseIDPSync)OrganizationSyncEntitled¶added inv2.18.0
func (eEnterpriseIDPSync) OrganizationSyncEntitled()bool
func (EnterpriseIDPSync)ParseGroupClaims¶added inv2.16.0
func (eEnterpriseIDPSync) ParseGroupClaims(ctxcontext.Context, mergedClaims jwt.MapClaims) (idpsync.GroupParams, *idpsync.HTTPError)
ParseGroupClaims parses the user claims and handles deployment wide group behavior.Almost all behavior is deferred since each organization configures it's owngroup sync settings.GroupAllowList is implemented here to prevent login by unauthorized users.TODO: GroupAllowList overlaps with the default organization group sync settings.
func (EnterpriseIDPSync)ParseOrganizationClaims¶
func (eEnterpriseIDPSync) ParseOrganizationClaims(ctxcontext.Context, mergedClaims jwt.MapClaims) (idpsync.OrganizationParams, *idpsync.HTTPError)
func (EnterpriseIDPSync)ParseRoleClaims¶added inv2.16.0
func (eEnterpriseIDPSync) ParseRoleClaims(ctxcontext.Context, mergedClaims jwt.MapClaims) (idpsync.RoleParams, *idpsync.HTTPError)
func (EnterpriseIDPSync)RoleSyncEntitled¶added inv2.16.0
func (eEnterpriseIDPSync) RoleSyncEntitled()bool
func (EnterpriseIDPSync)SiteRoleSyncEnabled¶added inv2.16.0
func (eEnterpriseIDPSync) SiteRoleSyncEnabled()bool