/eventdelivery/readStatus

GET


Description

Returns the SIEM Event Delivery activation/deactivation status for the specified application. You can use this endpoint to determine whether or not an application has completed activation and is now capable of receiving SIEM event deliveries; you can also determine whether or not an application has been deactivated and is no longer capable of receiving SIEM event deliveries.


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 status is being checked. For example:

htb8fuhxnf8e38jrzub3c7pfrr


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 verifies SIEM Event Delivery activation status for the Identity Cloud application with the ID htb8fuhxnf8e38jrzub3c7pfrr:


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


Responses

200 OK

If your call to this endpoint succeeds, and if the activation process is complete, you’ll get back status information similar to the following:

{
   "status": "creation complete"

Other possible status values for the activation/deactivation process include:

  • creation queued
  • creation in progress
  • creation failed
  • deletion queued
  • deletion in progress
  • deletion complete
  • deletion failed


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

401

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

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.