Skip to content

Latest commit

 

History

History
89 lines (52 loc) · 3.36 KB

using-the-events-service-apis-94e1895.md

File metadata and controls

89 lines (52 loc) · 3.36 KB

Using the Events Service APIs

The Events service provides REST APIs that collect information about events relating to account administrative operations in the microservices of the SAP Cloud Management service for SAP BTP, such as Accounts, Entitlements, Provisioning, and the SAP SaaS Provisioning service, within central and local regions.

You can filter the events by various query parameters, such as a specific time frame, event type, or the type of entity associated with the event.

You can also use the APIs to get all available event types.

Here are some examples of scenarios that can be implemented or built by reacting to account administrative events:

  • A global account admin can implement an automatic tagging system for newly created subaccounts by polling for subaccount creation events, Subaccount_Creation, from the Accounts service and then adding custom property to each one of the subaccounts according to predefined criteria.
  • Set up automatic notifications when a global account admin assigns quota to subaccounts. This scenario uses the SubaccountEntitlements_Update event from the Entitlements service.
  • Send automatic alerts when a directory is deleted. This scenario uses the event AccountDirectory_Deletion from the Accounts service.
  • Use the subscription events information, SubaccountAppSubscription_Creation, from the SAP SaaS Provisioning service, to send emails notifying when applications are subscribed to from a subaccount.

Permissions: A service instance of the SAP Cloud Management service is required. The scopes required to get the events are available for all of the plans for the SAP Cloud Management service. See SAP Cloud Management Service - Service Plans.

For more information about permissions, see Getting an Access Token for SAP Cloud Management Service APIs.

Base URI: https://events-service.<app domain>.<landscape domain>

HTTP Method

Action

URI

GET

Get events

events-service.<app domain>.<landscape domain>/cloud-management/v1/events

GET

Get event types

events-service.<app domain>.<landscape domain>/cloud-management/v1/events/types

Related Information

Getting an Access Token for SAP Cloud Management Service APIs