Skip to content

Expand

Expands the given input into a list of User-type identities and returns them as an array.

1
$Membership.Expand(identity: ( string | Array<string> | Identity | Array<Identity> )):Array<Identity>

Parameters

( string | Array | Identity | Array<Identity> ) identity
    The input identity to expand.

Returns

A list of User-type identities derived from the input.

Remarks

If the input identity is not found in the membership database, an empty array is returned.

Expanding a group named 'Administrators' into a list of user identities:

1
var administratorUsers = $Membership.Expand($Membership.FindIdentity('Administrators', 'Group'));

Expanding an organization unit named 'MyOrganizationUnit' into a list of user identities:

1
var departmentUsers = $Membership.Expand($Membership.FindIdentity('MyOrganizationUnit', 'OrganizationUnit'));

See Also