Developers

Create MFA

Scopes
write:mfa

Request Body

enabled
boolean
Required
provider
string
Required

Available Values: 

type
string
Required

Available Values: 

is_custom
boolean

Is connection using custom scripts

settings
object
Required
settings.
enabled_clients
array<string>
Required
settings.
strategy
string

Push notification strategy

Available Values: codeprompt

Default Value: "code"

settings.
apns
object

Apple Push Notification Service configuration settings.

settings.apns.
bundle_id
string
Required

This is the ID of your app. You can find it in the app info section of your Apple developer account.

settings.apns.
key
string
Required

p8 of your Apple Developer account. To generate one follow these steps:

  • Head over to Certificates, Identifiers & Profiles > Keys.
  • Register a new key and give it a name.
  • Enable the Apple Push Notifications service (APNs) checkbox by selecting it.
  • Click the Continue button and on the next page, select Register.
  • Download the .p8 key file.
settings.apns.
key_id
string
Required

This is a 10-character unique identifier for the authentication key. You can find it in the key details section of the newly created key in your Apple developer account.

settings.apns.
production
boolean
Required

Default Value: true

settings.apns.
team_id
string
Required

This is available in your Apple developer account.

settings.
fcm
object

Firebase Cloud Messaging configuration settings. To enable the FCM integration, you need to get your service account key from the Firebase Console.

  • Select your project, and click the gear icon on the top of the sidebar.
  • After opening "Project Settings", head to the "Service Accounts" tab.
  • Click "Generate new private key", then confirm by clicking "Generate key".
  • Clicking "Generate key" downloads the generated service account json file.
settings.fcm.
client_email
string
Required

client_email field located in your service account json

settings.fcm.
private_key
string
Required

private_key field located in your service account json

settings.fcm.
project_id
string
Required

project_id field located in your service account json

POST
/mfa
1
2
3
4
5
Loading...
Response:
201
Loading...

Response Body Schema

enabled
boolean
Required
provider
string
Required

Value: native

type
string
Required

Value: push

is_custom
boolean

Is connection using custom scripts

settings
object
Required
settings.
enabled_clients
array<string>
Required
settings.
strategy
string

Push notification strategy

Available Values: codeprompt

Default Value: "code"

settings.
apns
object

Apple Push Notification Service configuration settings.

settings.apns.
bundle_id
string
Required

This is the ID of your app. You can find it in the app info section of your Apple developer account.

settings.apns.
key
string
Required

p8 of your Apple Developer account. To generate one follow these steps:

  • Head over to Certificates, Identifiers & Profiles > Keys.
  • Register a new key and give it a name.
  • Enable the Apple Push Notifications service (APNs) checkbox by selecting it.
  • Click the Continue button and on the next page, select Register.
  • Download the .p8 key file.
settings.apns.
key_id
string
Required

This is a 10-character unique identifier for the authentication key. You can find it in the key details section of the newly created key in your Apple developer account.

settings.apns.
production
boolean
Required

Default Value: true

settings.apns.
team_id
string
Required

This is available in your Apple developer account.

settings.
fcm
object

Firebase Cloud Messaging configuration settings. To enable the FCM integration, you need to get your service account key from the Firebase Console.

  • Select your project, and click the gear icon on the top of the sidebar.
  • After opening "Project Settings", head to the "Service Accounts" tab.
  • Click "Generate new private key", then confirm by clicking "Generate key".
  • Clicking "Generate key" downloads the generated service account json file.
settings.fcm.
client_email
string
Required

client_email field located in your service account json

settings.fcm.
private_key
string
Required

private_key field located in your service account json

settings.fcm.
project_id
string
Required

project_id field located in your service account json