Skip to main content

Creates a new Alert.​

The endpoint used to create an 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.

Request Body required
  • displayName string

    Display name of the Alert.

  • type string

    Type of the Alert.

  • attributes undefined[]

    A list of attributes of the Alert.

  • key string

    The attribute key.

  • value string

    The attribute value.

  • alertDate date-time

    The Alert DateTime, this could have different meanings based on the type of 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.

  • application object

    The corresponding Application object of the Alert.

  • displayName string

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

  • value string

    The Application associated with the Alert.

  • $ref string

    The URI of the SCIM resource representating the Alert application.

Responses

Creates an Alert and returns the resultant Alert.

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.

  • value string

    The attribute value.

  • key string

    The attribute key.

  • application object

    The corresponding Application object of the Alert.

  • value string

    The Application associated with the Alert.

  • $ref object

    The URI of the SCIM resource representating the Alert application.

  • displayName string

    The name of the Alert Application.

  • actions undefined[]

    Not empty if action was taken on the Alert.

  • 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.

  • 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.

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

    Metadata for the Alert.

  • 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.

  • schemas string[]

    A list of the schemas used for Alerts.

Loading...