Skip to main content

SettingsApi

MethodHTTP requestDescription
getEntrustSTAuthenticatorSettingsUsingGETGET /api/web/v1/settings/entruststGet Entrust ST Authenticator settings
getFaceAccountSettingsUsingGETGET /api/web/v1/settings/face/accountGet Onfido account settings
getGeneralSettingsUsingGETGET /api/web/v1/settings/generalGet general settings
getGoogleAuthenticatorSettingsUsingGETGET /api/web/v1/settings/googleGet Google Authenticator settings
getOTPAuthenticatorSettingsUsingGETGET /api/web/v3/settings/otpGet OTP authenticator settings
getPasswordResetSettingsUsingGETGET /api/web/v1/settings/passwordresetGet Password Reset settings
setFaceAccountSettingsUsingPUTPUT /api/web/v1/settings/face/accountSet Onfido account settings
updateEntrustSTAuthenticatorSettingsUsingPUTPUT /api/web/v1/settings/entruststUpdate Entrust ST Authenticator settings
updateGeneralSettingsUsingPUTPUT /api/web/v1/settings/generalUpdate general settings
updateGoogleAuthenticatorSettingsUsingPUTPUT /api/web/v1/settings/googleUpdate Google Authenticator settings
updateOTPAuthenticatorSettingsUsingPUTPUT /api/web/v3/settings/otpUpdate OTP authenticator settings
updatePasswordResetSettingsUsingPUTPUT /api/web/v1/settings/passwordresetUpdate Password Reset settings

getEntrustSTAuthenticatorSettingsUsingGET​

EntrustSTAuthenticatorSettings getEntrustSTAuthenticatorSettingsUsingGET()

Get Entrust ST Authenticator settings

Get Entrust ST Authenticator settings. Caller requires the SETTINGS:VIEW permission.

Parameters​

This endpoint does not need any parameter.

Return type​

EntrustSTAuthenticatorSettings

Authorization​

AdminAPIAuthentication

HTTP request headers​

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details​

Status codeDescriptionResponse headers
200Successful-
400Bad Request-
401Access denied-
403Forbidden-
404Not Found-
409Conflict-

getFaceAccountSettingsUsingGET​

FaceAccountSettings getFaceAccountSettingsUsingGET()

Get Onfido account settings

Gets the Onfido account settings used by the Face Biometric. Caller requires the SETTINGS:VIEW permission.

Example​

Parameters​

This endpoint does not need any parameter.

Return type​

FaceAccountSettings

Authorization​

AdminAPIAuthentication

HTTP request headers​

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details​

Status codeDescriptionResponse headers
200Successful-
400Bad Request-
401Access denied-
403Forbidden-
404Not Found-
409Conflict-

getGeneralSettingsUsingGET​

GeneralSettings getGeneralSettingsUsingGET()

Get general settings

Get general settings. Caller requires the SETTINGS:VIEW permission.

Example​

Parameters​

This endpoint does not need any parameter.

Return type​

GeneralSettings

Authorization​

AdminAPIAuthentication

HTTP request headers​

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details​

Status codeDescriptionResponse headers
200Successful-
400Bad Request-
401Access denied-
403Forbidden-
404Not Found-
409Conflict-

getGoogleAuthenticatorSettingsUsingGET​

GoogleAuthenticatorSettings getGoogleAuthenticatorSettingsUsingGET()

Get Google Authenticator settings

Get Google Authenticator settings. Caller requires the SETTINGS:VIEW permission.

Example​

Parameters​

This endpoint does not need any parameter.

Return type​

GoogleAuthenticatorSettings

Authorization​

AdminAPIAuthentication

HTTP request headers​

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details​

Status codeDescriptionResponse headers
200Successful-
400Bad Request-
401Access denied-
403Forbidden-
404Not Found-
409Conflict-

getOTPAuthenticatorSettingsUsingGET​

OTPAuthenticatorSettings getOTPAuthenticatorSettingsUsingGET()

Get OTP authenticator settings

Get OTP authenticator settings. Caller requires the SETTINGS:VIEW permission.

Example​

Parameters​

This endpoint does not need any parameter.

Return type​

OTPAuthenticatorSettings

Authorization​

AdminAPIAuthentication

HTTP request headers​

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details​

Status codeDescriptionResponse headers
200Successful-
400Bad Request-
401Access denied-
403Forbidden-
404Not Found-
409Conflict-

getPasswordResetSettingsUsingGET​

PasswordResetSettings getPasswordResetSettingsUsingGET()

Get Password Reset settings

