Skip to main content

List Triggers

Gets a list of triggers that are available in the tenant.

Query Parameters
  • limit int32

    Possible values: <= 250

    Default value: 250

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

    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.

  • count boolean

    If true it will populate the X-Total-Count response header with the number of results that would be returned if limit and offset were ignored.

    Since requesting a total count can have a performance impact, it is recommended not to send count=true if that value will not be used.

    See V3 API Standard Collection Parameters for more information.

    Example: true
  • 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:access-request-post-approval"
  • sorters comma-separated

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

    Sorting is supported for the following fields:

    id name

    Example: name
Responses

List of triggers.


Schema array
  • id string

    Unique identifier of the trigger.

  • name string

    Trigger Name.

  • type string

    Possible values: [REQUEST_RESPONSE, FIRE_AND_FORGET]

    The type of trigger.

  • description string

    Trigger Description.

  • inputSchema string

    The JSON schema of the payload that will be sent by the trigger to the subscribed service.

  • exampleInput object

    An example of the JSON payload that will be sent by the trigger to the subscribed service.

    oneOf

  • accessRequestId string

    The unique ID of the access request object. Can be used with the access request status endpoint to get the status of the request.

  • requestedFor object
  • type string

    Possible values: [ACCOUNT_CORRELATION_CONFIG, ACCESS_PROFILE, ACCESS_REQUEST_APPROVAL, ACCOUNT, APPLICATION, CAMPAIGN, CAMPAIGN_FILTER, CERTIFICATION, CLUSTER, CONNECTOR_SCHEMA, ENTITLEMENT, GOVERNANCE_GROUP, IDENTITY, IDENTITY_PROFILE, IDENTITY_REQUEST, LIFECYCLE_STATE, PASSWORD_POLICY, ROLE, RULE, SOD_POLICY, SOURCE, TAG_CATEGORY, TASK_RESULT, REPORT_RESULT, SOD_VIOLATION, ACCOUNT_ACTIVITY]

    DTO type

  • id string

    ID of the object to which this reference applies

  • name string

    Human-readable display name of the object to which this reference applies

  • requestedItems object[]

    The access items that are being requested.

  • id string

    The unique ID of the access item.

  • name string

    Human friendly name of the access item.

  • description string

    Extended description of the access item.

  • type

    Possible values: [ACCESS_PROFILE, ROLE, ENTITLEMENT]

    The type of access item being requested.

  • operation

    Possible values: [Add, Remove]

    Grant or revoke the access item

  • comment string

    A comment from the requestor on why the access is needed.

  • requestedBy object
  • type string

    Possible values: [ACCOUNT_CORRELATION_CONFIG, ACCESS_PROFILE, ACCESS_REQUEST_APPROVAL, ACCOUNT, APPLICATION, CAMPAIGN, CAMPAIGN_FILTER, CERTIFICATION, CLUSTER, CONNECTOR_SCHEMA, ENTITLEMENT, GOVERNANCE_GROUP, IDENTITY, IDENTITY_PROFILE, IDENTITY_REQUEST, LIFECYCLE_STATE, PASSWORD_POLICY, ROLE, RULE, SOD_POLICY, SOURCE, TAG_CATEGORY, TASK_RESULT, REPORT_RESULT, SOD_VIOLATION, ACCOUNT_ACTIVITY]

    DTO type

  • id string

    ID of the object to which this reference applies

  • name string

    Human-readable display name of the object to which this reference applies

  • outputSchema string

    The JSON schema of the response that will be sent by the subscribed service to the trigger in response to an event. This only applies to a trigger type of REQUEST_RESPONSE.

  • exampleOutput object

    An example of the JSON payload that will be sent by the subscribed service to the trigger in response to an event.

    oneOf

  • id string

    The unique ID of the identity to add to the approver list for the access request.

  • name string

    The name of the identity to add to the approver list for the access request.

  • type

    Possible values: [IDENTITY, GOVERNANCE_GROUP]

    The type of object being referenced.

Loading...