Skip to main content

SettingsApi

MethodHTTP requestDescription
get_entrust_st_authenticator_settings_using_getGET /api/web/v1/settings/entruststGet Entrust ST Authenticator settings
get_face_account_settings_using_getGET /api/web/v1/settings/face/accountGet Onfido account settings
get_fido_settings_using_getGET /api/web/v1/settings/fidoGet FIDO settings
get_general_settings_using_getGET /api/web/v1/settings/generalGet general settings
get_google_authenticator_settings_using_getGET /api/web/v1/settings/googleGet Google Authenticator settings
get_otp_authenticator_settings_using_getGET /api/web/v3/settings/otpGet OTP authenticator settings
get_password_reset_settings_using_getGET /api/web/v1/settings/passwordresetGet Password Reset settings
set_face_account_settings_using_putPUT /api/web/v1/settings/face/accountSet Onfido account settings
update_entrust_st_authenticator_settings_using_putPUT /api/web/v1/settings/entruststUpdate Entrust ST Authenticator settings
update_fido_settings_using_putPUT /api/web/v1/settings/fidoUpdate FIDO settings
update_general_settings_using_putPUT /api/web/v1/settings/generalUpdate general settings
update_google_authenticator_settings_using_putPUT /api/web/v1/settings/googleUpdate Google Authenticator settings
update_otp_authenticator_settings_using_putPUT /api/web/v3/settings/otpUpdate OTP authenticator settings
update_password_reset_settings_using_putPUT /api/web/v1/settings/passwordresetUpdate Password Reset settings

get_entrust_st_authenticator_settings_using_get​

EntrustSTAuthenticatorSettings get_entrust_st_authenticator_settings_using_get()

Get Entrust ST Authenticator settings

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

  • Api Key Authentication (AdminAPIAuthentication):

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-

get_face_account_settings_using_get​

FaceAccountSettings get_face_account_settings_using_get()

Get Onfido account settings

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

Example​

  • Api Key Authentication (AdminAPIAuthentication):

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-

get_fido_settings_using_get​

FIDOAuthenticatorSettings get_fido_settings_using_get()

Get FIDO settings

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

Example​

  • Api Key Authentication (AdminAPIAuthentication):

Parameters​

This endpoint does not need any parameter.

Return type​

FIDOAuthenticatorSettings

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-

get_general_settings_using_get​

GeneralSettings get_general_settings_using_get()

Get general settings

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

Example​

  • Api Key Authentication (AdminAPIAuthentication):

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-

get_google_authenticator_settings_using_get​

GoogleAuthenticatorSettings get_google_authenticator_settings_using_get()

Get Google Authenticator settings

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

Example​

  • Api Key Authentication (AdminAPIAuthentication):

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-

get_otp_authenticator_settings_using_get​

OTPAuthenticatorSettings get_otp_authenticator_settings_using_get()

Get OTP authenticator settings

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

Example​

  • Api Key Authentication (AdminAPIAuthentication):

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-

get_password_reset_settings_using_get​

PasswordResetSettings get_password_reset_settings_using_get()

Get Password Reset settings

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

Example​

  • Api Key Authentication (AdminAPIAuthentication):

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-

set_face_account_settings_using_put​

set_face_account_settings_using_put(face_account_settings)

Set Onfido account settings

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

Example​

  • Api Key Authentication (AdminAPIAuthentication):

Parameters​

NameTypeDescriptionNotes
face_account_settingsFaceAccountSettings

Return type​

void (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-

update_entrust_st_authenticator_settings_using_put​

update_entrust_st_authenticator_settings_using_put(entrust_st_authenticator_settings)

Update Entrust ST Authenticator settings

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

Example​

  • Api Key Authentication (AdminAPIAuthentication):

Parameters​

NameTypeDescriptionNotes
entrust_st_authenticator_settingsEntrustSTAuthenticatorSettings

Return type​

void (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-

update_fido_settings_using_put​

update_fido_settings_using_put(fido_authenticator_settings_parms)

Update FIDO settings

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

Example​

  • Api Key Authentication (AdminAPIAuthentication):

Parameters​

NameTypeDescriptionNotes
fido_authenticator_settings_parmsFIDOAuthenticatorSettingsParms

Return type​

void (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-

update_general_settings_using_put​

update_general_settings_using_put(general_settings)

Update general settings

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

Example​

  • Api Key Authentication (AdminAPIAuthentication):

Parameters​

NameTypeDescriptionNotes
general_settingsGeneralSettings

Return type​

void (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-

update_google_authenticator_settings_using_put​

update_google_authenticator_settings_using_put(google_authenticator_settings)

Update Google Authenticator settings

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

Example​

  • Api Key Authentication (AdminAPIAuthentication):

Parameters​

NameTypeDescriptionNotes
google_authenticator_settingsGoogleAuthenticatorSettings

Return type​

void (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-

update_otp_authenticator_settings_using_put​

update_otp_authenticator_settings_using_put(otp_authenticator_settings)

Update OTP authenticator settings

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

Example​

  • Api Key Authentication (AdminAPIAuthentication):

Parameters​

NameTypeDescriptionNotes
otp_authenticator_settingsOTPAuthenticatorSettings

Return type​

void (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-

update_password_reset_settings_using_put​

update_password_reset_settings_using_put(password_reset_settings)

Update Password Reset settings

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

Example​

  • Api Key Authentication (AdminAPIAuthentication):

Parameters​

NameTypeDescriptionNotes
password_reset_settingsPasswordResetSettings

Return type​

void (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-