Class OrgSettingApi

java.lang.Object
com.okta.sdk.resource.api.OrgSettingApi

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", date="2024-03-29T16:47:02.065887-05:00[America/Chicago]", comments="Generator version: 7.4.0") public class OrgSettingApi extends Object
  • Constructor Details

    • OrgSettingApi

      public OrgSettingApi()
    • OrgSettingApi

      public OrgSettingApi(ApiClient apiClient)
  • Method Details

    • getApiClient

      public ApiClient getApiClient()
    • setApiClient

      public void setApiClient(ApiClient apiClient)
    • bulkRemoveEmailAddressBounces

      public BouncesRemoveListResult bulkRemoveEmailAddressBounces(BouncesRemoveListObj bouncesRemoveListObj) throws ApiException
      Remove Emails from Email Provider Bounce List Removes a list of email addresses to be removed from the set of email addresses that are bounced
      Parameters:
      bouncesRemoveListObj - (optional)
      Returns:
      BouncesRemoveListResult
      Throws:
      ApiException - if fails to make API call
    • bulkRemoveEmailAddressBounces

      public BouncesRemoveListResult bulkRemoveEmailAddressBounces(BouncesRemoveListObj bouncesRemoveListObj, Map<String,String> additionalHeaders) throws ApiException
      Remove Emails from Email Provider Bounce List Removes a list of email addresses to be removed from the set of email addresses that are bounced
      Parameters:
      bouncesRemoveListObj - (optional)
      additionalHeaders - additionalHeaders for this call
      Returns:
      BouncesRemoveListResult
      Throws:
      ApiException - if fails to make API call
    • extendOktaSupport

      public OrgOktaSupportSettingsObj extendOktaSupport() throws ApiException
      Extend Okta Support Access Extends the length of time that Okta Support can access your org by 24 hours. This means that 24 hours are added to the remaining access time.
      Returns:
      OrgOktaSupportSettingsObj
      Throws:
      ApiException - if fails to make API call
    • extendOktaSupport

      public OrgOktaSupportSettingsObj extendOktaSupport(Map<String,String> additionalHeaders) throws ApiException
      Extend Okta Support Access Extends the length of time that Okta Support can access your org by 24 hours. This means that 24 hours are added to the remaining access time.
      Parameters:
      additionalHeaders - additionalHeaders for this call
      Returns:
      OrgOktaSupportSettingsObj
      Throws:
      ApiException - if fails to make API call
    • getOktaCommunicationSettings

      public OrgOktaCommunicationSetting getOktaCommunicationSettings() throws ApiException
      Retrieve the Okta Communication Settings Retrieves Okta Communication Settings of your organization
      Returns:
      OrgOktaCommunicationSetting
      Throws:
      ApiException - if fails to make API call
    • getOktaCommunicationSettings

      public OrgOktaCommunicationSetting getOktaCommunicationSettings(Map<String,String> additionalHeaders) throws ApiException
      Retrieve the Okta Communication Settings Retrieves Okta Communication Settings of your organization
      Parameters:
      additionalHeaders - additionalHeaders for this call
      Returns:
      OrgOktaCommunicationSetting
      Throws:
      ApiException - if fails to make API call
    • getOrgContactTypes

      public List<OrgContactTypeObj> getOrgContactTypes() throws ApiException
      Retrieve the Org Contact Types Retrieves Contact Types of your organization
      Returns:
      List<OrgContactTypeObj>
      Throws:
      ApiException - if fails to make API call
    • getOrgContactTypes

      public List<OrgContactTypeObj> getOrgContactTypes(Map<String,String> additionalHeaders) throws ApiException
      Retrieve the Org Contact Types Retrieves Contact Types of your organization
      Parameters:
      additionalHeaders - additionalHeaders for this call
      Returns:
      List<OrgContactTypeObj>
      Throws:
      ApiException - if fails to make API call
    • getOrgContactUser

      public OrgContactUser getOrgContactUser(String contactType) throws ApiException
      Retrieve the User of the Contact Type Retrieves the URL of the User associated with the specified Contact Type
      Parameters:
      contactType - (required)
      Returns:
      OrgContactUser
      Throws:
      ApiException - if fails to make API call
    • getOrgContactUser

      public OrgContactUser getOrgContactUser(String contactType, Map<String,String> additionalHeaders) throws ApiException
      Retrieve the User of the Contact Type Retrieves the URL of the User associated with the specified Contact Type
      Parameters:
      contactType - (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      OrgContactUser
      Throws:
      ApiException - if fails to make API call
    • getOrgOktaSupportSettings

      public OrgOktaSupportSettingsObj getOrgOktaSupportSettings() throws ApiException
      Retrieve the Okta Support Settings Retrieves Okta Support Settings of your organization
      Returns:
      OrgOktaSupportSettingsObj
      Throws:
      ApiException - if fails to make API call
    • getOrgOktaSupportSettings

      public OrgOktaSupportSettingsObj getOrgOktaSupportSettings(Map<String,String> additionalHeaders) throws ApiException
      Retrieve the Okta Support Settings Retrieves Okta Support Settings of your organization
      Parameters:
      additionalHeaders - additionalHeaders for this call
      Returns:
      OrgOktaSupportSettingsObj
      Throws:
      ApiException - if fails to make API call
    • getOrgPreferences

      public OrgPreferences getOrgPreferences() throws ApiException
      Retrieve the Org Preferences Retrieves preferences of your organization
      Returns:
      OrgPreferences
      Throws:
      ApiException - if fails to make API call
    • getOrgPreferences

      public OrgPreferences getOrgPreferences(Map<String,String> additionalHeaders) throws ApiException
      Retrieve the Org Preferences Retrieves preferences of your organization
      Parameters:
      additionalHeaders - additionalHeaders for this call
      Returns:
      OrgPreferences
      Throws:
      ApiException - if fails to make API call
    • getOrgSettings

      public OrgSetting getOrgSettings() throws ApiException
      Retrieve the Org Settings Retrieves the org settings
      Returns:
      OrgSetting
      Throws:
      ApiException - if fails to make API call
    • getOrgSettings

      public OrgSetting getOrgSettings(Map<String,String> additionalHeaders) throws ApiException
      Retrieve the Org Settings Retrieves the org settings
      Parameters:
      additionalHeaders - additionalHeaders for this call
      Returns:
      OrgSetting
      Throws:
      ApiException - if fails to make API call
    • getWellknownOrgMetadata

      public WellKnownOrgMetadata getWellknownOrgMetadata() throws ApiException
      Retrieve the Well-Known Org Metadata Retrieves the well-known org metadata, which includes the id, configured custom domains, authentication pipeline, and various other org settings
      Returns:
      WellKnownOrgMetadata
      Throws:
      ApiException - if fails to make API call
    • getWellknownOrgMetadata

      public WellKnownOrgMetadata getWellknownOrgMetadata(Map<String,String> additionalHeaders) throws ApiException
      Retrieve the Well-Known Org Metadata Retrieves the well-known org metadata, which includes the id, configured custom domains, authentication pipeline, and various other org settings
      Parameters:
      additionalHeaders - additionalHeaders for this call
      Returns:
      WellKnownOrgMetadata
      Throws:
      ApiException - if fails to make API call
    • grantOktaSupport

      public OrgOktaSupportSettingsObj grantOktaSupport() throws ApiException
      Grant Okta Support Access to your Org Grants Okta Support temporary access your org as an administrator for eight hours
      Returns:
      OrgOktaSupportSettingsObj
      Throws:
      ApiException - if fails to make API call
    • grantOktaSupport

      public OrgOktaSupportSettingsObj grantOktaSupport(Map<String,String> additionalHeaders) throws ApiException
      Grant Okta Support Access to your Org Grants Okta Support temporary access your org as an administrator for eight hours
      Parameters:
      additionalHeaders - additionalHeaders for this call
      Returns:
      OrgOktaSupportSettingsObj
      Throws:
      ApiException - if fails to make API call
    • optInUsersToOktaCommunicationEmails

      public OrgOktaCommunicationSetting optInUsersToOktaCommunicationEmails() throws ApiException
      Opt in all Users to Okta Communication emails Opts in all users of this org to Okta Communication emails
      Returns:
      OrgOktaCommunicationSetting
      Throws:
      ApiException - if fails to make API call
    • optInUsersToOktaCommunicationEmails

      public OrgOktaCommunicationSetting optInUsersToOktaCommunicationEmails(Map<String,String> additionalHeaders) throws ApiException
      Opt in all Users to Okta Communication emails Opts in all users of this org to Okta Communication emails
      Parameters:
      additionalHeaders - additionalHeaders for this call
      Returns:
      OrgOktaCommunicationSetting
      Throws:
      ApiException - if fails to make API call
    • optOutUsersFromOktaCommunicationEmails

      public OrgOktaCommunicationSetting optOutUsersFromOktaCommunicationEmails() throws ApiException
      Opt out all Users from Okta Communication emails Opts out all users of this org from Okta Communication emails
      Returns:
      OrgOktaCommunicationSetting
      Throws:
      ApiException - if fails to make API call
    • optOutUsersFromOktaCommunicationEmails

      public OrgOktaCommunicationSetting optOutUsersFromOktaCommunicationEmails(Map<String,String> additionalHeaders) throws ApiException
      Opt out all Users from Okta Communication emails Opts out all users of this org from Okta Communication emails
      Parameters:
      additionalHeaders - additionalHeaders for this call
      Returns:
      OrgOktaCommunicationSetting
      Throws:
      ApiException - if fails to make API call
    • replaceOrgContactUser

      public OrgContactUser replaceOrgContactUser(String contactType, OrgContactUser orgContactUser) throws ApiException
      Replace the User of the Contact Type Replaces the User associated with the specified Contact Type
      Parameters:
      contactType - (required)
      orgContactUser - (required)
      Returns:
      OrgContactUser
      Throws:
      ApiException - if fails to make API call
    • replaceOrgContactUser

      public OrgContactUser replaceOrgContactUser(String contactType, OrgContactUser orgContactUser, Map<String,String> additionalHeaders) throws ApiException
      Replace the User of the Contact Type Replaces the User associated with the specified Contact Type
      Parameters:
      contactType - (required)
      orgContactUser - (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      OrgContactUser
      Throws:
      ApiException - if fails to make API call
    • replaceOrgSettings

      public OrgSetting replaceOrgSettings(OrgSetting orgSetting) throws ApiException
      Replace the Org Settings Replaces the settings of your organization
      Parameters:
      orgSetting - (required)
      Returns:
      OrgSetting
      Throws:
      ApiException - if fails to make API call
    • replaceOrgSettings

      public OrgSetting replaceOrgSettings(OrgSetting orgSetting, Map<String,String> additionalHeaders) throws ApiException
      Replace the Org Settings Replaces the settings of your organization
      Parameters:
      orgSetting - (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      OrgSetting
      Throws:
      ApiException - if fails to make API call
    • revokeOktaSupport

      public OrgOktaSupportSettingsObj revokeOktaSupport() throws ApiException
      Revoke Okta Support Access Revokes Okta Support access to your organization
      Returns:
      OrgOktaSupportSettingsObj
      Throws:
      ApiException - if fails to make API call
    • revokeOktaSupport

      public OrgOktaSupportSettingsObj revokeOktaSupport(Map<String,String> additionalHeaders) throws ApiException
      Revoke Okta Support Access Revokes Okta Support access to your organization
      Parameters:
      additionalHeaders - additionalHeaders for this call
      Returns:
      OrgOktaSupportSettingsObj
      Throws:
      ApiException - if fails to make API call
    • updateOrgHideOktaUIFooter

      public OrgPreferences updateOrgHideOktaUIFooter() throws ApiException
      Update the Preference to Hide the Okta Dashboard Footer Updates the preference hide the Okta UI footer for all end users of your organization
      Returns:
      OrgPreferences
      Throws:
      ApiException - if fails to make API call
    • updateOrgHideOktaUIFooter

      public OrgPreferences updateOrgHideOktaUIFooter(Map<String,String> additionalHeaders) throws ApiException
      Update the Preference to Hide the Okta Dashboard Footer Updates the preference hide the Okta UI footer for all end users of your organization
      Parameters:
      additionalHeaders - additionalHeaders for this call
      Returns:
      OrgPreferences
      Throws:
      ApiException - if fails to make API call
    • updateOrgSettings

      public OrgSetting updateOrgSettings(OrgSetting orgSetting) throws ApiException
      Update the Org Settings Partially updates the org settings depending on provided fields
      Parameters:
      orgSetting - (optional)
      Returns:
      OrgSetting
      Throws:
      ApiException - if fails to make API call
    • updateOrgSettings

      public OrgSetting updateOrgSettings(OrgSetting orgSetting, Map<String,String> additionalHeaders) throws ApiException
      Update the Org Settings Partially updates the org settings depending on provided fields
      Parameters:
      orgSetting - (optional)
      additionalHeaders - additionalHeaders for this call
      Returns:
      OrgSetting
      Throws:
      ApiException - if fails to make API call
    • updateOrgShowOktaUIFooter

      public OrgPreferences updateOrgShowOktaUIFooter() throws ApiException
      Update the Preference to Show the Okta Dashboard Footer Updates the preference to show the Okta UI footer for all end users of your organization
      Returns:
      OrgPreferences
      Throws:
      ApiException - if fails to make API call
    • updateOrgShowOktaUIFooter

      public OrgPreferences updateOrgShowOktaUIFooter(Map<String,String> additionalHeaders) throws ApiException
      Update the Preference to Show the Okta Dashboard Footer Updates the preference to show the Okta UI footer for all end users of your organization
      Parameters:
      additionalHeaders - additionalHeaders for this call
      Returns:
      OrgPreferences
      Throws:
      ApiException - if fails to make API call
    • uploadOrgLogo

      public void uploadOrgLogo(File _file) throws ApiException
      Upload the Org Logo Uploads and replaces the logo for your organization. The file must be in PNG, JPG, or GIF format and less than 100kB in size. For best results use landscape orientation, a transparent background, and a minimum size of 300px by 50px to prevent upscaling.
      Parameters:
      _file - (required)
      Throws:
      ApiException - if fails to make API call
    • uploadOrgLogo

      public void uploadOrgLogo(File _file, Map<String,String> additionalHeaders) throws ApiException
      Upload the Org Logo Uploads and replaces the logo for your organization. The file must be in PNG, JPG, or GIF format and less than 100kB in size. For best results use landscape orientation, a transparent background, and a minimum size of 300px by 50px to prevent upscaling.
      Parameters:
      _file - (required)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call
    • getObjectMapper

      protected static com.fasterxml.jackson.databind.ObjectMapper getObjectMapper()