Login Preferences

Get login methods

Request

Retrieves all login methods for a specific application.

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

Security

ClientAccessToken

Path

appIdstringrequired

ID of the application whose login methods you want to retrieve

curl -i -X GET \
  'https://api.sbx.transmitsecurity.io/cis/loginPreferences/{appId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json

resultobjectrequired

result.auth_methodsobjectrequired

result.auth_methods.googleobject

result.auth_methods.facebookobject

result.auth_methods.emailobject

result.auth_methods.email_otpobject

result.auth_methods.appleobject

result.auth_methods.smsobject

result.auth_methods.webauthn_apiobject

result.auth_methods.lineobject

result.auth_methods.passwordobject

result.auth_methods.totpobject

result.auth_methods.pushobject

result.auth_methods.tiktokobject

result.auth_methods.pin_authenticatorobject

result.auth_methods.faceobject

Response

application/json

{
  "result": {
    "auth_methods": { … }
  }
}

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_otpobject

smsobject

passwordobject

totpobject

pin_authenticatorobject

faceobject

webauthn_apiobject

googleobject

lineobject

appleobject

facebookobject

pushobject

tiktokobject

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,
      "message": {
        "primaryColor": "string",
        "from": "string",
        "subject": "string"
      }
    },
    "sms": {
      "expiresIn": 0,
      "lockoutDuration": 15,
      "maxFailures": 3,
      "codeLength": 6
    },
    "password": {
      "resetValidityMinutes": 5,
      "passwordComplexity": 5,
      "passwordMinLength": 14,
      "blockPreviousPasswords": 0,
      "checkHibp": false,
      "checkDictionary": false,
      "passwordExpiresIn": 90,
      "ignoreExpiration": false,
      "maxPasswordFailures": 5,
      "passwordSuspensionDuration": 15,
      "failuresExpireIn": 15,
      "tempPasswordValidityHours": 24,
      "message": {
        "primaryColor": "string",
        "from": "string",
        "subject": "string"
      },
      "requireMFA": false,
      "codeLength": 6,
      "notifyOnPasswordUpdate": false
    },
    "totp": {
      "algorithm": "sha1",
      "digits": 6,
      "period": 30,
      "window": 2,
      "issuer": "My Company",
      "maxFailures": 3,
      "lockoutDuration": 15,
      "maxTotpPerUser": 1
    },
    "pin_authenticator": {
      "maxFailures": 3,
      "lockoutDuration": 15,
      "failuresExpireIn": 15
    },
    "face": {
      "maxFailures": 3,
      "lockoutDuration": 15,
      "failuresExpireIn": 15,
      "saveImageEmbedding": true
    },
    "webauthn_api": {
      "rpId": "string",
      "rpWebOrigins": [
        "string"
      ],
      "rpMobileOrigins": [
        "string"
      ],
      "replaceExistingPasskey": false,
      "maxFailures": 3,
      "lockoutDuration": 15,
      "failuresExpireIn": 15,
      "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": {
        "0": "string",
        "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

result.auth_methodsobjectrequired

result.auth_methods.googleobject

result.auth_methods.facebookobject

result.auth_methods.emailobject

result.auth_methods.email_otpobject

result.auth_methods.appleobject

result.auth_methods.smsobject

result.auth_methods.webauthn_apiobject

result.auth_methods.lineobject

result.auth_methods.passwordobject

result.auth_methods.totpobject

result.auth_methods.pushobject

result.auth_methods.tiktokobject

result.auth_methods.pin_authenticatorobject

result.auth_methods.faceobject

Response

application/json

{
  "result": {
    "auth_methods": { … }
  }
}

Create password dictionary

Request

Create a password dictionary for a specific application

Security

ClientAccessToken

Path

appIdstringrequired

Bodyapplication/jsonrequired

wordsArray of stringsrequired

List of forbidden words

curl -i -X POST \
  'https://api.sbx.transmitsecurity.io/cis/v1/applications/{appId}/password-dictionary' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "words": [
      "string"
    ]
  }'

Responses

Bodyapplication/json

resultobjectrequired

result.tenant_idstringrequired

Tenant ID

result.app_idstringrequired

Application ID

result.wordsArray of stringsrequired

List of forbidden words

Response

application/json

{
  "result": {
    "tenant_id": "string",
    "app_id": "string",
    "words": [ … ]
  }
}

Get password dictionary

Request

Get password dictionary for specified application

Security

ClientAccessToken

Path

appIdstringrequired

curl -i -X GET \
  'https://api.sbx.transmitsecurity.io/cis/v1/applications/{appId}/password-dictionary' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json

resultArray of objectsrequired

result[].tenant_idstringrequired

Tenant ID

result[].app_idstringrequired

Application ID

result[].wordsArray of stringsrequired

List of forbidden words

Response

application/json

{
  "result": [
    { … }
  ]
}

Add words to password dictionary

Request

Add words to password dictionary for a specific application

Security

ClientAccessToken

Path

appIdstringrequired

Bodyapplication/jsonrequired

wordsArray of stringsrequired

List of words

curl -i -X PUT \
  'https://api.sbx.transmitsecurity.io/cis/v1/applications/{appId}/password-dictionary/add' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "words": [
      "string"
    ]
  }'

Responses

Bodyapplication/json

resultobjectrequired

result.tenant_idstringrequired

Tenant ID

result.app_idstringrequired

Application ID

result.wordsArray of stringsrequired

List of forbidden words

Response

application/json

{
  "result": {
    "tenant_id": "string",
    "app_id": "string",
    "words": [ … ]
  }
}

Remove words from password dictionary

Request

Remove words from password dictionary for a specific application

Security

ClientAccessToken

Path

appIdstringrequired

Bodyapplication/jsonrequired

wordsArray of stringsrequired

List of words

curl -i -X PUT \
  'https://api.sbx.transmitsecurity.io/cis/v1/applications/{appId}/password-dictionary/remove' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "words": [
      "string"
    ]
  }'

Responses

Bodyapplication/json

resultobjectrequired

result.tenant_idstringrequired

Tenant ID

result.app_idstringrequired

Application ID

result.wordsArray of stringsrequired

List of forbidden words

Response

application/json

{
  "result": {
    "tenant_id": "string",
    "app_id": "string",
    "words": [ … ]
  }
}

Login Preferences

Get login methods

Request

Responses

Update login methods

RequestExpand all

Responses

Create password dictionary

Request

Responses

Get password dictionary

Request

Responses

Add words to password dictionary

Request

Responses

Remove words from password dictionary

Request

Responses

Request