Skip to main content

List Notification Preferences for tenant.

GET 

/notification-preferences/:key

experimental

This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.

Returns a list of notification preferences for tenant.

Request

Header Parameters

    X-SailPoint-Experimental stringrequired

    Default value: true

    Use this header to enable this experimental API.

    Example: true

Responses

Return preference for the given notification key.

Schema

  • Array [

  • key string

    The template notification key.

    mediums Medium (string)[]

    Possible values: [EMAIL, SMS, PHONE, SLACK, TEAMS]

    List of preferred notification mediums, i.e., the mediums (or method) for which notifications are enabled. More mediums may be added in the future.

    modified date-time

    Modified date of preference

  • ]

Loading...