@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
date="2021-12-01T11:06:42.145-06: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(java.lang.String keyId,
java.lang.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(java.lang.String groupId)
Assign Group to Application
Assigns a group to an application
|
ApplicationGroupAssignment |
createApplicationGroupAssignment(java.lang.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(java.lang.Integer validityYears)
Generates a new X.509 certificate for an application key credential
|
ApplicationAccessibility |
getAccessibility() |
ApplicationGroupAssignment |
getApplicationGroupAssignment(java.lang.String groupId)
Get Assigned Group for Application
Fetches an application group assignment
|
ApplicationGroupAssignment |
getApplicationGroupAssignment(java.lang.String groupId,
java.lang.String expand)
Get Assigned Group for Application
Fetches an application group assignment
|
JsonWebKey |
getApplicationKey(java.lang.String keyId)
Get Key Credential for Application
Gets a specific application key credential by kid
|
AppUser |
getApplicationUser(java.lang.String userId)
Get Assigned User for Application
Fetches a specific user assignment for application by `id`.
|
AppUser |
getApplicationUser(java.lang.String userId,
java.lang.String expand)
Get Assigned User for Application
Fetches a specific user assignment for application by `id`.
|
java.util.Date |
getCreated() |
ApplicationCredentials |
getCredentials() |
Csr |
getCsr(java.lang.String csrId) |
java.util.Map<java.lang.String,java.lang.Object> |
getEmbedded() |
java.util.List<java.lang.String> |
getFeatures() |
java.lang.String |
getId() |
java.lang.String |
getLabel() |
java.util.Date |
getLastUpdated() |
ApplicationLicensing |
getLicensing() |
java.util.Map<java.lang.String,java.lang.Object> |
getLinks() |
java.lang.String |
getName() |
OAuth2Token |
getOAuth2Token(java.lang.String tokenId)
Gets a token for the specified application
|
OAuth2Token |
getOAuth2Token(java.lang.String tokenId,
java.lang.String expand)
Gets a token for the specified application
|
java.util.Map<java.lang.String,java.lang.Object> |
getProfile() |
OAuth2ScopeConsentGrant |
getScopeConsentGrant(java.lang.String grantId)
Fetches a single scope consent grant for the application
|
OAuth2ScopeConsentGrant |
getScopeConsentGrant(java.lang.String grantId,
java.lang.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(java.lang.String q,
java.lang.String queryScope,
java.lang.String filter,
java.lang.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(java.lang.String q,
java.lang.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(java.lang.String expand)
Lists all tokens for the application
|
OAuth2ScopeConsentGrantList |
listScopeConsentGrants()
Lists all scope consent grants for the application
|
OAuth2ScopeConsentGrantList |
listScopeConsentGrants(java.lang.String expand)
Lists all scope consent grants for the application
|
JsonWebKey |
publishBinaryCerCert(java.lang.String csrId) |
JsonWebKey |
publishBinaryDerCert(java.lang.String csrId) |
JsonWebKey |
publishBinaryPemCert(java.lang.String csrId) |
JsonWebKey |
publishCerCert(java.lang.String csrId) |
JsonWebKey |
publishDerCert(java.lang.String csrId) |
void |
revokeCsr(java.lang.String csrId) |
void |
revokeOAuth2TokenForApplication(java.lang.String tokenId)
Revokes the specified token for the specified application
|
void |
revokeOAuth2Tokens()
Revokes all tokens for the specified application
|
void |
revokeScopeConsentGrant(java.lang.String grantId)
Revokes permission for the application to request the given scope
|
Application |
setAccessibility(ApplicationAccessibility accessibility) |
Application |
setCredentials(ApplicationCredentials credentials) |
Application |
setFeatures(java.util.List<java.lang.String> features) |
Application |
setLabel(java.lang.String label) |
Application |
setLicensing(ApplicationLicensing licensing) |
Application |
setProfile(java.util.Map<java.lang.String,java.lang.Object> profile) |
Application |
setSettings(ApplicationSettings settings) |
Application |
setSignOnMode(ApplicationSignOnMode signOnMode) |
Application |
setVisibility(ApplicationVisibility visibility) |
Application |
update()
Update Application
Updates an application in your organization.
|
getResourceHref, setResourceHrefgetBoolean, getInteger, getIntegerList, getNumber, getNumberList, getString, getStringListjava.util.Map<java.lang.String,java.lang.Object> getEmbedded()
java.util.Map<java.lang.String,java.lang.Object> getLinks()
ApplicationAccessibility getAccessibility()
Application setAccessibility(ApplicationAccessibility accessibility)
java.util.Date getCreated()
ApplicationCredentials getCredentials()
Application setCredentials(ApplicationCredentials credentials)
java.util.List<java.lang.String> getFeatures()
Application setFeatures(java.util.List<java.lang.String> features)
java.lang.String getId()
java.lang.String getLabel()
Application setLabel(java.lang.String label)
java.util.Date getLastUpdated()
ApplicationLicensing getLicensing()
Application setLicensing(ApplicationLicensing licensing)
java.lang.String getName()
java.util.Map<java.lang.String,java.lang.Object> getProfile()
Application setProfile(java.util.Map<java.lang.String,java.lang.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="2021-12-01T11:06:42.145-06:00",
comments="DELETE - /api/v1/apps/{appId}/credentials/csrs/{csrId}")
void revokeCsr(java.lang.String csrId)
csrId - (required)@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
date="2021-12-01T11:06:42.145-06:00",
comments="GET - /api/v1/apps/{appId}/credentials/csrs/{csrId}")
Csr getCsr(java.lang.String csrId)
csrId - (required)@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
date="2021-12-01T11:06:42.145-06:00",
comments="GET - /api/v1/apps/{appId}/users/{userId}")
AppUser getApplicationUser(java.lang.String userId,
java.lang.String expand)
userId - (required)expand - (optional)@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
date="2021-12-01T11:06:42.145-06:00",
comments="GET - /api/v1/apps/{appId}/users/{userId}")
AppUser getApplicationUser(java.lang.String userId)
userId - (required)@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
date="2021-12-01T11:06:42.145-06:00",
comments="POST - /api/v1/apps/{appId}/credentials/keys/{keyId}/clone")
JsonWebKey cloneApplicationKey(java.lang.String keyId,
java.lang.String targetAid)
keyId - (required)targetAid - Unique key of the target Application (required)@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
date="2021-12-01T11:06:42.145-06:00",
comments="POST - /api/v1/apps/{appId}/credentials/csrs")
Csr generateCsr(CsrMetadata metadata)
metadata - (required)@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
date="2021-12-01T11:06:42.145-06:00",
comments="GET - /api/v1/apps/{appId}/groups")
ApplicationGroupAssignmentList listGroupAssignments(java.lang.String q,
java.lang.String expand)
q - (optional)expand - (optional)@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
date="2021-12-01T11:06:42.145-06:00",
comments="GET - /api/v1/apps/{appId}/groups")
ApplicationGroupAssignmentList listGroupAssignments()
@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
date="2021-12-01T11:06:42.145-06:00",
comments="GET - /api/v1/apps/{appId}/grants")
OAuth2ScopeConsentGrantList listScopeConsentGrants(java.lang.String expand)
expand - (optional)@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
date="2021-12-01T11:06:42.145-06:00",
comments="GET - /api/v1/apps/{appId}/grants")
OAuth2ScopeConsentGrantList listScopeConsentGrants()
@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
date="2021-12-01T11:06:42.145-06:00",
comments="DELETE - /api/v1/apps/{appId}/tokens/{tokenId}")
void revokeOAuth2TokenForApplication(java.lang.String tokenId)
tokenId - (required)@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
date="2021-12-01T11:06:42.145-06:00",
comments="POST - /api/v1/apps/{appId}/credentials/csrs/{csrId}/lifecycle/publish")
JsonWebKey publishBinaryCerCert(java.lang.String csrId)
csrId - (required)@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
date="2021-12-01T11:06:42.145-06:00",
comments="DELETE - /api/v1/apps/{appId}/tokens")
void revokeOAuth2Tokens()
@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
date="2021-12-01T11:06:42.145-06:00",
comments="DELETE - /api/v1/apps/{appId}/grants/{grantId}")
void revokeScopeConsentGrant(java.lang.String grantId)
grantId - (required)@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
date="2021-12-01T11:06:42.145-06:00",
comments="POST - /api/v1/apps/{appId}/users")
AppUser assignUserToApplication(AppUser appUser)
appUser - (required)@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
date="2021-12-01T11:06:42.145-06:00",
comments="POST - /api/v1/apps/{appId}/grants")
OAuth2ScopeConsentGrant grantConsentToScope(OAuth2ScopeConsentGrant oAuth2ScopeConsentGrant)
oAuth2ScopeConsentGrant - (required)@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
date="2021-12-01T11:06:42.145-06:00",
comments="DELETE - /api/v1/apps/{appId}")
void delete()
@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
date="2021-12-01T11:06:42.145-06:00",
comments="POST - /api/v1/apps/{appId}/credentials/csrs/{csrId}/lifecycle/publish")
JsonWebKey publishDerCert(java.lang.String csrId)
csrId - (required)@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
date="2021-12-01T11:06:42.145-06:00",
comments="POST - /api/v1/apps/{appId}/lifecycle/activate")
void activate()
@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
date="2021-12-01T11:06:42.145-06:00",
comments="PUT - /api/v1/apps/{appId}/groups/{groupId}")
ApplicationGroupAssignment createApplicationGroupAssignment(java.lang.String groupId,
ApplicationGroupAssignment applicationGroupAssignment)
groupId - (required)applicationGroupAssignment - (optional)@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
date="2021-12-01T11:06:42.145-06:00",
comments="PUT - /api/v1/apps/{appId}/groups/{groupId}")
ApplicationGroupAssignment createApplicationGroupAssignment(java.lang.String groupId)
groupId - (required)@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
date="2021-12-01T11:06:42.145-06:00",
comments="GET - /api/v1/apps/{appId}/groups/{groupId}")
ApplicationGroupAssignment getApplicationGroupAssignment(java.lang.String groupId,
java.lang.String expand)
groupId - (required)expand - (optional)@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
date="2021-12-01T11:06:42.145-06:00",
comments="GET - /api/v1/apps/{appId}/groups/{groupId}")
ApplicationGroupAssignment getApplicationGroupAssignment(java.lang.String groupId)
groupId - (required)@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
date="2021-12-01T11:06:42.145-06:00",
comments="POST - /api/v1/apps/{appId}/credentials/keys/generate")
JsonWebKey generateKey(java.lang.Integer validityYears)
validityYears - (optional)@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
date="2021-12-01T11:06:42.145-06:00",
comments="POST - /api/v1/apps/{appId}/credentials/keys/generate")
JsonWebKey generateKey()
@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
date="2021-12-01T11:06:42.145-06:00",
comments="GET - /api/v1/apps/{appId}/tokens")
OAuth2TokenList listOAuth2Tokens(java.lang.String expand)
expand - (optional)@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
date="2021-12-01T11:06:42.145-06:00",
comments="GET - /api/v1/apps/{appId}/tokens")
OAuth2TokenList listOAuth2Tokens()
@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
date="2021-12-01T11:06:42.145-06:00",
comments="GET - /api/v1/apps/{appId}/grants/{grantId}")
OAuth2ScopeConsentGrant getScopeConsentGrant(java.lang.String grantId,
java.lang.String expand)
grantId - (required)expand - (optional)@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
date="2021-12-01T11:06:42.145-06:00",
comments="GET - /api/v1/apps/{appId}/grants/{grantId}")
OAuth2ScopeConsentGrant getScopeConsentGrant(java.lang.String grantId)
grantId - (required)@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
date="2021-12-01T11:06:42.145-06:00",
comments="POST - /api/v1/apps/{appId}/lifecycle/deactivate")
void deactivate()
@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
date="2021-12-01T11:06:42.145-06:00",
comments="POST - /api/v1/apps/{appId}/credentials/csrs/{csrId}/lifecycle/publish")
JsonWebKey publishBinaryPemCert(java.lang.String csrId)
csrId - (required)@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
date="2021-12-01T11:06:42.145-06:00",
comments="PUT - /api/v1/apps/{appId}")
Application update()
@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
date="2021-12-01T11:06:42.145-06:00",
comments="GET - /api/v1/apps/{appId}/credentials/keys")
JsonWebKeyList listKeys()
@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
date="2021-12-01T11:06:42.145-06:00",
comments="GET - /api/v1/apps/{appId}/tokens/{tokenId}")
OAuth2Token getOAuth2Token(java.lang.String tokenId,
java.lang.String expand)
tokenId - (required)expand - (optional)@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
date="2021-12-01T11:06:42.145-06:00",
comments="GET - /api/v1/apps/{appId}/tokens/{tokenId}")
OAuth2Token getOAuth2Token(java.lang.String tokenId)
tokenId - (required)@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
date="2021-12-01T11:06:42.145-06:00",
comments="GET - /api/v1/apps/{appId}/credentials/csrs")
CsrList listCsrs()
@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
date="2021-12-01T11:06:42.145-06:00",
comments="GET - /api/v1/apps/{appId}/users")
AppUserList listApplicationUsers(java.lang.String q,
java.lang.String queryScope,
java.lang.String filter,
java.lang.String expand)
q - (optional)queryScope - (optional)filter - (optional)expand - (optional)@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
date="2021-12-01T11:06:42.145-06:00",
comments="GET - /api/v1/apps/{appId}/users")
AppUserList listApplicationUsers()
@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
date="2021-12-01T11:06:42.145-06:00",
comments="GET - /api/v1/apps/{appId}/credentials/keys/{keyId}")
JsonWebKey getApplicationKey(java.lang.String keyId)
keyId - (required)@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
date="2021-12-01T11:06:42.145-06:00",
comments="POST - /api/v1/apps/{appId}/credentials/csrs/{csrId}/lifecycle/publish")
JsonWebKey publishCerCert(java.lang.String csrId)
csrId - (required)@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
date="2021-12-01T11:06:42.145-06:00",
comments="POST - /api/v1/apps/{appId}/credentials/csrs/{csrId}/lifecycle/publish")
JsonWebKey publishBinaryDerCert(java.lang.String csrId)
csrId - (required)Copyright © 2017-2021 Okta. All Rights Reserved.