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, ExtensibleResource, PropertyRetriever, Resource, Saveable<Application>, Map<String,Object>

Direct Known Subclasses:

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

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-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

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

Map.Entry<K,V>

Field Summary

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

properties

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) Assign Group to Application Assigns a group to an 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.
Csr	generateCsr(CsrMetadata metadata) Generate Certificate Signing Request for Application Generates a new key pair and returns the Certificate Signing Request for it.
JsonWebKey	generateKey() Generates a new X.509 certificate for an application key credential
JsonWebKey	generateKey(Integer validityYears) 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 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()
Csr	getCsr(String csrId)
Map<String,Object>	getEmbedded()
ApplicationFeature	getFeatureForApplication(String name) Fetches a Feature object for an application.
List<String>	getFeatures()
String	getId()
String	getLabel()
Date	getLastUpdated()
ApplicationLicensing	getLicensing()
Map<String,Object>	getLinks()
String	getName()
OAuth2Token	getOAuth2Token(String tokenId) Gets a token for the specified application
OAuth2Token	getOAuth2Token(String tokenId, String expand) Gets a token for the specified application
Map<String,Object>	getProfile()
Map<String,Property>	getPropertyDescriptors()
Class<? extends Resource>	getResourceClass() Returns the class this resource represents.
OAuth2ScopeConsentGrant	getScopeConsentGrant(String grantId) Fetches a single scope consent grant for the application
OAuth2ScopeConsentGrant	getScopeConsentGrant(String grantId, String expand) Fetches a single scope consent grant for the application
ApplicationSettings	getSettings()
ApplicationSignOnMode	getSignOnMode()
Application.StatusEnum	getStatus()
ApplicationVisibility	getVisibility()
OAuth2ScopeConsentGrant	grantConsentToScope(OAuth2ScopeConsentGrant oAuth2ScopeConsentGrant) Grants consent for the application to request an OAuth 2.0 Okta scope
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.
CsrList	listCsrs() List Certificate Signing Requests for Application Enumerates Certificate Signing Requests 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
OAuth2TokenList	listOAuth2Tokens() Lists all tokens for the application
OAuth2TokenList	listOAuth2Tokens(String expand) Lists all tokens for the application
OAuth2ScopeConsentGrantList	listScopeConsentGrants() Lists all scope consent grants for the application
OAuth2ScopeConsentGrantList	listScopeConsentGrants(String expand) Lists all scope consent grants for the application
JsonWebKey	publishBinaryCerCert(String csrId)
JsonWebKey	publishBinaryDerCert(String csrId)
JsonWebKey	publishBinaryPemCert(String csrId)
JsonWebKey	publishCerCert(String csrId)
JsonWebKey	publishDerCert(String csrId)
void	revokeCsr(String csrId)
void	revokeOAuth2TokenForApplication(String tokenId) Revokes the specified token for the specified application
void	revokeOAuth2Tokens() Revokes all tokens for the specified application
void	revokeScopeConsentGrant(String grantId) Revokes permission for the application to request the given scope
Application	setAccessibility(ApplicationAccessibility accessibility)
Application	setCredentials(ApplicationCredentials credentials)
Application	setFeatures(List<String> features)
Application	setLabel(String label)
Application	setLicensing(ApplicationLicensing licensing)
Application	setProfile(Map<String,Object> profile)
Application	setSettings(ApplicationSettings settings)
Application	setSignOnMode(ApplicationSignOnMode signOnMode)
Application	setVisibility(ApplicationVisibility visibility)
Application	update() Update Application Updates an application in your organization.
void	updateApplicationPolicy(String policyId) Update application policy Assign an application to a specific policy.
ApplicationFeature	updateFeatureForApplication(String name, CapabilitiesObject capabilities) Updates a Feature object for an application.
void	uploadApplicationLogo(String appId, File file) The file must be in PNG, JPG, or GIF format, and less than 1 MB in size.

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

save

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

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

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

getBoolean, getBoolean, getBooleanProperty, getCharArray, getDateProperty, getDoubleProperty, getDoubleProperty, getEnumListProperty, getEnumProperty, getEnumProperty, getInt, getInteger, getIntegerList, getIntProperty, getIntProperty, getListProperty, getListProperty, getMap, getMapProperty, getNonEmptyMap, 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

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

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

getResourceClass

public Class<? extends Resource> getResourceClass()

Description copied from class: AbstractInstanceResource

Returns the class this resource represents. This is used when you need to figure out what the main type of Resource this object is. For example, DefaultFoo, ImplFoo, and SuperFoo may all represent the Resource of Foo, in this case this method may return Foo.class. (Defaults to getClass().)

Overrides:

getResourceClass in class AbstractInstanceResource<Application>

Returns:

The type of resource this class represents.

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

getProfile

public Map<String,Object> getProfile()

Specified by:

getProfile in interface Application

setProfile

public Application setProfile(Map<String,Object> profile)

Specified by:

setProfile 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

