@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen", date="2023-07-07T09:07:50.516-05:00") public interface Application extends ExtensibleResource, Deletable
Modifier and Type | Interface and Description |
---|---|
static class |
Application.StatusEnum
Enum status
|
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() |
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.
|
getResourceHref, setResourceHref
getBoolean, getInteger, getIntegerList, getNumber, getNumberList, getString, getStringList
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
ApplicationAccessibility getAccessibility()
Application setAccessibility(ApplicationAccessibility accessibility)
Date getCreated()
ApplicationCredentials getCredentials()
Application setCredentials(ApplicationCredentials credentials)
Application setFeatures(List<String> features)
String getId()
String getLabel()
Application setLabel(String label)
Date getLastUpdated()
ApplicationLicensing getLicensing()
Application setLicensing(ApplicationLicensing licensing)
String getName()
Application setProfile(Map<String,Object> profile)
ApplicationSettings getSettings()
Application setSettings(ApplicationSettings settings)
ApplicationSignOnMode getSignOnMode()
Application setSignOnMode(ApplicationSignOnMode signOnMode)
Application.StatusEnum getStatus()
ApplicationVisibility getVisibility()
Application setVisibility(ApplicationVisibility visibility)
@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen", date="2023-07-07T09:07:50.516-05:00", comments="GET - /api/v1/apps/{appId}/features/{name}") ApplicationFeature getFeatureForApplication(String name)
name
- (required)@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen", date="2023-07-07T09:07:50.516-05:00", comments="DELETE - /api/v1/apps/{appId}/credentials/csrs/{csrId}") void revokeCsr(String csrId)
csrId
- (required)@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen", date="2023-07-07T09:07:50.516-05:00", comments="GET - /api/v1/apps/{appId}/credentials/csrs/{csrId}") Csr getCsr(String csrId)
csrId
- (required)@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen", date="2023-07-07T09:07:50.516-05:00", comments="GET - /api/v1/apps/{appId}/users/{userId}") AppUser getApplicationUser(String userId, String expand)
userId
- (required)expand
- (optional)@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen", date="2023-07-07T09:07:50.516-05:00", comments="GET - /api/v1/apps/{appId}/users/{userId}") AppUser getApplicationUser(String userId)
userId
- (required)@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen", date="2023-07-07T09:07:50.516-05:00", comments="POST - /api/v1/apps/{appId}/credentials/keys/{keyId}/clone") JsonWebKey cloneApplicationKey(String keyId, String targetAid)
keyId
- (required)targetAid
- Unique key of the target Application (required)@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen", date="2023-07-07T09:07:50.516-05:00", comments="PUT - /api/v1/apps/{appId}/policies/{policyId}") void updateApplicationPolicy(String policyId)
policyId
- (required)@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen", date="2023-07-07T09:07:50.516-05:00", comments="POST - /api/v1/apps/{appId}/credentials/csrs") Csr generateCsr(CsrMetadata metadata)
metadata
- (required)@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen", date="2023-07-07T09:07:50.516-05:00", comments="GET - /api/v1/apps/{appId}/groups") ApplicationGroupAssignmentList listGroupAssignments(String q, String expand)
q
- (optional)expand
- (optional)@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen", date="2023-07-07T09:07:50.516-05:00", comments="GET - /api/v1/apps/{appId}/groups") ApplicationGroupAssignmentList listGroupAssignments()
@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen", date="2023-07-07T09:07:50.516-05:00", comments="GET - /api/v1/apps/{appId}/grants") OAuth2ScopeConsentGrantList listScopeConsentGrants(String expand)
expand
- (optional)@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen", date="2023-07-07T09:07:50.516-05:00", comments="GET - /api/v1/apps/{appId}/grants") OAuth2ScopeConsentGrantList listScopeConsentGrants()
@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen", date="2023-07-07T09:07:50.516-05:00", comments="DELETE - /api/v1/apps/{appId}/tokens/{tokenId}") void revokeOAuth2TokenForApplication(String tokenId)
tokenId
- (required)@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen", date="2023-07-07T09:07:50.516-05:00", comments="POST - /api/v1/apps/{appId}/credentials/csrs/{csrId}/lifecycle/publish") JsonWebKey publishBinaryCerCert(String csrId)
csrId
- (required)@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen", date="2023-07-07T09:07:50.516-05:00", comments="DELETE - /api/v1/apps/{appId}/tokens") void revokeOAuth2Tokens()
@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen", date="2023-07-07T09:07:50.516-05:00", comments="DELETE - /api/v1/apps/{appId}/grants/{grantId}") void revokeScopeConsentGrant(String grantId)
grantId
- (required)@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen", date="2023-07-07T09:07:50.516-05:00", comments="POST - /api/v1/apps/{appId}/users") AppUser assignUserToApplication(AppUser appUser)
appUser
- (required)@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen", date="2023-07-07T09:07:50.516-05:00", comments="POST - /api/v1/apps/{appId}/grants") OAuth2ScopeConsentGrant grantConsentToScope(OAuth2ScopeConsentGrant oAuth2ScopeConsentGrant)
oAuth2ScopeConsentGrant
- (required)@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen", date="2023-07-07T09:07:50.516-05:00", comments="DELETE - /api/v1/apps/{appId}") void delete()
@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen", date="2023-07-07T09:07:50.516-05:00", comments="POST - /api/v1/apps/{appId}/credentials/csrs/{csrId}/lifecycle/publish") JsonWebKey publishDerCert(String csrId)
csrId
- (required)@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen", date="2023-07-07T09:07:50.516-05:00", comments="POST - /api/v1/apps/{appId}/lifecycle/activate") void activate()
@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen", date="2023-07-07T09:07:50.516-05:00", comments="PUT - /api/v1/apps/{appId}/groups/{groupId}") ApplicationGroupAssignment createApplicationGroupAssignment(String groupId, ApplicationGroupAssignment applicationGroupAssignment)
groupId
- (required)applicationGroupAssignment
- (optional)@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen", date="2023-07-07T09:07:50.516-05:00", comments="PUT - /api/v1/apps/{appId}/groups/{groupId}") ApplicationGroupAssignment createApplicationGroupAssignment(String groupId)
groupId
- (required)@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen", date="2023-07-07T09:07:50.516-05:00", comments="GET - /api/v1/apps/{appId}/groups/{groupId}") ApplicationGroupAssignment getApplicationGroupAssignment(String groupId, String expand)
groupId
- (required)expand
- (optional)@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen", date="2023-07-07T09:07:50.516-05:00", comments="GET - /api/v1/apps/{appId}/groups/{groupId}") ApplicationGroupAssignment getApplicationGroupAssignment(String groupId)
groupId
- (required)@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen", date="2023-07-07T09:07:50.516-05:00", comments="POST - /api/v1/apps/{appId}/credentials/keys/generate") JsonWebKey generateKey(Integer validityYears)
validityYears
- (optional)@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen", date="2023-07-07T09:07:50.516-05:00", comments="POST - /api/v1/apps/{appId}/credentials/keys/generate") JsonWebKey generateKey()
@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen", date="2023-07-07T09:07:50.516-05:00", comments="GET - /api/v1/apps/{appId}/tokens") OAuth2TokenList listOAuth2Tokens(String expand)
expand
- (optional)@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen", date="2023-07-07T09:07:50.516-05:00", comments="GET - /api/v1/apps/{appId}/tokens") OAuth2TokenList listOAuth2Tokens()
@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen", date="2023-07-07T09:07:50.516-05:00", comments="GET - /api/v1/apps/{appId}/grants/{grantId}") OAuth2ScopeConsentGrant getScopeConsentGrant(String grantId, String expand)
grantId
- (required)expand
- (optional)@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen", date="2023-07-07T09:07:50.516-05:00", comments="GET - /api/v1/apps/{appId}/grants/{grantId}") OAuth2ScopeConsentGrant getScopeConsentGrant(String grantId)
grantId
- (required)@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen", date="2023-07-07T09:07:50.516-05:00", comments="POST - /api/v1/apps/{appId}/lifecycle/deactivate") void deactivate()
@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen", date="2023-07-07T09:07:50.516-05:00", comments="POST - /api/v1/apps/{appId}/credentials/csrs/{csrId}/lifecycle/publish") JsonWebKey publishBinaryPemCert(String csrId)
csrId
- (required)@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen", date="2023-07-07T09:07:50.516-05:00", comments="PUT - /api/v1/apps/{appId}") Application update()
@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen", date="2023-07-07T09:07:50.516-05:00", comments="GET - /api/v1/apps/{appId}/credentials/keys") JsonWebKeyList listKeys()
@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen", date="2023-07-07T09:07:50.516-05:00", comments="GET - /api/v1/apps/{appId}/tokens/{tokenId}") OAuth2Token getOAuth2Token(String tokenId, String expand)
tokenId
- (required)expand
- (optional)@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen", date="2023-07-07T09:07:50.516-05:00", comments="GET - /api/v1/apps/{appId}/tokens/{tokenId}") OAuth2Token getOAuth2Token(String tokenId)
tokenId
- (required)@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen", date="2023-07-07T09:07:50.516-05:00", comments="GET - /api/v1/apps/{appId}/credentials/csrs") CsrList listCsrs()
@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen", date="2023-07-07T09:07:50.516-05:00", comments="GET - /api/v1/apps/{appId}/users") AppUserList listApplicationUsers(String q, String queryScope, String filter, String expand)
q
- (optional)queryScope
- (optional)filter
- (optional)expand
- (optional)@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen", date="2023-07-07T09:07:50.516-05:00", comments="GET - /api/v1/apps/{appId}/users") AppUserList listApplicationUsers()
@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen", date="2023-07-07T09:07:50.516-05:00", comments="GET - /api/v1/apps/{appId}/credentials/keys/{keyId}") JsonWebKey getApplicationKey(String keyId)
keyId
- (required)@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen", date="2023-07-07T09:07:50.516-05:00", comments="POST - /api/v1/apps/{appId}/credentials/csrs/{csrId}/lifecycle/publish") JsonWebKey publishCerCert(String csrId)
csrId
- (required)@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen", date="2023-07-07T09:07:50.516-05:00", comments="PUT - /api/v1/apps/{appId}/features/{name}") ApplicationFeature updateFeatureForApplication(String name, CapabilitiesObject capabilities)
name
- (required)capabilities
- (required)@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen", date="2023-07-07T09:07:50.516-05:00", comments="POST - /api/v1/apps/{appId}/credentials/csrs/{csrId}/lifecycle/publish") JsonWebKey publishBinaryDerCert(String csrId)
csrId
- (required)@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen", date="2023-07-07T09:07:50.516-05:00", comments="POST - /api/v1/apps/{appId}/logo") void uploadApplicationLogo(String appId, File file)
appId
- (required)file
- (required)Copyright © 2017–2023 Okta. All rights reserved.