Skip to main content

Returns an Alert resource based on id.

GET 
/Alerts/:alertId

>The Alert resource with matching id is returned.

Attributes to include in the response can be specified with the attributes query parameter.

Attributes to exclude from the response can be specified with the excludedAttributes query parameter.

Request​

Path Parameters

    alertId stringrequired

    id of Alert resource.

Query Parameters

    attributes string

    A comma-separated list of attributes to return in the response. This query parameter supersedes excludedAttributes, so providing the same attribute(s) to both will result in the attribute(s) being returned.

    excludedAttributes string

    A comma-separated list of attributes to exclude from the response. Some attributes cannot be excluded.

Responses​

Returns a single Alert resource based on the id.

Schema

    id string

    Unique identifier of the Alert.

    name string

    Name of the Alert, auto-generated by the SCIM Server.

    displayName string

    Display name of the Alert.

    type string

    Type of the Alert.

    attributes

    undefined[]

    A list of attributes of the Alert.

  • Array [

    • value string

    The attribute value.

    key string

    The attribute key.

  • ]

    • application

    undefined[]

    The corresponding Application object of the Alert.

  • Array [

    • value string

    The Application associated with the Alert.

    $ref string

    The URI of the SCIM resource representating the Alert application.

    displayName string

    The name of the Alert Application. OPTIONAL and READ-ONLY.

  • ]

    • actions

    undefined[]

    Alert actions.

  • Array [

    • type string

    Possible values: [WORKFLOW, CERTIFICATION, NOTIFICATION]

    The type of action performed as a result of the Alert.

    alertDefinitionName string

    The name of the Alert Definition that triggered the action.

    resultId string

    Typically actions create other objects, a certificationId or workflowId as a result of the action taken.

    result

    undefined[]

    The Task Result of the Alert.

  • Array [

    • name string

    The name of the Task Result for the Alert action.

    workflowName string

    The name of the Workflow used in the Alert action task result.

    notifications

    undefined[]

    Notifications to send when a Alert action is generated.

  • Array [

    • name string

    The name of configured notifications for Alert action results.

    displayName string

    Display name for the Alert action notification.

    emailAddresses string

    A list of email addresses to send an Alert action notification.

  • ]

  • ]

  • ]

    • alertDate date-time

    The Alert DateTime, this could have different meanings based on the type of alert.

    lastProcessed date-time

    The DateTime of the last time the Alert was processed, this does not indicate the system took action on the Alert.

    nativeId string

    Unique Identifier of the Alert in the native system.

    targetId string

    Unique Identifier of the target object which caused the Alert.

    targetType string

    The type of SailPointObject the target is.

    targetDisplayName string

    User friendly display name of the target object.

    meta

    object

    created date-time

    DateTime when the Alert was created.

    location string

    URL to the Alert.

    lastModified date-time

    DateTime of Alert last modification.

    version string

    Alert version.

    resourceType string

    Resource type of the metadata subject.

Loading...