/eventdelivery/readKeys

GET

Description

Returns information about the public keys associated with the specified application. Public keys are required in order to download the event messages delivered by the SIEM Event Delivery service. Each user that accesses the S3 bucket must supply a valid public key; note, however, that no application can be assigned more than 10 public keys.

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:

appID

string

Yes

Unique identifier of the Identity Cloud application. 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 returns information about the public keys associated with the Identity Cloud application htb8fuhxnf8e38jrzub3c7pfrr:


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

Responses

200 OK

If your call to this endpoint succeeds, you'll get back information about the SIEM Event Delivery public keys associated with the application:

[
{
"key": {
"$ref": "ssh-rsa
AAAAB3NzaC1yc2EAAAADAQABAAABAQDWKvQV0MoER+0mv+KGRDxY7b39yrEGo6qiQ0xPM8vhDp5JMjm9k
4KFSVrx0qewp2AsCl3qamJcvaStyxBZTfhIFsEWt1BAtixki0WRj8iTDugtXhdu65lGYuxkLiGWUNZu5OTXSA/6usdtvU
gS7WIeeFWWl0jYwoU4cLGbafldSDfH77Ab1m6PbZGaIw7rJLZkkY+yPan/0ONzIEfTJdBUZI4g+MfFvTcsCG5Jo3AqG
V/g08hL8/SFMhbtKFAIslAkmmcEP1Oj27AAj6EtoD8YqjJZtO6uDq7KApq2J/M499NKhHGnrPI23AqgaOBNDdJNgj51z
YKyhNudUI1ap+qt gstemp@akamai.com"
},
"status": "creation complete",
"created": "2019-08-05T18:01:30Z"
}
]

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.

GET