@manta-eu/client/shared/team
Reference for @manta-eu/client/shared/team as it is on main.
Type Aliases
AssignableGroup
AssignableGroup =
object
Properties
depth
depth:
number
name
name:
string
path
path:
string
selectable?
optionalselectable?:boolean
AssignableOrganization
AssignableOrganization =
object
Properties
alias
alias:
string
groups?
optionalgroups?:AssignableGroup[]
name?
optionalname?:string
wholeOrg?
optionalwholeOrg?:boolean
AssignmentOutcome
AssignmentOutcome =
"assigned"|"already"|"failed"
AssignmentResult
AssignmentResult =
AssignTarget&object
Type Declaration
message?
optionalmessage?:string
outcome
outcome:
AssignmentOutcome
userId
userId:
string
AssignmentRole
AssignmentRole =
object
Properties
role
role:
string
userId
userId:
string
AssignmentSummary
AssignmentSummary =
object
Properties
assigned
assigned:
number
failed
failed:
number
results
results:
AssignmentResult[]
roleFailures
roleFailures:
BulkMutationFailure[]
skipped
skipped:
number
AssignTarget
AssignTarget =
object
Properties
group?
optionalgroup?:string
org
org:
string
BulkMutationFailure
BulkMutationFailure =
object
Properties
id
id:
string
message
message:
string
BulkMutationResult
BulkMutationResult =
object
Properties
attempted
attempted:
number
changed
changed:
number
failures
failures:
BulkMutationFailure[]
BulkUserOrgPair
BulkUserOrgPair =
object
Properties
org?
optionalorg?:string
userId
userId:
string
DirectoryMembership
DirectoryMembership =
object
Properties
groups
groups:
string[]
managed?
optionalmanaged?:true
name?
optionalname?:string
org
org:
string
DirectoryUser
DirectoryUser =
object
Properties
email?
optionalemail?:string
enabled
enabled:
boolean
federated?
optionalfederated?:boolean
firstName?
optionalfirstName?:string
id
id:
string
invitedTo?
optionalinvitedTo?:DirectoryMembership[]
inviteUrl?
optionalinviteUrl?:string
lastName?
optionallastName?:string
memberships
memberships:
DirectoryMembership[]
name?
optionalname?:string
nameReadOnly?
optionalnameReadOnly?:boolean
operator?
optionaloperator?:boolean
pending?
optionalpending?:boolean
username?
optionalusername?:string
EmailListParse
EmailListParse =
object
Properties
emails
emails:
string[]
invalid
invalid:
string[]
InviteGrantOutcome
InviteGrantOutcome =
"applied"|"recorded"|"dropped"
InviteOutcome
InviteOutcome =
"invited"|"already"|"failed"
InviteResult
InviteResult =
object
Properties
email:
string
grant?
optionalgrant?:InviteGrantOutcome
id?
optionalid?:string
message?
optionalmessage?:string
outcome
outcome:
InviteOutcome
pending?
optionalpending?:boolean
InviteSummary
InviteSummary =
object
Properties
failed
failed:
number
invited
invited:
number
results
results:
InviteResult[]
skipped
skipped:
number
TeamDirectory
TeamDirectory =
object
Properties
hasMore
hasMore:
boolean
total?
optionaltotal?:number
Rows matching the query across the realm, or undefined when Keycloak could not count them.
truncated
truncated:
boolean
users
users:
DirectoryUser[]
TeamGroup
TeamGroup =
object
Properties
depth
depth:
number
name
name:
string
path
path:
string
selectable?
optionalselectable?:boolean
TeamMember
TeamMember =
object
Properties
email?
optionalemail?:string
enabled
enabled:
boolean
expired?
optionalexpired?:boolean
federated?
optionalfederated?:boolean
id
id:
string
inviteUrl?
optionalinviteUrl?:string
lastSignInAt?
optionallastSignInAt?:string
managed?
optionalmanaged?:true
name?
optionalname?:string
pending
pending:
boolean
roles
roles:
string[]
teams
teams:
string[]
TeamOrganization
TeamOrganization =
object
Properties
alias?
optionalalias?:string
inviteCarriesGrants?
optionalinviteCarriesGrants?:true
managed
managed:
boolean
mirrored
mirrored:
boolean
name?
optionalname?:string
TeamRole
TeamRole =
string
TeamRoster
TeamRoster =
object
Properties
hasMore?
optionalhasMore?:boolean
members
members:
TeamMember[]
organization?
optionalorganization?:TeamOrganization
snapshot?
optionalsnapshot?:string
total?
optionaltotal?:number
truncated
truncated:
boolean
unfilteredTotal?
optionalunfilteredTotal?:number
UserLabelSource
UserLabelSource =
object
Properties
email?
optionalemail?:string
id
id:
string
name?
optionalname?:string
username?
optionalusername?:string
Variables
auth0NameLimits
constauth0NameLimits:object
Type Declaration
part
readonlypart:150=150
whole
readonlywhole:300=300
directoryPageSize
constdirectoryPageSize:20=20
maxAssignmentPairs
constmaxAssignmentPairs:200=200
maxBulkMembers
constmaxBulkMembers:300=300
maxDirectoryPageSize
constmaxDirectoryPageSize:100=100
maxRosterPageSize
constmaxRosterPageSize:100=100
rosterPageSize
constrosterPageSize:20=20
waveSize
constwaveSize:8=8
Functions
ancestorPaths()
ancestorPaths(
path):string[]
Parameters
path
string
Returns
string[]
assignTargetKey()
assignTargetKey(
target):string
Parameters
target
Returns
string
bulkPairId()
bulkPairId(
pair):string
Parameters
pair
Returns
string
chunk()
chunk<
T>(items,size):T[][]
Type Parameters
T
T
Parameters
items
T[]
size
number
Returns
T[][]
groupDepthFromPath()
groupDepthFromPath(
path):number
Parameters
path
string
Returns
number
groupNameFromPath()
groupNameFromPath(
path):string
Parameters
path
string
Returns
string
isEmailAddress()
isEmailAddress(
value):boolean
Parameters
value
string
Returns
boolean
mapInWaves()
mapInWaves<
T,R>(items,fn,size?):Promise<R[]>
Type Parameters
T
T
R
R
Parameters
items
T[]
fn
(item) => Promise<R>
size?
number = waveSize
Returns
Promise<R[]>
namesAGroup()
namesAGroup(
path):boolean
Parameters
path
string | undefined
Returns
boolean
normalizeGroupPath()
normalizeGroupPath(
path):string
Mirrors manta-clj’s normalization, so client-side comparisons match its replies.
Parameters
path
string
Returns
string
parseEmailList()
parseEmailList(
raw):EmailListParse
Folds like manta-clj’s distinct-emails: case-insensitively, first spelling wins.
Parameters
raw
string
Returns
pathSegments()
pathSegments(
path):string[]
Parameters
path
string
Returns
string[]
userLabel()
userLabel(
user):string
Parameters
user
Returns
string