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.

Using the GetEntrustSTAuthenticatorSettingsUsingGETWithHttpInfo variant​

This returns an ApiResponse object which contains the response data, status code and headers.

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​

Using the GetFaceAccountSettingsUsingGETWithHttpInfo variant​

This returns an ApiResponse object which contains the response data, status code and headers.

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​

Using the GetGeneralSettingsUsingGETWithHttpInfo variant​

This returns an ApiResponse object which contains the response data, status code and headers.

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​

Using the GetGoogleAuthenticatorSettingsUsingGETWithHttpInfo variant​

This returns an ApiResponse object which contains the response data, status code and headers.

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​

Using the GetOTPAuthenticatorSettingsUsingGETWithHttpInfo variant​

This returns an ApiResponse object which contains the response data, status code and headers.

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​

Using the GetPasswordResetSettingsUsingGETWithHttpInfo variant​

This returns an ApiResponse object which contains the response data, status code and headers.

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​

void SetFaceAccountSettingsUsingPUT (FaceAccountSettings faceAccountSettings)

Set Onfido account settings

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

Example​

Using the SetFaceAccountSettingsUsingPUTWithHttpInfo variant​

This returns an ApiResponse object which contains the response data, status code and headers.

Parameters​

NameTypeDescriptionNotes
faceAccountSettingsFaceAccountSettings

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-

UpdateEntrustSTAuthenticatorSettingsUsingPUT​

void UpdateEntrustSTAuthenticatorSettingsUsingPUT (EntrustSTAuthenticatorSettings entrustSTAuthenticatorSettings)

Update Entrust ST Authenticator settings

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

Example​

Using the UpdateEntrustSTAuthenticatorSettingsUsingPUTWithHttpInfo variant​

This returns an ApiResponse object which contains the response data, status code and headers.

Parameters​

NameTypeDescriptionNotes
entrustSTAuthenticatorSettingsEntrustSTAuthenticatorSettings

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-

UpdateGeneralSettingsUsingPUT​

void UpdateGeneralSettingsUsingPUT (GeneralSettings generalSettings)

Update general settings

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

Example​

Using the UpdateGeneralSettingsUsingPUTWithHttpInfo variant​

This returns an ApiResponse object which contains the response data, status code and headers.

Parameters​

NameTypeDescriptionNotes
generalSettingsGeneralSettings

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-

UpdateGoogleAuthenticatorSettingsUsingPUT​

void UpdateGoogleAuthenticatorSettingsUsingPUT (GoogleAuthenticatorSettings googleAuthenticatorSettings)

Update Google Authenticator settings

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

Example​

Using the UpdateGoogleAuthenticatorSettingsUsingPUTWithHttpInfo variant​

This returns an ApiResponse object which contains the response data, status code and headers.

Parameters​

NameTypeDescriptionNotes
googleAuthenticatorSettingsGoogleAuthenticatorSettings

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-

UpdateOTPAuthenticatorSettingsUsingPUT​

void UpdateOTPAuthenticatorSettingsUsingPUT (OTPAuthenticatorSettings oTPAuthenticatorSettings)

Update OTP authenticator settings

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

Example​

Using the UpdateOTPAuthenticatorSettingsUsingPUTWithHttpInfo variant​

This returns an ApiResponse object which contains the response data, status code and headers.

Parameters​

NameTypeDescriptionNotes
oTPAuthenticatorSettingsOTPAuthenticatorSettings

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-

UpdatePasswordResetSettingsUsingPUT​

void UpdatePasswordResetSettingsUsingPUT (PasswordResetSettings passwordResetSettings)

Update Password Reset settings

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

Example​

Using the UpdatePasswordResetSettingsUsingPUTWithHttpInfo variant​

This returns an ApiResponse object which contains the response data, status code and headers.

Parameters​

NameTypeDescriptionNotes
passwordResetSettingsPasswordResetSettings

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-