Create MFA

Scopes
write:mfa

Request Body

enabled
boolean
Zorunlu
provider
string
Zorunlu

Mevcut Değerler: 

type
string
Zorunlu

Mevcut Değerler: 

is_custom
boolean

Is connection using custom scripts

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

Push notification strategy

Mevcut Değerler: codeprompt

Varsayılan Değer: "code"

settings.
apns
object

Apple Push Notification Service configuration settings.

settings.apns.
bundle_id
string
Zorunlu

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
Zorunlu

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
Zorunlu

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
Zorunlu

Varsayılan Değer: true

settings.apns.
team_id
string
Zorunlu

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
Zorunlu

client_email field located in your service account json

settings.fcm.
private_key
string
Zorunlu

private_key field located in your service account json

settings.fcm.
project_id
string
Zorunlu

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
Zorunlu
provider
string
Zorunlu

Value: native

type
string
Zorunlu

Value: push

is_custom
boolean

Is connection using custom scripts

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

Push notification strategy

Mevcut Değerler: codeprompt

Varsayılan Değer: "code"

settings.
apns
object

Apple Push Notification Service configuration settings.

settings.apns.
bundle_id
string
Zorunlu

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
Zorunlu

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
Zorunlu

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
Zorunlu

Varsayılan Değer: true

settings.apns.
team_id
string
Zorunlu

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
Zorunlu

client_email field located in your service account json

settings.fcm.
private_key
string
Zorunlu

private_key field located in your service account json

settings.fcm.
project_id
string
Zorunlu

project_id field located in your service account json