View the SIEM Event Service Block List

Endpoint URL: {identityDomain} /config/applications/{appId} /eventdelivery/readBlocklist

Description

Returns a list of the SIEM Event Delivery event types that have been blocked for the specified application. If an event type has been blocked, event messages for that type will not be delivered by the event delivery service; however, all other event types (i.e., all the event types not on the block list) will be delivered. By default, block lists are empty, meaning that applications receive event messages for all available event types.

Important. This endpoint was previously known as the "readBlacklist" endpoint. The name has been changed, but the functionality remains exactly the same.

Respects the API Client Allow List: No

Base URL

The base URL for this endpoint is your Identity Cloud Configuration API URL (including the appropriate region) followed by your application ID. For example, if you are in the US region and your application ID is htb8fuhxnf8e38jrzub3c7pfrr then your base URL will look like this:

If you are in the Australian (AU) region your URL will look like this:

URL path parameters
 

Authentication

This endpoint requires Basic authentication and an API client with read permissions. When configuring authentication, use your client ID as the username and your client secret as the password.

Sample Request (curl)

The following command returns the event type block list for the application htb8fuhxnf8e38jrzub3c7pfrr:

curl -X GET \
  https://v1.api.us.janrain.com/config/applications/htb8fuhxnf8e38jrzub3c7pfrr/eventdelivery/readBlocklist \
  -H 'Authorization: Basic M2dmYmdycmE3dzI4MmhndHJ5cGZxeDlwemhxaGpnZDU6Y2dkY3A3bWhjeWszYmZocnl2d2NmY2c3NTdqdzRhb3E='
 

Responses

200 OK

If your call to this endpoint succeeds, you'll get back event block list information similar to this:

Error Response Codes

The following table includes information about some of the other response codes that you might encounter when calling this endpoint.