SettingsApi
| Method | HTTP request | Description |
|---|---|---|
| getEntrustSTAuthenticatorSettingsUsingGET | GET /api/web/v1/settings/entrustst | Get Entrust ST Authenticator settings |
| getGeneralSettingsUsingGET | GET /api/web/v1/settings/general | Get general settings |
| getGoogleAuthenticatorSettingsUsingGET | GET /api/web/v1/settings/google | Get Google Authenticator settings |
| getOTPAuthenticatorSettingsUsingGET | GET /api/web/v3/settings/otp | Get OTP authenticator settings |
| getPasswordResetSettingsUsingGET | GET /api/web/v1/settings/passwordreset | Get Password Reset settings |
| updateEntrustSTAuthenticatorSettingsUsingPUT | PUT /api/web/v1/settings/entrustst | Update Entrust ST Authenticator settings |
| updateGeneralSettingsUsingPUT | PUT /api/web/v1/settings/general | Update general settings |
| updateGoogleAuthenticatorSettingsUsingPUT | PUT /api/web/v1/settings/google | Update Google Authenticator settings |
| updateOTPAuthenticatorSettingsUsingPUT | PUT /api/web/v3/settings/otp | Update OTP authenticator settings |
| updatePasswordResetSettingsUsingPUT | PUT /api/web/v1/settings/passwordreset | Update 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
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
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
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
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
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
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
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
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
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
updateEntrustSTAuthenticatorSettingsUsingPUT
updateEntrustSTAuthenticatorSettingsUsingPUT(entrustSTAuthenticatorSettings)
Update Entrust ST Authenticator settings
Update Entrust ST Authenticator settings. Caller requires the SETTINGS:EDIT permission.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| entrustSTAuthenticatorSettings | EntrustSTAuthenticatorSettings |
Return type
null (empty response body)
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
updateGeneralSettingsUsingPUT
updateGeneralSettingsUsingPUT(generalSettings)
Update general settings
Update general settings. Caller requires the SETTINGS:EDIT permission.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| generalSettings | GeneralSettings |
Return type
null (empty response body)
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
updateGoogleAuthenticatorSettingsUsingPUT
updateGoogleAuthenticatorSettingsUsingPUT(googleAuthenticatorSettings)
Update Google Authenticator settings
Update Google Authenticator settings. Caller requires the SETTINGS:EDIT permission.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| googleAuthenticatorSettings | GoogleAuthenticatorSettings |
Return type
null (empty response body)
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
updateOTPAuthenticatorSettingsUsingPUT
updateOTPAuthenticatorSettingsUsingPUT(otPAuthenticatorSettings)
Update OTP authenticator settings
Update OTP authenticator settings. Caller requires the SETTINGS:EDIT permission.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| otPAuthenticatorSettings | OTPAuthenticatorSettings |
Return type
null (empty response body)
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
updatePasswordResetSettingsUsingPUT
updatePasswordResetSettingsUsingPUT(passwordResetSettings)
Update Password Reset settings
Update the password reset settings. Caller requires the SETTINGS:EDIT permission.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| passwordResetSettings | PasswordResetSettings |
Return type
null (empty response body)
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |