Skip to content

$Membership

$Membership provides access to users and organizational database objects.

You can use the $Membership.Administrator property to access the domain administrators group.

To query for a specific identity, use $Membership.FindIdentity or $Membership.FindPosition to search by certain criteria. Alternatively, you can directly query an identity using the $Membership.Get method.

If you have an identity and want to query its properties, use $Membership.GetProperty to retrieve specific property values.

To find the manager of a user, position, or organization unit, use $Membership.FindManager to perform a more complex query.

1
const $Membership;

Capabilities

Built-in Identities

User Management

Participants

  • Membership.EnsureParticipant: Ensures that the specified email address is saved as a participant identity. If a participant with the given email already exists, it is returned instead of creating a new one.

Hierarchy

Lookup

  • Membership.FindIdentity: Retrieves an identity based on the specified path and type.
  • Membership.FindManager: Retrieves the manager position associated with a given identity, if one exists.
  • Membership.FindPosition: Retrieves a list of available positions by name. Note that empty positions (those with no active employee assigned) are not included in the results. The Id property of each position corresponds to the column in the OrganizationUnitPosition table.
  • Membership.Get: Retrieves an identity based on its unique identifier.
  • Membership.GetPath: Retrieves the organizational path of a specified organization unit.
  • Membership.GetProperty: Retrieves a specific property value associated with a given identity.

Authentication and Tickets

Membership

  • Membership.IsMemberOf: Determines whether a source identity is a member of a target identity.
  • Membership.Join: Merges the specified input into a consolidated array of unique identities, removing any duplicate entries.