com.okta.sdk.resource.org

Interface OrgSetting

All Superinterfaces:

ExtensibleResource, Map<String,Object>, PropertyRetriever, Resource

All Known Implementing Classes:

DefaultOrgSetting

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00")
public interface OrgSetting
extends ExtensibleResource

OrgSetting

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Method Summary

Modifier and Type	Method and Description
OrgOktaCommunicationSetting	communicationSettings() Get Okta Communication Settings Gets Okta Communication Settings of your organization.
String	getAddress1()
String	getAddress2()
String	getCity()
String	getCompanyName()
OrgContactTypeObjList	getContactTypes() Get org contact types Gets Contact Types of your organization.
String	getCountry()
Date	getCreated()
String	getEndUserSupportHelpURL()
Date	getExpiresAt()
String	getId()
Date	getLastUpdated()
OrgContactUser	getOrgContactUser(String contactType) Get org contact user Retrieves the URL of the User associated with the specified Contact Type.
String	getPhoneNumber()
String	getPostalCode()
String	getState()
String	getStatus()
String	getSubdomain()
String	getSupportPhoneNumber()
OrgOktaSupportSettingsObj	getSupportSettings() Get Okta Support settings Gets Okta Support Settings of your organization.
String	getWebsite()
OrgPreferences	hideFooter() Show Okta UI Footer Hide the Okta UI footer for all end users of your organization.
OrgPreferences	orgPreferences() Get org preferences Gets preferences of your organization.
OrgSetting	partialUpdate() Partial update Org setting Partial update settings of your organization.
OrgSetting	setAddress1(String address1)
OrgSetting	setAddress2(String address2)
OrgSetting	setCity(String city)
OrgSetting	setCompanyName(String companyName)
OrgSetting	setCountry(String country)
OrgSetting	setEndUserSupportHelpURL(String endUserSupportHelpURL)
OrgSetting	setPhoneNumber(String phoneNumber)
OrgSetting	setPostalCode(String postalCode)
OrgSetting	setState(String state)
OrgSetting	setSupportPhoneNumber(String supportPhoneNumber)
OrgSetting	setWebsite(String website)
OrgPreferences	showFooter() Show Okta UI Footer Makes the Okta UI footer visible for all end users of your organization.
OrgSetting	update() Update Org setting Update settings of your organization.
void	updateOrgLogo(File file) Update org logo Updates the logo for your organization.

Methods inherited from interface com.okta.sdk.resource.Resource

getResourceHref, setResourceHref

Methods inherited from interface com.okta.sdk.resource.PropertyRetriever

getBoolean, getInteger, getIntegerList, getNumber, getNumberList, getString, getStringList

Methods inherited from interface java.util.Map

clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Method Detail

getAddress1

String getAddress1()

setAddress1

OrgSetting setAddress1(String address1)

getAddress2

String getAddress2()

setAddress2

OrgSetting setAddress2(String address2)

getCity

String getCity()

setCity

OrgSetting setCity(String city)

getCompanyName

String getCompanyName()

setCompanyName

OrgSetting setCompanyName(String companyName)

getCountry

String getCountry()

setCountry

OrgSetting setCountry(String country)

getCreated

Date getCreated()

getEndUserSupportHelpURL

String getEndUserSupportHelpURL()

setEndUserSupportHelpURL

OrgSetting setEndUserSupportHelpURL(String endUserSupportHelpURL)

getExpiresAt

Date getExpiresAt()

getId

String getId()

getLastUpdated

Date getLastUpdated()

getPhoneNumber

String getPhoneNumber()

setPhoneNumber

OrgSetting setPhoneNumber(String phoneNumber)

getPostalCode

String getPostalCode()

setPostalCode

OrgSetting setPostalCode(String postalCode)

getState

String getState()

setState

OrgSetting setState(String state)

getStatus

String getStatus()

getSubdomain

String getSubdomain()

getSupportPhoneNumber

String getSupportPhoneNumber()

setSupportPhoneNumber

OrgSetting setSupportPhoneNumber(String supportPhoneNumber)

getWebsite

String getWebsite()

setWebsite

OrgSetting setWebsite(String website)

partialUpdate

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="POST - /api/v1/org")
OrgSetting partialUpdate()

Partial update Org setting Partial update settings of your organization.

Returns:

OrgSetting

getSupportSettings

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="GET - /api/v1/org/privacy/oktaSupport")
OrgOktaSupportSettingsObj getSupportSettings()

Get Okta Support settings Gets Okta Support Settings of your organization.

Returns:

OrgOktaSupportSettingsObj

getOrgContactUser

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="GET - /api/v1/org/contacts/{contactType}")
OrgContactUser getOrgContactUser(String contactType)

Get org contact user Retrieves the URL of the User associated with the specified Contact Type.

Parameters:

contactType - (required)

Returns:

OrgContactUser

orgPreferences

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="GET - /api/v1/org/preferences")
OrgPreferences orgPreferences()

Get org preferences Gets preferences of your organization.

Returns:

OrgPreferences

updateOrgLogo

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="POST - /api/v1/org/logo")
void updateOrgLogo(File file)

Update org logo Updates the logo for your organization.

Parameters:

file - (required)

getContactTypes

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="GET - /api/v1/org/contacts")
OrgContactTypeObjList getContactTypes()

Get org contact types Gets Contact Types of your organization.

Returns:

OrgContactTypeObjList

communicationSettings

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="GET - /api/v1/org/privacy/oktaCommunication")
OrgOktaCommunicationSetting communicationSettings()

Get Okta Communication Settings Gets Okta Communication Settings of your organization.

Returns:

OrgOktaCommunicationSetting

hideFooter

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="POST - /api/v1/org/preferences/hideEndUserFooter")
OrgPreferences hideFooter()

Show Okta UI Footer Hide the Okta UI footer for all end users of your organization.

Returns:

OrgPreferences

update

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="PUT - /api/v1/org")
OrgSetting update()

Update Org setting Update settings of your organization.

Returns:

OrgSetting

showFooter

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="POST - /api/v1/org/preferences/showEndUserFooter")
OrgPreferences showFooter()

Show Okta UI Footer Makes the Okta UI footer visible for all end users of your organization.

Returns:

OrgPreferences