/eventdelivery/deleteBlacklist

POST


Description

Removes one or more events from an application’s SIEM Event Delivery service block list. 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 will be delivered. If you remove an event type from the block list then the SIEM Event Delivery service will resume delivering event messages for that event type.


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:

https://v1.api.us.janrain.com/config/applications/htb8fuhxnf8e38jrzub3c7pfrr

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

https://v1.api.au.janrain.com/config/applications/htb8fuhxnf8e38jrzub3c7pfrr


URL Path Parameters
 

Parameter

Type

Required

Description

region

string


Yes

Identity Cloud geographic region that hosts the application. Allowed values are:

  • us
  • eu
  • au
  • sg
  • cc

appID

string

Yes

Unique identifier of the Identity Cloud application whose block list is being updated. For example:

htb8fuhxnf8e38jrzub3c7pfrr



Request Parameters

Request parameters must be formatted as JSON objects and included in your API call’s body parameter. Valid request parameters include the following:

Parameter

Type

Required

Description

blacklist

array (string)


Yes

JSON array of the event types being removed from the block list. For example:

["config_change","email_verification"]


Note that you do not need to include the parameter name in the body request. The parameter value (the events being removed from the block list) is all that’s needed.


Authentication

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


Sample Request (curl)

The following command removes a pair of event types – config_change and email_verification from the event type block list for the application htb8fuhxnf8e38jrzub3c7pfrr:


curl -X POST \
  https://v1.api.us.janrain.com/config/applications/htb8fuhxnf8e38jrzub3c7pfrr/eventdelivery/deleteBlacklist \
  -H 'Authorization: Basic M2dmYmdycmE3dzI4MmhndHJ5cGZxeDlwemhxaGpnZDU6Y2dkY3A3bWhjeWszYmZocnl2d2NmY2c3NTdqdzRhb3E=' \
  -H 'Content-Type: application/json' \
  -d '
        "config_change",
        "email_verification"
      ]'
 


Responses

200 OK

If your call to this endpoint succeeds, you'll get back the following response:

{
    "message": "The event type(s) were successfully removed from
    the blacklist."



Error Response Codes

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

Response Code

Description

400

The request payload is not valid JSON. Your API request did not pass the JSON schema validation. Verify that you are using correctly-formatted JSON in the request parameter and then try again.

401

Not authorized. Your client credentials may be invalid. You have specified an invalid client name and/or an invalid client secret.

403

Forbidden. Your credentials are valid for the application but not for this endpoint. For example, if you have read-only credentials those credentials can only be used with GET endpoints.

404

The Akamai account ID was not found. Check your application settings for 'akamai_account_id'. Your Akamai account ID must be listed in the application settings for the application specified in your API call. You can use the /{appId}/settings/options API endpoint or the Console to verify your application settings.