Package com.okta.sdk.resource.api

Class ApplicationApi

java.lang.Object

com.okta.sdk.resource.api.ApplicationApi

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2024-03-29T16:46:27.777599-05:00[America/Chicago]",
           comments="Generator version: 7.4.0")
public class ApplicationApi
extends Object

Constructor Summary

Constructors

Constructor	Description
ApplicationApi()
ApplicationApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
void	activateApplication(String appId)	Activate an Application Activates an inactive application
void	activateApplication(String appId, Map<String,String> additionalHeaders)	Activate an Application Activates an inactive application
Application	createApplication(Application application, Boolean activate, String oktaAccessGatewayAgent)	Create an Application Creates a new application to your Okta organization
Application	createApplication(Application application, Boolean activate, String oktaAccessGatewayAgent, Map<String,String> additionalHeaders)	Create an Application Creates a new application to your Okta organization
void	deactivateApplication(String appId)	Deactivate an Application Deactivates an active application
void	deactivateApplication(String appId, Map<String,String> additionalHeaders)	Deactivate an Application Deactivates an active application
void	deleteApplication(String appId)	Delete an Application Deletes an inactive application
void	deleteApplication(String appId, Map<String,String> additionalHeaders)	Delete an Application Deletes an inactive application
ApiClient	getApiClient()
Application	getApplication(String appId, String expand)	Retrieve an Application Retrieves an application from your Okta organization by `id`
Application	getApplication(String appId, String expand, Map<String,String> additionalHeaders)	Retrieve an Application Retrieves an application from your Okta organization by `id`
protected static com.fasterxml.jackson.databind.ObjectMapper	getObjectMapper()
List<Application>	listApplications(String q, String after, Integer limit, String filter, String expand, Boolean includeNonDeleted)	List all Applications Lists all applications with pagination.
List<Application>	listApplications(String q, String after, Integer limit, String filter, String expand, Boolean includeNonDeleted, Map<String,String> additionalHeaders)	List all Applications Lists all applications with pagination.
Application	replaceApplication(String appId, Application application)	Replace an Application Replaces an application
Application	replaceApplication(String appId, Application application, Map<String,String> additionalHeaders)	Replace an Application Replaces an application
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Details

ApplicationApi

public ApplicationApi()

ApplicationApi

public ApplicationApi(ApiClient apiClient)

Method Details

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

activateApplication

public void activateApplication(String appId)
                         throws ApiException

Activate an Application Activates an inactive application

Parameters:

appId - ID of the Application (required)

Throws:

ApiException - if fails to make API call

activateApplication

public void activateApplication(String appId,
 Map<String,String> additionalHeaders)
                         throws ApiException

Activate an Application Activates an inactive application

Parameters:

appId - ID of the Application (required)

additionalHeaders - additionalHeaders for this call

Throws:

ApiException - if fails to make API call

createApplication

public Application createApplication(Application application,
 Boolean activate,
 String oktaAccessGatewayAgent)
                              throws ApiException

Create an Application Creates a new application to your Okta organization

Parameters:

application - (required)

activate - Executes activation lifecycle operation when creating the app (optional, default to true)

oktaAccessGatewayAgent - (optional)

Returns:

Application

Throws:

ApiException - if fails to make API call

createApplication

public Application createApplication(Application application,
 Boolean activate,
 String oktaAccessGatewayAgent,
 Map<String,String> additionalHeaders)
                              throws ApiException

Create an Application Creates a new application to your Okta organization

Parameters:

application - (required)

activate - Executes activation lifecycle operation when creating the app (optional, default to true)

oktaAccessGatewayAgent - (optional)

additionalHeaders - additionalHeaders for this call

Returns:

Application

Throws:

ApiException - if fails to make API call

deactivateApplication

public void deactivateApplication(String appId)
                           throws ApiException

Deactivate an Application Deactivates an active application

Parameters:

appId - ID of the Application (required)

Throws:

ApiException - if fails to make API call

deactivateApplication

public void deactivateApplication(String appId,
 Map<String,String> additionalHeaders)
                           throws ApiException

Deactivate an Application Deactivates an active application

Parameters:

appId - ID of the Application (required)

additionalHeaders - additionalHeaders for this call

Throws:

ApiException - if fails to make API call

deleteApplication

public void deleteApplication(String appId)
                       throws ApiException

Delete an Application Deletes an inactive application

Parameters:

appId - ID of the Application (required)

Throws:

ApiException - if fails to make API call

deleteApplication

public void deleteApplication(String appId,
 Map<String,String> additionalHeaders)
                       throws ApiException

Delete an Application Deletes an inactive application

Parameters:

appId - ID of the Application (required)

additionalHeaders - additionalHeaders for this call

Throws:

ApiException - if fails to make API call

getApplication

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

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

Parameters:

appId - ID of the Application (required)

expand - (optional)

Returns:

Application

Throws:

ApiException - if fails to make API call

getApplication

public Application getApplication(String appId,
 String expand,
 Map<String,String> additionalHeaders)
                           throws ApiException

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

Parameters:

appId - ID of the Application (required)

expand - (optional)

additionalHeaders - additionalHeaders for this call

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

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

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

listApplications

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

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

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)

additionalHeaders - additionalHeaders for this call

Returns:

List<Application>

Throws:

ApiException - if fails to make API call

replaceApplication

public Application replaceApplication(String appId,
 Application application)
                               throws ApiException

Replace an Application Replaces an application

Parameters:

appId - ID of the Application (required)

application - (required)

Returns:

Application

Throws:

ApiException - if fails to make API call

replaceApplication

public Application replaceApplication(String appId,
 Application application,
 Map<String,String> additionalHeaders)
                               throws ApiException

Replace an Application Replaces an application

Parameters:

appId - ID of the Application (required)

application - (required)

additionalHeaders - additionalHeaders for this call

Returns:

Application

Throws:

ApiException - if fails to make API call

getObjectMapper

protected static com.fasterxml.jackson.databind.ObjectMapper getObjectMapper()