com.okta.sdk.impl.resource.application

Class DefaultApplication

java.lang.Object

com.okta.sdk.impl.resource.AbstractPropertyRetriever

com.okta.sdk.impl.resource.AbstractResource

com.okta.sdk.impl.resource.AbstractInstanceResource<Application>

com.okta.sdk.impl.resource.application.DefaultApplication

All Implemented Interfaces:

Application, Deletable, PropertyRetriever, Resource, Saveable<Application>

Direct Known Subclasses:

DefaultAutoLoginApplication, DefaultBasicAuthApplication, DefaultBookmarkApplication, DefaultBrowserPluginApplication, DefaultOpenIdConnectApplication, DefaultSamlApplication, DefaultSecurePasswordStoreApplication, DefaultWsFederationApplication

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2017-12-14T13:01:44.308-05:00")
public class DefaultApplication
extends AbstractInstanceResource<Application>
implements Application

Application

Nested Class Summary

Nested classes/interfaces inherited from interface com.okta.sdk.resource.application.Application

Application.StatusEnum

Field Summary

Fields inherited from class com.okta.sdk.impl.resource.AbstractResource

deletedPropertyNames, dirty, dirtyProperties, properties, referenceFactory

Fields inherited from class com.okta.sdk.impl.resource.AbstractPropertyRetriever

readLock, writeLock

Constructor Summary

Constructors

Constructor and Description
DefaultApplication(InternalDataStore dataStore)
DefaultApplication(InternalDataStore dataStore, Map<String,Object> properties)

Method Summary

Modifier and Type	Method and Description
void	activate() Activate Application Activates an inactive application.
AppUser	assignUserToApplication(AppUser appUser) Assign User to Application for SSO & Provisioning Assigns an user to an application with [credentials](#application-user-credentials-object) and an app-specific [profile](#application-user-profile-object).
JsonWebKey	cloneApplicationKey(String keyId, String targetAid) Clone Application Key Credential Clones a X.509 certificate for an application key credential from a source application to target application.
ApplicationGroupAssignment	createApplicationGroupAssignment(String groupId, ApplicationGroupAssignment applicationGroupAssignment) Assign Group to Application Assigns a group to an application
void	deactivate() Deactivate Application Deactivates an active application.
void	delete() Delete Application Removes an inactive application.
JsonWebKey	generateApplicationKey(Integer validityYears) Generate New Application Key Credential Generates a new X.509 certificate for an application key credential
ApplicationAccessibility	getAccessibility()
ApplicationGroupAssignment	getApplicationGroupAssignment(String groupId) Get Assigned Group for Application Fetches an application group assignment
ApplicationGroupAssignment	getApplicationGroupAssignment(String groupId, String expand) Get Assigned Group for Application Fetches an application group assignment
JsonWebKey	getApplicationKey(String keyId) Get Key Credential for Application Gets a specific [application key credential](#application-key-credential-model) by `kid`
AppUser	getApplicationUser(String userId) Get Assigned User for Application Fetches a specific user assignment for application by `id`.
AppUser	getApplicationUser(String userId, String expand) Get Assigned User for Application Fetches a specific user assignment for application by `id`.
Date	getCreated()
ApplicationCredentials	getCredentials()
Map<String,Object>	getEmbedded()
List<String>	getFeatures()
String	getId()
String	getLabel()
Date	getLastUpdated()
ApplicationLicensing	getLicensing()
Map<String,Object>	getLinks()
String	getName()
Map<String,Property>	getPropertyDescriptors()
ApplicationSettings	getSettings()
ApplicationSignOnMode	getSignOnMode()
Application.StatusEnum	getStatus()
ApplicationVisibility	getVisibility()
AppUserList	listApplicationUsers() List Users Assigned to Application Enumerates all assigned [application users](#application-user-model) for an application.
AppUserList	listApplicationUsers(String q, String queryScope, String filter, String expand) List Users Assigned to Application Enumerates all assigned [application users](#application-user-model) for an application.
ApplicationGroupAssignmentList	listGroupAssignments() List Groups Assigned to Application Enumerates group assignments for an application.
ApplicationGroupAssignmentList	listGroupAssignments(String q, String expand) List Groups Assigned to Application Enumerates group assignments for an application.
JsonWebKeyList	listKeys() List Key Credentials for Application Enumerates key credentials for an application
Application	setAccessibility(ApplicationAccessibility accessibility)
Application	setCredentials(ApplicationCredentials credentials)
Application	setFeatures(List<String> features)
Application	setLabel(String label)
Application	setLicensing(ApplicationLicensing licensing)
Application	setSettings(ApplicationSettings settings)
Application	setSignOnMode(ApplicationSignOnMode signOnMode)
Application	setVisibility(ApplicationVisibility visibility)
Application	update() Update Application Updates an application in your organization.

Methods inherited from class com.okta.sdk.impl.resource.AbstractInstanceResource

isInstanceResource, save

Methods inherited from class com.okta.sdk.impl.resource.AbstractResource

clear, containsKey, containsValue, createPropertyDescriptorMap, entrySet, equals, get, getDataStore, getDeletedPropertyNames, getInternalProperties, getParamsFromHref, getProperty, getPropertyNames, getResourceHref, getResourceListProperty, getResourceProperty, getUpdatedPropertyNames, hashCode, hasProperty, isDirty, isEmpty, isMaterialized, isMaterialized, isNew, isPrintableProperty, keySet, materialize, put, putAll, remove, setInternalProperties, setProperty, setProperty, setResourceHref, setResourceProperty, size, toString, values

Methods inherited from class com.okta.sdk.impl.resource.AbstractPropertyRetriever

getBoolean, getBoolean, getBooleanProperty, getDateProperty, getDoubleProperty, getDoubleProperty, getEnumListProperty, getEnumProperty, getEnumProperty, getInt, getInteger, getIntegerList, getIntProperty, getIntProperty, getListProperty, getListProperty, getMap, getMapProperty, getNullableBoolean, getNullableBooleanProperty, getNumber, getNumberList, getString, getString, getStringList, getStringProperty, setProperty, setProperty

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

getResourceHref, setResourceHref

Constructor Detail

DefaultApplication

public DefaultApplication(InternalDataStore dataStore)

DefaultApplication

public DefaultApplication(InternalDataStore dataStore,
                          Map<String,Object> properties)

Method Detail

getPropertyDescriptors

public Map<String,Property> getPropertyDescriptors()

Specified by:

getPropertyDescriptors in class AbstractResource

getEmbedded

public Map<String,Object> getEmbedded()

Specified by:

getEmbedded in interface Application

getLinks

public Map<String,Object> getLinks()

Specified by:

getLinks in interface Application

getAccessibility

public ApplicationAccessibility getAccessibility()

Specified by:

getAccessibility in interface Application

setAccessibility

public Application setAccessibility(ApplicationAccessibility accessibility)

Specified by:

setAccessibility in interface Application

getCreated

public Date getCreated()

Specified by:

getCreated in interface Application

getCredentials

public ApplicationCredentials getCredentials()

Specified by:

getCredentials in interface Application

setCredentials

public Application setCredentials(ApplicationCredentials credentials)

Specified by:

setCredentials in interface Application

getFeatures

public List<String> getFeatures()

Specified by:

getFeatures in interface Application

setFeatures

public Application setFeatures(List<String> features)

Specified by:

setFeatures in interface Application

getId

public String getId()

Specified by:

getId in interface Application

getLabel

public String getLabel()

Specified by:

getLabel in interface Application

setLabel

public Application setLabel(String label)

Specified by:

setLabel in interface Application

getLastUpdated

public Date getLastUpdated()

Specified by:

getLastUpdated in interface Application

getLicensing

public ApplicationLicensing getLicensing()

Specified by:

getLicensing in interface Application

setLicensing

public Application setLicensing(ApplicationLicensing licensing)

Specified by:

setLicensing in interface Application

getName

public String getName()

Specified by:

getName in interface Application

getSettings

public ApplicationSettings getSettings()

Specified by:

getSettings in interface Application

setSettings

public Application setSettings(ApplicationSettings settings)

Specified by:

setSettings in interface Application

getSignOnMode

public ApplicationSignOnMode getSignOnMode()

Specified by:

getSignOnMode in interface Application

setSignOnMode

public Application setSignOnMode(ApplicationSignOnMode signOnMode)

Specified by:

setSignOnMode in interface Application

getStatus

public Application.StatusEnum getStatus()

Specified by:

getStatus in interface Application

getVisibility

public ApplicationVisibility getVisibility()

Specified by:

getVisibility in interface Application

setVisibility

public Application setVisibility(ApplicationVisibility visibility)

Specified by:

setVisibility in interface Application

activate

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2017-12-14T13:01:44.308-05:00",
           comments="POST - /api/v1/apps/{appId}/lifecycle/activate")
public void activate()

Activate Application Activates an inactive application.

Specified by:

activate in interface Application

createApplicationGroupAssignment

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2017-12-14T13:01:44.308-05:00",
           comments="PUT - /api/v1/apps/{appId}/groups/{groupId}")
public ApplicationGroupAssignment createApplicationGroupAssignment(String groupId,
                                                                                                                                                                                                                                                              ApplicationGroupAssignment applicationGroupAssignment)

Assign Group to Application Assigns a group to an application

Specified by:

createApplicationGroupAssignment in interface Application

Parameters:

groupId - (required)

applicationGroupAssignment - (required)

Returns:

ApplicationGroupAssignment

getApplicationGroupAssignment

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2017-12-14T13:01:44.308-05:00",
           comments="GET - /api/v1/apps/{appId}/groups/{groupId}")
public ApplicationGroupAssignment getApplicationGroupAssignment(String groupId,
                                                                                                                                                                                                                                                           String expand)

Get Assigned Group for Application Fetches an application group assignment

Specified by:

getApplicationGroupAssignment in interface Application

Parameters:

groupId - (required)

expand - (optional)

Returns:

ApplicationGroupAssignment

getApplicationGroupAssignment

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2017-12-14T13:01:44.308-05:00",
           comments="GET - /api/v1/apps/{appId}/groups/{groupId}")
