com.okta.sdk.helper

Class ApplicationApiHelper<T extends Application>

java.lang.Object

org.openapitools.client.api.ApplicationApi

com.okta.sdk.helper.ApplicationApiHelper<T>

public final class ApplicationApiHelper<T extends Application>
extends ApplicationApi

Helper class that enables working with subclassed Application references.

Constructor Summary

Constructors

Constructor and Description
ApplicationApiHelper(ApiClient apiClient)
ApplicationApiHelper(ApplicationApi applicationApi)

Method Summary

Modifier and Type	Method and Description
<T extends Application> T	createApplicationOfType(Class<T> classType, Application application, Boolean activate, String oktaAccessGatewayAgent)
T	getApplication(String appId, String expand) Retrieve an Application Retrieves an application from your Okta organization by `id`
List<Application>	listApplications(String q, String after, Integer limit, String filter, String expand, Boolean includeNonDeleted) List all Applications Lists all applications with pagination.
<T extends Application> T	replaceApplicationOfType(Class<T> classType, String appId, Application application)

Methods inherited from class org.openapitools.client.api.ApplicationApi

activateApplication, activateApplication, activateDefaultProvisioningConnectionForApplication, activateDefaultProvisioningConnectionForApplication, assignApplicationPolicy, assignApplicationPolicy, assignGroupToApplication, assignGroupToApplication, assignUserToApplication, assignUserToApplication, cloneApplicationKey, cloneApplicationKey, createApplication, createApplication, deactivateApplication, deactivateApplication, deactivateDefaultProvisioningConnectionForApplication, deactivateDefaultProvisioningConnectionForApplication, deleteApplication, deleteApplication, generateApplicationKey, generateApplicationKey, generateCsrForApplication, generateCsrForApplication, getApiClient, getApplication, getApplicationGroupAssignment, getApplicationGroupAssignment, getApplicationKey, getApplicationKey, getApplicationUser, getApplicationUser, getCsrForApplication, getCsrForApplication, getDefaultProvisioningConnectionForApplication, getDefaultProvisioningConnectionForApplication, getFeatureForApplication, getFeatureForApplication, getOAuth2TokenForApplication, getOAuth2TokenForApplication, getObjectMapper, getScopeConsentGrant, getScopeConsentGrant, grantConsentToScope, grantConsentToScope, listApplicationGroupAssignments, listApplicationGroupAssignments, listApplicationKeys, listApplicationKeys, listApplications, listApplicationUsers, listApplicationUsers, listCsrsForApplication, listCsrsForApplication, listFeaturesForApplication, listFeaturesForApplication, listOAuth2TokensForApplication, listOAuth2TokensForApplication, listScopeConsentGrants, listScopeConsentGrants, publishCsrFromApplication, publishCsrFromApplication, replaceApplication, replaceApplication, revokeCsrFromApplication, revokeCsrFromApplication, revokeOAuth2TokenForApplication, revokeOAuth2TokenForApplication, revokeOAuth2TokensForApplication, revokeOAuth2TokensForApplication, revokeScopeConsentGrant, revokeScopeConsentGrant, setApiClient, unassignApplicationFromGroup, unassignApplicationFromGroup, unassignUserFromApplication, unassignUserFromApplication, updateApplicationUser, updateApplicationUser, updateDefaultProvisioningConnectionForApplication, updateDefaultProvisioningConnectionForApplication, updateFeatureForApplication, updateFeatureForApplication, uploadApplicationLogo, uploadApplicationLogo

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ApplicationApiHelper

public ApplicationApiHelper(ApplicationApi applicationApi)

ApplicationApiHelper

public ApplicationApiHelper(ApiClient apiClient)

Method Detail

createApplicationOfType

public <T extends Application> T createApplicationOfType(Class<T> classType,
                                                         Application application,
                                                         Boolean activate,
                                                         String oktaAccessGatewayAgent)
                                                  throws ApiException

Throws:

ApiException

getApplication

public T getApplication(String appId,
                        String expand)
                 throws ApiException

Description copied from class: ApplicationApi

Retrieve an Application Retrieves an application from your Okta organization by `id`

Overrides:

getApplication in class ApplicationApi

Parameters:

appId - `id` of the Application (required)

expand - (optional)

Returns:

Application

Throws:

ApiException - if fails to make API call

listApplications

public List<Application> listApplications(String q,
                                          String after,
                                          Integer limit,
                                          String filter,
                                          String expand,
                                          Boolean includeNonDeleted)
                                   throws ApiException

Description copied from class: ApplicationApi

List all Applications Lists all applications with pagination. A subset of apps can be returned that match a supported filter expression or query.

Overrides:

listApplications in class ApplicationApi

Parameters:

q - (optional)

after - Specifies the pagination cursor for the next page of apps (optional)

limit - Specifies the number of results for a page (optional, default to -1)

filter - Filters apps by status, user.id, group.id or credentials.signing.kid expression (optional)

expand - Traverses users link relationship and optionally embeds Application User resource (optional)

includeNonDeleted - (optional, default to false)

Returns:

List<Application>

Throws:

ApiException - if fails to make API call

replaceApplicationOfType

public <T extends Application> T replaceApplicationOfType(Class<T> classType,
                                                          String appId,
                                                          Application application)
                                                   throws ApiException

Throws:

ApiException