Registering Notification Endpoints

Method	Endpoint
PUT	<base-url>/api/data-pe/v1/rotation-notification

JSON Payload

{"usecase": "credentialRotationNotification", "endpoint": "http://example.org:80/foo/bar/baz/notification1" }

This method inserts unique endpoints into the notification endpoint list. Duplicates are silently ignored (intended for repeat registrations from restarted callback services). The notification endpoint can be a URL in the form of http, https, or mailto (for example, mailto:[e-mail]).

Registered http or https endpoints are called with an http POST containing a JSON payload describing the scope of the change:

{usecase:"credentialRotation", change:"<all|credentials| wallet>" }

Note:

If an http or https endpoint is registered, you may need to add an ingress rule for <base_url> to ensure that the endpoint is reachable.

Registered mailto endpoints are sent a notification email. SMTP notifications are sent from the regional OCI Email Delivery Service to the email address that the customer specifies.

After receiving this notification, the consuming applications should refresh their credentials using the fetch-credentials or fetch-wallet endpoints.