GetParticipantTicket¶

Generates a login ticket for specified participant.

1

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

Parameters¶

ParticipantInfo participant
    Participant information

string accessScope
    Name of access scope

Returns¶

Login token for participant

Remarks¶

This method only available for workflow instance scopes and requires a $Instance object to be available.
Access scope parameter specifies the name of access scope defined in process definition. If not found 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