getFeatureForApplication

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="GET - /api/v1/apps/{appId}/features/{name}")
public ApplicationFeature getFeatureForApplication(String name)

Fetches a Feature object for an application. Fetches a Feature object for an application.

Specified by:

getFeatureForApplication in interface Application

Parameters:

name - (required)

Returns:

ApplicationFeature

revokeCsr

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="DELETE - /api/v1/apps/{appId}/credentials/csrs/{csrId}")
public void revokeCsr(String csrId)

Specified by:

revokeCsr in interface Application

Parameters:

csrId - (required)

getCsr

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="GET - /api/v1/apps/{appId}/credentials/csrs/{csrId}")
public Csr getCsr(String csrId)

Specified by:

getCsr in interface Application

Parameters:

csrId - (required)

Returns:

Csr

getApplicationUser

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-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="2023-07-07T09:07:53.917-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="2023-07-07T09:07:53.917-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

updateApplicationPolicy

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="PUT - /api/v1/apps/{appId}/policies/{policyId}")
public void updateApplicationPolicy(String policyId)

Update application policy Assign an application to a specific policy. This unassigns the application from its currently assigned policy.

Specified by:

updateApplicationPolicy in interface Application

Parameters:

policyId - (required)

generateCsr

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="POST - /api/v1/apps/{appId}/credentials/csrs")
public Csr generateCsr(CsrMetadata metadata)

Generate Certificate Signing Request for Application Generates a new key pair and returns the Certificate Signing Request for it.

Specified by:

generateCsr in interface Application

Parameters:

metadata - (required)

Returns:

Csr

listGroupAssignments

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-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="2023-07-07T09:07:53.917-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

listScopeConsentGrants

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="GET - /api/v1/apps/{appId}/grants")
public OAuth2ScopeConsentGrantList listScopeConsentGrants(String expand)

Lists all scope consent grants for the application

Specified by:

listScopeConsentGrants in interface Application

Parameters:

expand - (optional)

Returns:

OAuth2ScopeConsentGrantList

listScopeConsentGrants

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="GET - /api/v1/apps/{appId}/grants")
public OAuth2ScopeConsentGrantList listScopeConsentGrants()

Lists all scope consent grants for the application

Specified by:

listScopeConsentGrants in interface Application

Returns:

OAuth2ScopeConsentGrantList

revokeOAuth2TokenForApplication

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="DELETE - /api/v1/apps/{appId}/tokens/{tokenId}")
public void revokeOAuth2TokenForApplication(String tokenId)

Revokes the specified token for the specified application

Specified by:

revokeOAuth2TokenForApplication in interface Application

Parameters:

tokenId - (required)

publishBinaryCerCert

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="POST - /api/v1/apps/{appId}/credentials/csrs/{csrId}/lifecycle/publish")
public JsonWebKey publishBinaryCerCert(String csrId)

Specified by:

publishBinaryCerCert in interface Application

Parameters:

csrId - (required)

Returns:

JsonWebKey

revokeOAuth2Tokens

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="DELETE - /api/v1/apps/{appId}/tokens")
public void revokeOAuth2Tokens()

Revokes all tokens for the specified application

Specified by:

revokeOAuth2Tokens in interface Application

revokeScopeConsentGrant

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="DELETE - /api/v1/apps/{appId}/grants/{grantId}")
public void revokeScopeConsentGrant(String grantId)

Revokes permission for the application to request the given scope

Specified by:

revokeScopeConsentGrant in interface Application

Parameters:

grantId - (required)

assignUserToApplication

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-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

grantConsentToScope

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="POST - /api/v1/apps/{appId}/grants")
public OAuth2ScopeConsentGrant grantConsentToScope(OAuth2ScopeConsentGrant oAuth2ScopeConsentGrant)

Grants consent for the application to request an OAuth 2.0 Okta scope

Specified by:

grantConsentToScope in interface Application

Parameters:

oAuth2ScopeConsentGrant - (required)

Returns:

OAuth2ScopeConsentGrant

delete

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-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>

publishDerCert

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="POST - /api/v1/apps/{appId}/credentials/csrs/{csrId}/lifecycle/publish")
public JsonWebKey publishDerCert(String csrId)

Specified by:

publishDerCert in interface Application

Parameters:

csrId - (required)

Returns:

JsonWebKey

activate

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-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="2023-07-07T09:07:53.917-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 - (optional)

Returns:

ApplicationGroupAssignment

createApplicationGroupAssignment

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="PUT - /api/v1/apps/{appId}/groups/{groupId}")
public ApplicationGroupAssignment createApplicationGroupAssignment(String groupId)

Assign Group to Application Assigns a group to an application

Specified by:

createApplicationGroupAssignment in interface Application

Parameters:

groupId - (required)

Returns:

ApplicationGroupAssignment

getApplicationGroupAssignment

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-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="2023-07-07T09:07:53.917-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

generateKey

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="POST - /api/v1/apps/{appId}/credentials/keys/generate")
public JsonWebKey generateKey(Integer validityYears)

