Skip to main content
POST
Create a push configuration

Authorizations

Authorization
string
header
required

Use your Authsignal Management API secret key as the username and leave the password empty. This key is different from the Server API key and can be found in the API Keys section of the Authsignal Portal settings page.

Body

application/json

Push configuration to create.

pushProvider
enum<string>
required

The push provider. DEFAULT requires Apple Push Notification service or Firebase Cloud Messaging credentials. FIREBASE requires Firebase Cloud Messaging credentials. WEBHOOK requires webhookUrl.

Available options:
DEFAULT,
FIREBASE,
WEBHOOK
isActive
boolean

Whether the authentication method is active. Defaults to true.

webhookUrl
string<uri>

The HTTPS endpoint used by a WEBHOOK provider.

Pattern: ^https://
credentialLifetimeInMinutes
integer

The credential lifetime for PUSH.

Required range: 0 <= x <= 525600
requireAppAttestation
boolean

Whether push operations require app attestation.

appAttestationFailureMode
enum<string>

How to handle failed app attestation for push operations.

Available options:
BLOCK,
ALLOW_WITH_WARNING
sendingRateLimitConfigurations
object[]

Message delivery limits. Every configured limit applies.

Required array length: 1 - 6 elements
apnsCredentials
object

Use with the DEFAULT push provider for Apple Push Notification service.

fcmCredentials
object

Use with the DEFAULT or FIREBASE push provider for Firebase Cloud Messaging.

Response

OK

authenticatorId
string
required
read-only

The immutable identifier for this configuration.

isActive
boolean
required
verificationMethod
string
required
read-only

The verification method produced by this configuration.

Allowed value: "PUSH"
pushProvider
enum<string>

The push provider. DEFAULT requires Apple Push Notification service or Firebase Cloud Messaging credentials. FIREBASE requires Firebase Cloud Messaging credentials. WEBHOOK requires webhookUrl.

Available options:
DEFAULT,
FIREBASE,
WEBHOOK
webhookUrl
string<uri>
credentialLifetimeInMinutes
integer
Required range: 0 <= x <= 525600
requireAppAttestation
boolean
appAttestationFailureMode
enum<string>
Available options:
BLOCK,
ALLOW_WITH_WARNING
sendingRateLimitConfigurations
object[]

Message delivery limits. Every configured limit applies.

Required array length: 1 - 6 elements
apnsCredentials
object

Use with the DEFAULT push provider for Apple Push Notification service.

fcmCredentials
object

Use with the DEFAULT or FIREBASE push provider for Firebase Cloud Messaging.