public ApplicationGroupAssignment getApplicationGroupAssignment(String groupId)

Get Assigned Group for Application Fetches an application group assignment

Specified by:

getApplicationGroupAssignment in interface Application

Parameters:

groupId - (required)

Returns:

ApplicationGroupAssignment

getApplicationUser

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2017-12-14T13:01:44.308-05:00",
           comments="GET - /api/v1/apps/{appId}/users/{userId}")
public AppUser getApplicationUser(String userId,
                                                                                                                                                                                                                           String expand)

Get Assigned User for Application Fetches a specific user assignment for application by `id`.

Specified by:

getApplicationUser in interface Application

Parameters:

userId - (required)

expand - (optional)

Returns:

AppUser

getApplicationUser

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2017-12-14T13:01:44.308-05:00",
           comments="GET - /api/v1/apps/{appId}/users/{userId}")
public AppUser getApplicationUser(String userId)

Get Assigned User for Application Fetches a specific user assignment for application by `id`.

Specified by:

getApplicationUser in interface Application

Parameters:

userId - (required)

Returns:

AppUser

cloneApplicationKey

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2017-12-14T13:01:44.308-05:00",
           comments="POST - /api/v1/apps/{appId}/credentials/keys/{keyId}/clone")
public JsonWebKey cloneApplicationKey(String keyId,
                                                                                                                                                                                                                                                String targetAid)

Clone Application Key Credential Clones a X.509 certificate for an application key credential from a source application to target application.

Specified by:

cloneApplicationKey in interface Application

Parameters:

keyId - (required)

targetAid - Unique key of the target Application (required)

Returns:

JsonWebKey

generateApplicationKey

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2017-12-14T13:01:44.308-05:00",
           comments="POST - /api/v1/apps/{appId}/credentials/keys/generate")
public JsonWebKey generateApplicationKey(Integer validityYears)

