Skip to content

Update login methods

Request

Updates login methods of a specific application. Note: Fields that are objects cannot be partially updated, since the new value you set will just replace the current one.

Required permissions: apps:edit, *:edit, config:edit, authentication-methods:edit, [appId]:edit.

Security
ClientAccessToken
Path
appIdstringrequired

ID of the application to update auth methods for

Bodyapplication/jsonrequired
emailobject

Email magic link login configuration

email_otpobject

Email one time password login configuration

smsobject

SMS one time password login configuration

passwordobject

Password login configuration

totpobject

TOTP login configuration

pin_authenticatorobject

PIN authenticator login configuration

faceobject

Face authenticator login configuration

webauthn_apiobject

WebAuthn API login configuration

googleobject

Google login configuration

lineobject

Line login configuration

appleobject

Apple login configuration

facebookobject

Facebook login configuration

pushobject

Push login configuration

tiktokobject

Tiktok login configuration

curl -i -X PUT \
  'https://api.sbx.transmitsecurity.io/cis/loginPreferences/{appId}/authMethods' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "email": {
      "expiresIn": 0,
      "linksPerUser": 0,
      "message": {
        "primaryColor": "string",
        "from": "string",
        "subject": "string"
      }
    },
    "email_otp": {
      "expiresIn": 0,
      "lockoutDuration": 15,
      "maxFailures": 3,
      "codeLength": 6,
      "crossClientsAllowed": false,
      "message": {
        "primaryColor": "string",
        "from": "string",
        "subject": "string"
      }
    },
    "sms": {
      "expiresIn": 0,
      "lockoutDuration": 15,
      "maxFailures": 3,
      "codeLength": 6,
      "crossClientsAllowed": false
    },
    "password": {
      "failuresExpireIn": 15,
      "lockoutTiers": [
        {
          "attempts": 3,
          "duration": 15
        }
      ],
      "resetValidityMinutes": 5,
      "passwordComplexity": 5,
      "passwordMinLength": 14,
      "blockPreviousPasswords": 0,
      "checkHibp": false,
      "checkDictionary": false,
      "passwordExpiresIn": 90,
      "ignoreExpiration": false,
      "maxPasswordFailures": 5,
      "passwordSuspensionDuration": 15,
      "tempPasswordValidityHours": 24,
      "message": {
        "primaryColor": "string",
        "from": "string",
        "subject": "string"
      },
      "requireMFA": false,
      "codeLength": 6,
      "notifyOnPasswordUpdate": false
    },
    "totp": {
      "failuresExpireIn": 15,
      "lockoutTiers": [
        {
          "attempts": 3,
          "duration": 15
        }
      ],
      "algorithm": "sha1",
      "digits": 6,
      "period": 30,
      "window": 2,
      "issuer": "My Company",
      "maxFailures": 3,
      "lockoutDuration": 15,
      "maxTotpPerUser": 1
    },
    "pin_authenticator": {
      "failuresExpireIn": 15,
      "lockoutTiers": [
        {
          "attempts": 3,
          "duration": 15
        }
      ],
      "maxFailures": 3,
      "lockoutDuration": 15
    },
    "face": {
      "failuresExpireIn": 15,
      "lockoutTiers": [
        {
          "attempts": 3,
          "duration": 15
        }
      ],
      "maxFailures": 3,
      "lockoutDuration": 15,
      "saveImageEmbedding": true
    },
    "webauthn_api": {
      "failuresExpireIn": 15,
      "lockoutTiers": [
        {
          "attempts": 3,
          "duration": 15
        }
      ],
      "rpId": "string",
      "rpWebOrigins": [
        "string"
      ],
      "rpMobileOrigins": [
        "string"
      ],
      "replaceExistingPasskey": false,
      "maxFailures": 3,
      "lockoutDuration": 15,
      "allowSyncedPasskeys": true,
      "enforceAttestation": false,
      "attestationType": "none",
      "aaguidAllowList": [
        "string"
      ],
      "aaguidBlockList": [
        "string"
      ],
      "rpOrigin": "string",
      "rpOrigins": [
        "string"
      ]
    },
    "google": {
      "clientId": "string",
      "clientSecret": "string",
      "redirectUris": [
        "https://www.example.com/login"
      ]
    },
    "line": {
      "clientId": "string",
      "clientSecret": "string",
      "redirectUris": [
        "https://www.example.com/login"
      ]
    },
    "apple": {
      "clientId": "string",
      "clientSecret": "string",
      "redirectUris": [
        "https://www.example.com/login"
      ],
      "appleTeamId": "string",
      "keyId": "string"
    },
    "facebook": {
      "clientId": "string",
      "clientSecret": "string",
      "redirectUris": [
        "https://www.example.com/login"
      ]
    },
    "push": {
      "apn": {
        "key": "string",
        "keyId": "string",
        "teamId": "string",
        "bundle": "string",
        "isProduction": true
      },
      "fcm": {
        "key": {}
      }
    },
    "tiktok": {
      "clientId": "string",
      "clientSecret": "string",
      "redirectUris": [
        "https://www.example.com/login"
      ]
    }
  }'

Responses

Bodyapplication/json
resultobjectrequired
Response
{
  "result": {
    "auth_methods": { … }
  }
}