Skip to main content

List Workflow Library Triggers

GET 

https://sailpoint.api.identitynow.com/beta/workflow-library/triggers

This lists the workflow triggers available to you

Request

Query Parameters

    limit int32

    Possible values: <= 250

    Max number of results to return. See V3 API Standard Collection Parameters for more information.

    Default value: 250
    Example: 250
    offset int32

    Offset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information.

    Default value: 0
    Example: 0
    filters string

    Filter results using the standard syntax described in V3 API Standard Collection Parameters

    Filtering is supported for the following fields and operators:

    id: eq

    Example: id eq "idn:identity-attributes-changed"

Responses

List of workflow triggers

Schema
  • Array [
  • idstring

    Trigger ID. This is a static namespaced ID for the trigger.

    Example: idn:identity-attributes-changed
    typestring

    Trigger type

    Possible values: [EVENT, SCHEDULED, EXTERNAL]

    Example: EVENT
    deprecatedboolean
    deprecatedBydate-time
    isSimulationEnabledboolean
    outputSchemaobject

    Example output schema

    namestring

    Trigger Name

    Example: Identity Attributes Changed
    descriptionstring

    Trigger Description

    Example: One or more identity attributes changed.
    isDynamicSchemaboolean

    Determines whether the dynamic output schema is returned in place of the action's output schema. The dynamic schema lists non-static properties, like properties of a workflow form where each form has different fields. These will be provided dynamically based on available form fields.

    Example: false
    inputExampleobjectnullable

    Example trigger payload if applicable

    Example: {"changes":[{"attribute":"department","newValue":"marketing","oldValue":"sales"},{"attribute":"manager","newValue":{"id":"ee769173319b41d19ccec6c235423236c","name":"mean.guy","type":"IDENTITY"},"oldValue":{"id":"ee769173319b41d19ccec6c235423237b","name":"nice.guy","type":"IDENTITY"}},{"attribute":"email","newValue":"john.doe@gmail.com","oldValue":"john.doe@hotmail.com"}],"identity":{"id":"ee769173319b41d19ccec6cea52f237b","name":"john.doe","type":"IDENTITY"}}
    formFields object[]nullable

    One or more inputs that the trigger accepts

  • Array [
  • descriptionstring

    Description of the form field

    Example: First value to compare
    helpTextstring

    Describes the form field in the UI

    Example: The name to give to this certification campaign.
    labelstring

    A human readable name for this form field in the UI

    Example: Campaign Name
    namestring

    The name of the input attribute

    Example: name
    requiredboolean

    Denotes if this field is a required attribute

    Example: false
    typestringnullable

    The type of the form field

    Possible values: [text, textarea, boolean, email, url, number, json, checkbox, jsonpath, select, multiType, duration, toggle, formPicker, identityPicker, governanceGroupPicker, string, object, array, secret, keyValuePairs, emailPicker, advancedToggle, variableCreator, htmlEditor]

    Example: text
  • ]
  • ]

Authorization: oauth2

type: Personal Access Token
scopes: sp:workflow:read

Request Collapse all
Base URL
https://sailpoint.api.identitynow.com/beta
Auth
Parameters
— query
— query
— query
ResponseClear

Click the Send API Request button above and see the response here!