Package com.okta.sdk.resource.api
Class OrgSettingApi
java.lang.Object
com.okta.sdk.resource.api.OrgSettingApi
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
date="2024-08-09T14:19:33.269913-05:00[America/Chicago]",
comments="Generator version: 7.7.0")
public class OrgSettingApi
extends Object
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionassignClientPrivilegesSetting
(ClientPrivilegesSetting clientPrivilegesSetting) Assign the Super Admin role to a public client app Assigns the [Super Admin role](https://help.okta.com/okta_help.htm?type=oie&id=ext_superadmin) by default to a public client appassignClientPrivilegesSetting
(ClientPrivilegesSetting clientPrivilegesSetting, Map<String, String> additionalHeaders) Assign the Super Admin role to a public client app Assigns the [Super Admin role](https://help.okta.com/okta_help.htm?type=oie&id=ext_superadmin) by default to a public client appbulkRemoveEmailAddressBounces
(BouncesRemoveListObj bouncesRemoveListObj) Remove Emails from Email Provider Bounce List Removes a list of email addresses to be removed from the set of email addresses that are bouncedbulkRemoveEmailAddressBounces
(BouncesRemoveListObj bouncesRemoveListObj, Map<String, String> additionalHeaders) Remove Emails from Email Provider Bounce List Removes a list of email addresses to be removed from the set of email addresses that are bouncedExtend Okta Support Access Extends the length of time that Okta Support can access your org by 24 hours.extendOktaSupport
(Map<String, String> additionalHeaders) Extend Okta Support Access Extends the length of time that Okta Support can access your org by 24 hours.Retrieve the Org settings to assign the Super Admin role Retrieves the Org settings to assign the [Super Admin role](https://help.okta.com/okta_help.htm?type=oie&id=ext_superadmin) by default to a public client appgetClientPrivilegesSetting
(Map<String, String> additionalHeaders) Retrieve the Org settings to assign the Super Admin role Retrieves the Org settings to assign the [Super Admin role](https://help.okta.com/okta_help.htm?type=oie&id=ext_superadmin) by default to a public client appprotected static com.fasterxml.jackson.databind.ObjectMapper
Retrieve the Okta Communication Settings Retrieves Okta Communication Settings of your organizationgetOktaCommunicationSettings
(Map<String, String> additionalHeaders) Retrieve the Okta Communication Settings Retrieves Okta Communication Settings of your organizationRetrieve the Org Contact Types Retrieves Contact Types of your organizationgetOrgContactTypes
(Map<String, String> additionalHeaders) Retrieve the Org Contact Types Retrieves Contact Types of your organizationgetOrgContactUser
(String contactType) Retrieve the User of the Contact Type Retrieves the URL of the User associated with the specified Contact TypegetOrgContactUser
(String contactType, Map<String, String> additionalHeaders) Retrieve the User of the Contact Type Retrieves the URL of the User associated with the specified Contact TypeRetrieve the Okta Support Settings Retrieves Okta Support Settings of your organizationgetOrgOktaSupportSettings
(Map<String, String> additionalHeaders) Retrieve the Okta Support Settings Retrieves Okta Support Settings of your organizationRetrieve the Org Preferences Retrieves preferences of your organizationgetOrgPreferences
(Map<String, String> additionalHeaders) Retrieve the Org Preferences Retrieves preferences of your organizationRetrieve the Org Settings Retrieves the org settingsgetOrgSettings
(Map<String, String> additionalHeaders) Retrieve the Org Settings Retrieves the org settingsRetrieve the Org Third-Party Admin setting Retrieves the Third-Party Admin settinggetThirdPartyAdminSetting
(Map<String, String> additionalHeaders) Retrieve the Org Third-Party Admin setting Retrieves the Third-Party Admin settingRetrieve the Well-Known Org Metadata Retrieves the well-known org metadata, which includes the id, configured custom domains, authentication pipeline, and various other org settingsgetWellknownOrgMetadata
(Map<String, String> additionalHeaders) 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 settingsGrant Okta Support Access to your Org Grants Okta Support temporary access your org as an administrator for eight hoursgrantOktaSupport
(Map<String, String> additionalHeaders) Grant Okta Support Access to your Org Grants Okta Support temporary access your org as an administrator for eight hoursOpt in all Users to Okta Communication emails Opts in all users of this org to Okta Communication emailsoptInUsersToOktaCommunicationEmails
(Map<String, String> additionalHeaders) Opt in all Users to Okta Communication emails Opts in all users of this org to Okta Communication emailsOpt out all Users from Okta Communication emails Opts out all users of this org from Okta Communication emailsoptOutUsersFromOktaCommunicationEmails
(Map<String, String> additionalHeaders) Opt out all Users from Okta Communication emails Opts out all users of this org from Okta Communication emailsreplaceOrgContactUser
(String contactType, OrgContactUser orgContactUser) Replace the User of the Contact Type Replaces the User associated with the specified Contact TypereplaceOrgContactUser
(String contactType, OrgContactUser orgContactUser, Map<String, String> additionalHeaders) Replace the User of the Contact Type Replaces the User associated with the specified Contact TypereplaceOrgSettings
(OrgSetting orgSetting) Replace the Org Settings Replaces the settings of your organizationreplaceOrgSettings
(OrgSetting orgSetting, Map<String, String> additionalHeaders) Replace the Org Settings Replaces the settings of your organizationRevoke Okta Support Access Revokes Okta Support access to your organizationrevokeOktaSupport
(Map<String, String> additionalHeaders) Revoke Okta Support Access Revokes Okta Support access to your organizationvoid
setApiClient
(ApiClient apiClient) Update the Preference to Hide the Okta Dashboard Footer Updates the preference hide the Okta UI footer for all end users of your organizationupdateOrgHideOktaUIFooter
(Map<String, String> additionalHeaders) Update the Preference to Hide the Okta Dashboard Footer Updates the preference hide the Okta UI footer for all end users of your organizationupdateOrgSettings
(OrgSetting orgSetting) Update the Org Settings Partially updates the org settings depending on provided fieldsupdateOrgSettings
(OrgSetting orgSetting, Map<String, String> additionalHeaders) Update the Org Settings Partially updates the org settings depending on provided fieldsUpdate the Preference to Show the Okta Dashboard Footer Updates the preference to show the Okta UI footer for all end users of your organizationupdateOrgShowOktaUIFooter
(Map<String, String> additionalHeaders) Update the Preference to Show the Okta Dashboard Footer Updates the preference to show the Okta UI footer for all end users of your organizationUpdate the Org Third-Party Admin setting Updates the Third-Party Admin settingupdateThirdPartyAdminSetting
(Map<String, String> additionalHeaders) Update the Org Third-Party Admin setting Updates the Third-Party Admin settingvoid
uploadOrgLogo
(File _file) Upload the Org Logo Uploads and replaces the logo for your organization.void
uploadOrgLogo
(File _file, Map<String, String> additionalHeaders) Upload the Org Logo Uploads and replaces the logo for your organization.
-
Constructor Details
-
OrgSettingApi
public OrgSettingApi() -
OrgSettingApi
-
-
Method Details
-
getApiClient
-
setApiClient
-
assignClientPrivilegesSetting
public ClientPrivilegesSetting assignClientPrivilegesSetting(ClientPrivilegesSetting clientPrivilegesSetting) throws ApiException Assign the Super Admin role to a public client app Assigns the [Super Admin role](https://help.okta.com/okta_help.htm?type=oie&id=ext_superadmin) by default to a public client app- Parameters:
clientPrivilegesSetting
- (optional)- Returns:
- ClientPrivilegesSetting
- Throws:
ApiException
- if fails to make API call
-
assignClientPrivilegesSetting
public ClientPrivilegesSetting assignClientPrivilegesSetting(ClientPrivilegesSetting clientPrivilegesSetting, Map<String, String> additionalHeaders) throws ApiExceptionAssign the Super Admin role to a public client app Assigns the [Super Admin role](https://help.okta.com/okta_help.htm?type=oie&id=ext_superadmin) by default to a public client app- Parameters:
clientPrivilegesSetting
- (optional)additionalHeaders
- additionalHeaders for this call- Returns:
- ClientPrivilegesSetting
- Throws:
ApiException
- if fails to make API call
-
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 ApiExceptionRemove 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
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 ApiExceptionExtend 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
-
getClientPrivilegesSetting
Retrieve the Org settings to assign the Super Admin role Retrieves the Org settings to assign the [Super Admin role](https://help.okta.com/okta_help.htm?type=oie&id=ext_superadmin) by default to a public client app- Returns:
- ClientPrivilegesSetting
- Throws:
ApiException
- if fails to make API call
-
getClientPrivilegesSetting
public ClientPrivilegesSetting getClientPrivilegesSetting(Map<String, String> additionalHeaders) throws ApiExceptionRetrieve the Org settings to assign the Super Admin role Retrieves the Org settings to assign the [Super Admin role](https://help.okta.com/okta_help.htm?type=oie&id=ext_superadmin) by default to a public client app- Parameters:
additionalHeaders
- additionalHeaders for this call- Returns:
- ClientPrivilegesSetting
- Throws:
ApiException
- if fails to make API call
-
getOktaCommunicationSettings
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 ApiExceptionRetrieve 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
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 ApiExceptionRetrieve 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
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 ApiExceptionRetrieve 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
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 ApiExceptionRetrieve 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
Retrieve the Org Preferences Retrieves preferences of your organization- Returns:
- OrgPreferences
- Throws:
ApiException
- if fails to make API call
-
getOrgPreferences
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
Retrieve the Org Settings Retrieves the org settings- Returns:
- OrgSetting
- Throws:
ApiException
- if fails to make API call
-
getOrgSettings
Retrieve the Org Settings Retrieves the org settings- Parameters:
additionalHeaders
- additionalHeaders for this call- Returns:
- OrgSetting
- Throws:
ApiException
- if fails to make API call
-
getThirdPartyAdminSetting
Retrieve the Org Third-Party Admin setting Retrieves the Third-Party Admin setting- Returns:
- ThirdPartyAdminSetting
- Throws:
ApiException
- if fails to make API call
-
getThirdPartyAdminSetting
public ThirdPartyAdminSetting getThirdPartyAdminSetting(Map<String, String> additionalHeaders) throws ApiExceptionRetrieve the Org Third-Party Admin setting Retrieves the Third-Party Admin setting- Parameters:
additionalHeaders
- additionalHeaders for this call- Returns:
- ThirdPartyAdminSetting
- Throws:
ApiException
- if fails to make API call
-
getWellknownOrgMetadata
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 ApiExceptionRetrieve 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
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 ApiExceptionGrant 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
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 ApiExceptionOpt 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
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 ApiExceptionOpt 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 ApiExceptionReplace 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
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 ApiExceptionReplace 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
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 ApiExceptionRevoke 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
-
updateOrgSettings
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 ApiExceptionUpdate 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
-
updateThirdPartyAdminSetting
Update the Org Third-Party Admin setting Updates the Third-Party Admin setting- Returns:
- ThirdPartyAdminSetting
- Throws:
ApiException
- if fails to make API call
-
updateThirdPartyAdminSetting
public ThirdPartyAdminSetting updateThirdPartyAdminSetting(Map<String, String> additionalHeaders) throws ApiExceptionUpdate the Org Third-Party Admin setting Updates the Third-Party Admin setting- Parameters:
additionalHeaders
- additionalHeaders for this call- Returns:
- ThirdPartyAdminSetting
- Throws:
ApiException
- if fails to make API call
-
uploadOrgLogo
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
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()
-