Generates a new X.509 certificate for an application key credential

Specified by:

generateKey in interface Application

Parameters:

validityYears - (optional)

Returns:

JsonWebKey

generateKey

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="POST - /api/v1/apps/{appId}/credentials/keys/generate")
public JsonWebKey generateKey()

Generates a new X.509 certificate for an application key credential

Specified by:

generateKey in interface Application

Returns:

JsonWebKey

listOAuth2Tokens

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="GET - /api/v1/apps/{appId}/tokens")
public OAuth2TokenList listOAuth2Tokens(String expand)

Lists all tokens for the application

Specified by:

listOAuth2Tokens in interface Application

Parameters:

expand - (optional)

Returns:

OAuth2TokenList

listOAuth2Tokens

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="GET - /api/v1/apps/{appId}/tokens")
public OAuth2TokenList listOAuth2Tokens()

Lists all tokens for the application

Specified by:

listOAuth2Tokens in interface Application

Returns:

OAuth2TokenList

getScopeConsentGrant

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="GET - /api/v1/apps/{appId}/grants/{grantId}")
public OAuth2ScopeConsentGrant getScopeConsentGrant(String grantId,
                                                                                                                                                                                                                                               String expand)

Fetches a single scope consent grant for the application

Specified by:

getScopeConsentGrant in interface Application

Parameters:

grantId - (required)

expand - (optional)

Returns:

OAuth2ScopeConsentGrant

getScopeConsentGrant

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="GET - /api/v1/apps/{appId}/grants/{grantId}")
public OAuth2ScopeConsentGrant getScopeConsentGrant(String grantId)

Fetches a single scope consent grant for the application

Specified by:

getScopeConsentGrant in interface Application

Parameters:

grantId - (required)

Returns:

OAuth2ScopeConsentGrant

deactivate

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-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

publishBinaryPemCert

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="POST - /api/v1/apps/{appId}/credentials/csrs/{csrId}/lifecycle/publish")
public JsonWebKey publishBinaryPemCert(String csrId)

Specified by:

publishBinaryPemCert in interface Application

Parameters:

csrId - (required)

Returns:

JsonWebKey

update

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-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="2023-07-07T09:07:53.917-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

getOAuth2Token

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="GET - /api/v1/apps/{appId}/tokens/{tokenId}")
public OAuth2Token getOAuth2Token(String tokenId,
                                                                                                                                                                                                                             String expand)

Gets a token for the specified application

Specified by:

getOAuth2Token in interface Application

Parameters:

tokenId - (required)

expand - (optional)

Returns:

OAuth2Token

getOAuth2Token

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="GET - /api/v1/apps/{appId}/tokens/{tokenId}")
public OAuth2Token getOAuth2Token(String tokenId)

Gets a token for the specified application

Specified by:

getOAuth2Token in interface Application

Parameters:

tokenId - (required)

Returns:

OAuth2Token

listCsrs

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="GET - /api/v1/apps/{appId}/credentials/csrs")
public CsrList listCsrs()

List Certificate Signing Requests for Application Enumerates Certificate Signing Requests for an application

Specified by:

listCsrs in interface Application

Returns:

CsrList

listApplicationUsers

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-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="2023-07-07T09:07:53.917-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="2023-07-07T09:07:53.917-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 by kid

Specified by:

getApplicationKey in interface Application

Parameters:

keyId - (required)

Returns:

JsonWebKey

publishCerCert

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="POST - /api/v1/apps/{appId}/credentials/csrs/{csrId}/lifecycle/publish")
public JsonWebKey publishCerCert(String csrId)

Specified by:

publishCerCert in interface Application

Parameters:

csrId - (required)

Returns:

JsonWebKey

updateFeatureForApplication

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="PUT - /api/v1/apps/{appId}/features/{name}")
public ApplicationFeature updateFeatureForApplication(String name,
                                                                                                                                                                                                                                                CapabilitiesObject capabilities)

Updates a Feature object for an application. Updates a Feature object for an application.

Specified by:

updateFeatureForApplication in interface Application

Parameters:

name - (required)

capabilities - (required)

Returns:

ApplicationFeature

publishBinaryDerCert

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="POST - /api/v1/apps/{appId}/credentials/csrs/{csrId}/lifecycle/publish")
public JsonWebKey publishBinaryDerCert(String csrId)

Specified by:

publishBinaryDerCert in interface Application

Parameters:

csrId - (required)

Returns:

JsonWebKey

uploadApplicationLogo

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="POST - /api/v1/apps/{appId}/logo")
public void uploadApplicationLogo(String appId,
                                                                                                                                                                                                                  File file)

The file must be in PNG, JPG, or GIF format, and less than 1 MB in size. For best results use landscape orientation, a transparent background, and a minimum size of 420px by 120px to prevent upscaling. Update the logo for an application.

Specified by:

uploadApplicationLogo in interface Application

Parameters:

appId - (required)

file - (required)