Skip to main content

group-auth-plugin

Classes​

Interfaces​

Type Aliases​

GroupAuth​

Ƭ GroupAuth: Object

Type declaration​

NameType
config?Omit<Partial<GroupAuthConfig>, "adminGroups|appInheritanceTree|orgInheritanceTree">
permission?string

Defined in​

group-auth-plugin/src/types.ts:19


GroupAuthConfig​

Ƭ GroupAuthConfig: Object

Type declaration​

NameType
adminGroups?{ allAppAdmin?: string ; allOrgAdmin?: string ; appAdmin?: string ; orgAdmin?: string ; systemAdmin?: string }
adminGroups.allAppAdmin?string
adminGroups.allOrgAdmin?string
adminGroups.appAdmin?string
adminGroups.orgAdmin?string
adminGroups.systemAdmin?string
appstring
appInheritanceTree?InheritanceTree
appIsStandalone?boolean
appParam?string
defaultRequiredPermission?string
noImplicitApp?boolean
orgInheritanceTree?InheritanceTree
orgParam?string
requireAdmin?boolean | typeof RequireAdminStringOptions[number]

Defined in​

group-auth-plugin/src/types.ts:53


GroupAuthData​

Ƭ GroupAuthData: Object

Type declaration​

NameType
appIdstring | null
orgIdstring | null
standaloneboolean | null
systemAdminboolean

Defined in​

group-auth-plugin/src/types.ts:81


GroupAuthDebug​

Ƭ GroupAuthDebug: GroupAuthDebugBase & { matchingGroups?: { appRequirements: Set<string | undefined> ; orgRequirements: Set<string | undefined> } }

Defined in​

group-auth-plugin/src/types.ts:38


GroupAuthDebugPrintable​

Ƭ GroupAuthDebugPrintable: GroupAuthDebugBase & { matchingGroups: { appRequirements: (string | undefined)[] ; orgRequirements: (string | undefined)[] } }

Defined in​

group-auth-plugin/src/types.ts:31


GroupAuthUserStatus​

Ƭ GroupAuthUserStatus: UserGroups & { appAdminGroups: string[] ; isAppAdmin: boolean ; isOrgAdmin: boolean ; isUser: boolean ; orgAdminGroups: string[] }

Defined in​

group-auth-plugin/src/types.ts:45


GroupRegexHandlers​

Ƭ GroupRegexHandlers: Map<RegExp, (userGroups: UserGroupsInternal, matchGroups: RegExpExecGroups) => void>

Defined in​

group-auth-plugin/src/types.ts:119


InheritanceTree​

Ƭ InheritanceTree: Record<string, string[] | "*">

Defined in​

group-auth-plugin/src/types.ts:3


MappedInheritanceTree​

Ƭ MappedInheritanceTree: Record<string, Set<string> | "*">

Defined in​

group-auth-plugin/src/types.ts:4


UserGroupPermissions​

Ƭ UserGroupPermissions<T>: T extends "array" ? string[] : Set<string>

Type parameters​

NameType
Tundefined

Defined in​

group-auth-plugin/src/types.ts:88


UserGroups​

Ƭ UserGroups: UserGroupsInternal<"array">

Defined in​

group-auth-plugin/src/types.ts:95


UserGroupsInternal​

Ƭ UserGroupsInternal<Style>: Object

Type parameters​

NameType
Styleundefined

Type declaration​

NameType
applications{ [appId: string]: { [orgId: string]: UserGroupPermissions<Style>; _: UserGroupPermissions<Style> }; }
isAllAppAdminboolean
isAllOrgAdminboolean
isSystemAdminboolean
organizations{ [orgId: string]: UserGroupPermissions<Style>; }
standalone{ [appId: string]: { _: UserGroupPermissions<Style> }; }

Defined in​

group-auth-plugin/src/types.ts:97

Variables​

RequireAdminStringOptions​

• Const RequireAdminStringOptions: readonly ["SYSTEM_ADMIN", "ALL_APP_ADMIN_ONLY", "ALL_ORG_ADMIN_ONLY", "APP_ADMINS_ONLY", "ORG_ADMINS_ONLY"]

Defined in​

group-auth-plugin/src/types.ts:72


UserGroupPermissionKey​

• Const UserGroupPermissionKey: "_"

Defined in​

group-auth-plugin/src/types.ts:93