List provisioning workflow execution users

This endpoint enables you to query the list of users affected by a provisioning workflow execution.

Prerequisites

Querying the developer APIs involves sending an access_token as part of the Authorization header. For instructions on how to generate an access token, see Authorization.

Endpoint

This endpoint enables you to query the list of users affected by a provisioning workflow execution.

GET https://public-api.productiv.com/pull/v1/provisioning-workflows/application-instances/:applicationInstanceId/executions/:executionId/users
Required Scope https://api.productiv.com/elm.results.read

Request headers

Parameter Value
Content-Type application/json
Authorization Bearer access_token

Path Params

Parameter Description
applicationInstanceId Unique identifier for the application instance. Application Instance IDs are returned in the List Provisioning Workflows endpoint response.
executionId Identifier for the execution for which the users are being requested. Currently "latest" is the only value supported, to fetch users affected by the most recent execution for this instance.

Query Params

Parameter Description
pageToken Pagination cursor for the next page of users

Response

If the request is successful, a JSON object containing the following attributes is returned:

Parameter Datatype Description
Users array List of UserExecutionOutcome objects (see definition below)
ResponseTimeMs number Time taken by the server to process the request in milliseconds
nextPageToken string Pagination cursor for the next page of users, to be used in a subsequent API call. Only returned if there are more results to be returned

Example Response

{
  "Users": [
    {
      "Email": "user@domain.com",
      "Team": "Engineering",
      "JobTitle": "Software Engineer",
      "Name": "FirstName LastName",
      "RuleId": "9823hejiudwnowsjd8923",
      "Outcome": {
        "Action": "deprovisioned",
        "IsSuggest": true
      }
    },
    {
      "Email": "user2@domain.com",
      "Team": "Engineering",
      "JobTitle": "Software Engineer",
      "Name": "FirstName2 LastName2",
      "RuleId": "vdsf98uvjiu2ne31092jd9woie",
      "Outcome": {
        "Action": "ignored",
        "IsSuggest": true,
        "Reason": "opted out self"
      }
    }
  ],
  "ResponseTimeMs": 2000
}

Objects

UserExecutionOutcome

Parameter Datatype Description
Email string Email for this user
Name string Name for this user
Team string Team this user belongs to
JobTitle string Job title for this user
RuleId string Unique identifier for the rule that matched this user
Outcome object See ExecutionOutcome object below

ExecutionOutcome

Parameter Datatype Description
Action string Type of outcome, see ExecutionOutcomeAction enum below
Reason string Additional explanation for the outcome. Currently only relevant for the "ignored" Action
IsSuggest boolean If true, the action is a suggestion and was not actually performed by Productiv.
IsSsoAccessOutcome boolean If true, the user's SSO access to the application was or will be affected
DestinationLicenseTier string The new license tier for this user. Only defined for "downgraded" and "upgraded" outcome Action

Enums

ExecutionOutcomeAction

Value Description
deprovisioned The user been removed from the app
downgraded The user been downgraded to a different license tier
upgraded The user been upgraded to a different license tier
ignored The user was not actioned on
error Something went wrong while trying to action on the user
waiting The user been notified of an impending workflow run and is waiting to be actioned on
unknown Unknown outcome. Contact Productiv Support for more details