Interface MembershipTraitConfig

MembershipTrait config.

Hierarchy

Properties

allowMultipleRoles? baseName? defaultMembershipType fullAccessUser invite? invitee_types? invites_accepted_automatically? membershipTypes name passive? remove_mutations? roles? searchRelationship? type userConnections?

Properties

Optional allowMultipleRoles

allowMultipleRoles?: boolean

Optional baseName

baseName?: string

Parent source node type (if any).

defaultMembershipType

defaultMembershipType: string

fullAccessUser

fullAccessUser: {
    roles: string[];
    traversal: string[];
}

Gremlin traversals and user roles to define full access users Full access user can perform any operation

Type declaration

  • roles: string[]
  • traversal: string[]

Optional invite

invite?: MembershipTraitInviteConfig

Invitations config.

Optional invitee_types

invitee_types?: string[]

A list of entity types which could be invited, defaults to User.

Optional invites_accepted_automatically

invites_accepted_automatically?: boolean

membershipTypes

membershipTypes: Record<string, MembershipType>

name

name: string

Source node type.

Optional passive

passive?: boolean

Passive membership type disables mutations as well as invitations.

Optional remove_mutations

remove_mutations?: boolean

Optional roles

roles?: MembershipTraitRolesConfig

Roles configuration override.

Optional searchRelationship

searchRelationship?: string

Which search relationship, defined on member entities, should be used to find entities that are members of this particular group (used for search- based connections)

type

type: "membership"

Trait type ID.

Optional userConnections

userConnections?: boolean

Settings

Member Visibility

Theme

Generated using TypeDoc