Skip to main content

List Triggers

GET 
/triggers

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

Request​

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

    Default value: 0

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

    Example: 0
    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, ge, le

    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 stringrequired

    Unique identifier of the trigger.

    name stringrequired

    Trigger Name.

    type TriggerType (string)required

    Possible values: [REQUEST_RESPONSE, FIRE_AND_FORGET]

    The type of trigger.

    description string

    Trigger Description.

    inputSchema stringrequired

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

    exampleInput

    object

    required

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

    oneOf

    accessRequestId stringrequired

    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[]

    required

    Possible values: >= 1, <= 10

    Identities access was requested for.

  • Array [

    • type string

    Possible values: [IDENTITY]

    DTO type of identity the access item is requested for.

    id string

    ID of identity the access item is requested for.

    name string

    Human-readable display name of identity the access item is requested for.

  • ]

    • requestedItems

    object[]

    required

    Possible values: >= 1, <= 25

    The access items that are being requested.

  • Array [

    • id stringrequired

    The unique ID of the access item.

    name stringrequired

    Human friendly name of the access item.

    description stringnullable

    Extended description of the access item.

    type required

    Possible values: [ACCESS_PROFILE, ROLE, ENTITLEMENT]

    The type of access item being requested.

    operation required

    Possible values: [Add, Remove]

    Grant or revoke the access item

    comment stringnullable

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

  • ]

    • requestedBy

    object

    required

    Access item requester's identity.

    type string

    Possible values: [IDENTITY]

    Access item requester's DTO type.

    id string

    Access item requester's identity ID.

    name string

    Access item owner's human-readable display name.

    outputSchema stringnullable

    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

    nullable

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

    oneOf

    id stringrequired

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

    name stringrequired

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

    type required

    Possible values: [IDENTITY, GOVERNANCE_GROUP]

    The type of object being referenced.

  • ]

Loading...