Get the password reset settings. Caller requires the SETTINGS:VIEW permission.

Example​

Parameters​

This endpoint does not need any parameter.

Return type​

PasswordResetSettings

Authorization​

AdminAPIAuthentication

HTTP request headers​

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details​

Status codeDescriptionResponse headers
200Successful-
400Bad Request-
401Access denied-
403Forbidden-
404Not Found-
409Conflict-

setFaceAccountSettingsUsingPUT​

setFaceAccountSettingsUsingPUT(faceAccountSettings)

Set Onfido account settings

Sets the Onfido account settings used by the Face Biometric. Caller requires the SETTINGS:EDIT permission.

Example​

Parameters​

NameTypeDescriptionNotes
faceAccountSettingsFaceAccountSettings

Return type​

null (empty response body)

Authorization​

AdminAPIAuthentication

HTTP request headers​

  • Content-Type: application/json
  • Accept: application/json

HTTP response details​

Status codeDescriptionResponse headers
200Successful-
400Bad Request-
401Access denied-
403Forbidden-
404Not Found-
409Conflict-

updateEntrustSTAuthenticatorSettingsUsingPUT​

updateEntrustSTAuthenticatorSettingsUsingPUT(entrustSTAuthenticatorSettings)

Update Entrust ST Authenticator settings

Update Entrust ST Authenticator settings. Caller requires the SETTINGS:EDIT permission.

Example​

Parameters​

NameTypeDescriptionNotes
entrustSTAuthenticatorSettingsEntrustSTAuthenticatorSettings

Return type​

null (empty response body)

Authorization​

AdminAPIAuthentication

HTTP request headers​

  • Content-Type: application/json
  • Accept: application/json

HTTP response details​

Status codeDescriptionResponse headers
200Successful-
400Bad Request-
401Access denied-
403Forbidden-
404Not Found-
409Conflict-

updateGeneralSettingsUsingPUT​

updateGeneralSettingsUsingPUT(generalSettings)

Update general settings

Update general settings. Caller requires the SETTINGS:EDIT permission.

Example​

Parameters​

NameTypeDescriptionNotes
generalSettingsGeneralSettings

Return type​

null (empty response body)

Authorization​

AdminAPIAuthentication

HTTP request headers​

  • Content-Type: application/json
  • Accept: application/json

HTTP response details​

Status codeDescriptionResponse headers
200Successful-
400Bad Request-
401Access denied-
403Forbidden-
404Not Found-
409Conflict-

updateGoogleAuthenticatorSettingsUsingPUT​

updateGoogleAuthenticatorSettingsUsingPUT(googleAuthenticatorSettings)

Update Google Authenticator settings

Update Google Authenticator settings. Caller requires the SETTINGS:EDIT permission.

Example​

Parameters​

NameTypeDescriptionNotes
googleAuthenticatorSettingsGoogleAuthenticatorSettings

Return type​

null (empty response body)

Authorization​

AdminAPIAuthentication

HTTP request headers​

  • Content-Type: application/json
  • Accept: application/json

HTTP response details​

Status codeDescriptionResponse headers
200Successful-
400Bad Request-
401Access denied-
403Forbidden-
404Not Found-
409Conflict-

updateOTPAuthenticatorSettingsUsingPUT​

updateOTPAuthenticatorSettingsUsingPUT(otPAuthenticatorSettings)

Update OTP authenticator settings

Update OTP authenticator settings. Caller requires the SETTINGS:EDIT permission.

Example​

Parameters​

NameTypeDescriptionNotes
otPAuthenticatorSettingsOTPAuthenticatorSettings

Return type​

null (empty response body)

Authorization​

AdminAPIAuthentication

HTTP request headers​

  • Content-Type: application/json
  • Accept: application/json

HTTP response details​

Status codeDescriptionResponse headers
200Successful-
400Bad Request-
401Access denied-
403Forbidden-
404Not Found-
409Conflict-

updatePasswordResetSettingsUsingPUT​

updatePasswordResetSettingsUsingPUT(passwordResetSettings)

Update Password Reset settings

Update the password reset settings. Caller requires the SETTINGS:EDIT permission.

Example​

Parameters​

NameTypeDescriptionNotes
passwordResetSettingsPasswordResetSettings

Return type​

null (empty response body)

Authorization​

AdminAPIAuthentication

HTTP request headers​

  • Content-Type: application/json
  • Accept: application/json

HTTP response details​

Status codeDescriptionResponse headers
200Successful-
400Bad Request-
401Access denied-
403Forbidden-
404Not Found-
409Conflict-