Sign in

v1

latestOpenAPI 3.0.1Apache 2.02026-07-145344123.3 KB

Create a new Notification for the corresponding Challenge

post/v2/Services/{ServiceSid}/Entities/{Identity}/Challenges/{ChallengeSid}/Notifications

Path parameters

ServiceSidstring required

The unique SID identifier of the Service.

Identitystring required

Customer unique identity for the Entity owner of the Challenge. This identifier should be immutable, not PII, length between 8 and 64 characters, and generated by your external system, such as your user's UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters.

ChallengeSidstring required

The unique SID identifier of the Challenge.

Response

Created

account_sidstring nullable

The unique SID identifier of the Account.

challenge_sidstring nullable

The unique SID identifier of the Challenge.

date_createdstring date-time nullable

The date that this Notification was created, given in ISO 8601 format.

entity_sidstring nullable

The unique SID identifier of the Entity.

identitystring nullable

Customer unique identity for the Entity owner of the Challenge. This identifier should be immutable, not PII, length between 8 and 64 characters, and generated by your external system, such as your user's UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters.

prioritystring nullable

The priority of the notification. For push Challenges it's always high which sends the notification immediately, and can wake up a sleeping device.

service_sidstring nullable

The unique SID identifier of the Service.

sidstring nullable

A 34 character string that uniquely identifies this Notification.

ttlinteger nullable

How long, in seconds, the notification is valid. Max: 5 minutes