Adds an identity link associating a user with a specified process instance.
Generally speaking the necessary identity links will be created automatically by the workflow engine in response to events but this provides a way to add them manually.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| processInstanceBusinessKey | String | Either this or the ID | The business key of the process instance to associate the user with |
| processInstanceId | String | Either this or the business key | ID of the process instance to associate the user with |
| userId | String | Yes | The ID of the user to associate with the process (lower cased) |
| linkType | String | Yes | The relationship the user has with the process. This will normally be "assignee", "candidate", "owner", "participant", or "starter" |
Last modified on 19 August 2026