Generate New Application Key Credential Generates a new X.509 certificate for an application key credential

Specified by:

generateApplicationKey in interface Application

Parameters:

validityYears - expiry of the Application Key Credential (required)

Returns:

JsonWebKey

deactivate

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2017-12-14T13:01:44.308-05:00",
           comments="POST - /api/v1/apps/{appId}/lifecycle/deactivate")
public void deactivate()

Deactivate Application Deactivates an active application.

Specified by:

deactivate in interface Application

update

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2017-12-14T13:01:44.308-05:00",
           comments="PUT - /api/v1/apps/{appId}")
public Application update()

Update Application Updates an application in your organization.

Specified by:

update in interface Application

Returns:

Application

listKeys

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2017-12-14T13:01:44.308-05:00",
           comments="GET - /api/v1/apps/{appId}/credentials/keys")
public JsonWebKeyList listKeys()

List Key Credentials for Application Enumerates key credentials for an application

Specified by:

listKeys in interface Application

Returns:

JsonWebKeyList

listGroupAssignments

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2017-12-14T13:01:44.308-05:00",
           comments="GET - /api/v1/apps/{appId}/groups")
public ApplicationGroupAssignmentList listGroupAssignments(String q,
                                                                                                                                                                                                                                            String expand)

List Groups Assigned to Application Enumerates group assignments for an application.

Specified by:

listGroupAssignments in interface Application

Parameters:

q - (optional)

expand - (optional)

Returns:

ApplicationGroupAssignmentList

listGroupAssignments

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2017-12-14T13:01:44.308-05:00",
           comments="GET - /api/v1/apps/{appId}/groups")
public ApplicationGroupAssignmentList listGroupAssignments()

List Groups Assigned to Application Enumerates group assignments for an application.

Specified by:

listGroupAssignments in interface Application

Returns:

ApplicationGroupAssignmentList

listApplicationUsers

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2017-12-14T13:01:44.308-05:00",
           comments="GET - /api/v1/apps/{appId}/users")
public AppUserList listApplicationUsers(String q,
                                                                                                                                                                                                                        String queryScope,
                                                                                                                                                                                                                        String filter,
                                                                                                                                                                                                                        String expand)

List Users Assigned to Application Enumerates all assigned [application users](#application-user-model) for an application.

Specified by:

listApplicationUsers in interface Application

Parameters:

q - (optional)

queryScope - (optional)

filter - (optional)

expand - (optional)

Returns:

AppUserList

listApplicationUsers

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2017-12-14T13:01:44.308-05:00",
           comments="GET - /api/v1/apps/{appId}/users")
public AppUserList listApplicationUsers()

List Users Assigned to Application Enumerates all assigned [application users](#application-user-model) for an application.

Specified by:

listApplicationUsers in interface Application

Returns:

AppUserList

getApplicationKey

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2017-12-14T13:01:44.308-05:00",
           comments="GET - /api/v1/apps/{appId}/credentials/keys/{keyId}")
public JsonWebKey getApplicationKey(String keyId)

Get Key Credential for Application Gets a specific [application key credential](#application-key-credential-model) by `kid`

Specified by:

getApplicationKey in interface Application

Parameters:

keyId - (required)

Returns:

JsonWebKey

assignUserToApplication

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2017-12-14T13:01:44.308-05:00",
           comments="POST - /api/v1/apps/{appId}/users")
public AppUser assignUserToApplication(AppUser appUser)

Assign User to Application for SSO & Provisioning Assigns an user to an application with [credentials](#application-user-credentials-object) and an app-specific [profile](#application-user-profile-object). Profile mappings defined for the application are first applied before applying any profile properties specified in the request.

Specified by:

assignUserToApplication in interface Application

Parameters:

appUser - (required)

Returns:

AppUser

delete

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2017-12-14T13:01:44.308-05:00",
           comments="DELETE - /api/v1/apps/{appId}")
public void delete()

Delete Application Removes an inactive application.

Specified by:

delete in interface Application

Specified by:

delete in interface Deletable

Overrides:

delete in class AbstractInstanceResource<Application>