GetParticipantTicket¶

Generates a login ticket for the specified participant.

1

$Membership.GetParticipantTicket(participant: ParticipantInfo, accessScope: string):string

Parameters¶

ParticipantInfo participant
    Participant information.

string accessScope
    The name of the access scope.

Returns¶

A login token for the participant.

Remarks¶

This method is only available within workflow instance scopes and requires a $Instance object to be available.
The accessScope parameter specifies the name of an access scope defined in the process definition. If the specified access scope is not found, an exception is thrown.

Example¶

1
2
3
4
5

var token = $Membership.GetParticipantToken({
    Email : '[email protected]',
    Name : 'John Doe',
    Language : 'en'
}, 'MyAccessScope');

Types¶

ParticipantInfo¶

Represents a external participant information.

Email : string
Email address of participant

Language : string
Preferred language of participant

Name : string
Name of participant

See Also¶

• $Instance