Skip to main content
PATCH
Update the 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 fields to update. Omitted fields are preserved. Send null for a clearable field to remove it. Credential objects are merged with stored credentials. When pushProvider changes, the new provider's credentials (or webhookUrl for WEBHOOK) are required unless already stored; restating the current provider needs none. Credentials and webhookUrl must belong to the selected (or stored) provider, and a request that leaves it without them is rejected.

isActive
boolean
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> | null
Pattern: ^https://
credentialLifetimeInMinutes
integer | null
Required range: 0 <= x <= 525600
requireAppAttestation
boolean
appAttestationFailureMode
enum<string>
Available options:
BLOCK,
ALLOW_WITH_WARNING
sendingRateLimitConfigurations
object[] | null

Message delivery limits. Every configured limit applies.

Required array length: 1 - 6 elements
apnsCredentials
object | null

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

fcmCredentials
object | null

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.