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="2026-03-13T17:36:05.533634+05:30[Asia/Kolkata]", comments="Generator version: 7.15.0") public class ApplicationApi extends Object

  • 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 - Application ID (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 - Application ID (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 an app instance in your Okta org. You can either create an OIN app instance or a custom app instance: * OIN app instances have prescribed `name` (key app definition) and `signOnMode` options. See the [OIN schemas](/openapi/okta-management/management/tag/Application/#tag/Application/schema/GoogleApplication) for the request body. * For custom app instances, select the [signOnMode](/openapi/okta-management/management/tag/Application/#tag/Application/operation/createApplication!path=0/signOnMode&t=request) that pertains to your app and specify the required parameters in the request body.
      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 an app instance in your Okta org. You can either create an OIN app instance or a custom app instance: * OIN app instances have prescribed `name` (key app definition) and `signOnMode` options. See the [OIN schemas](/openapi/okta-management/management/tag/Application/#tag/Application/schema/GoogleApplication) for the request body. * For custom app instances, select the [signOnMode](/openapi/okta-management/management/tag/Application/#tag/Application/operation/createApplication!path=0/signOnMode&t=request) that pertains to your app and specify the required parameters in the request body.
      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 > **Note:** Deactivating an app triggers a full reconciliation of all users assigned to the app by groups. This reconcile process removes the app assignment for the deactivated app, and might also correct assignments that were supposed to be removed but failed previously.
      Parameters:
      appId - Application ID (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 > **Note:** Deactivating an app triggers a full reconciliation of all users assigned to the app by groups. This reconcile process removes the app assignment for the deactivated app, and might also correct assignments that were supposed to be removed but failed previously.
      Parameters:
      appId - Application ID (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 - Application ID (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 - Application ID (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 - Application ID (required)
      expand - An optional query parameter to return the specified [Application User](/openapi/okta-management/management/tag/ApplicationUsers/) in the `_embedded` property. Valid value: `expand=user/{userId}` (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 - Application ID (required)
      expand - An optional query parameter to return the specified [Application User](/openapi/okta-management/management/tag/ApplicationUsers/) in the `_embedded` property. Valid value: `expand=user/{userId}` (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, Boolean useOptimization, Boolean alwaysIncludeVpnSettings, Integer limit, String filter, String expand, Boolean includeNonDeleted) throws ApiException
      List all applications Lists all apps in the org with pagination. A subset of apps can be returned that match a supported filter expression or query. The results are [paginated](/#pagination) according to the `limit` parameter. If there are multiple pages of results, the header contains a `next` link. Treat the link as an opaque value (follow it, don't parse it). > **Note:** To list all of a member's assigned app links, use the [List all assigned app links endpoint in the User Resources API](/openapi/okta-management/management/tag/UserResources/#tag/UserResources/operation/listAppLinks).
      Parameters:
      q - Searches for apps with `name` or `label` properties that starts with the `q` value using the `startsWith` operation (optional)
      after - Specifies the [pagination](/#pagination) cursor for the next page of results. Treat this as an opaque value obtained through the `next` link relationship. (optional)
      useOptimization - Specifies whether to use query optimization. If you specify `useOptimization=true` in the request query, the response contains a subset of app instance properties. (optional, default to false)
      alwaysIncludeVpnSettings - Specifies whether to include the VPN configuration for existing notifications in the result, regardless of whether VPN notifications are configured (optional, default to false)
      limit - Specifies the number of results per page (optional, default to -1)
      filter - Filters apps with a supported expression for a subset of properties. Filtering supports the following limited number of properties: `id`, `status`, `credentials.signing.kid`, `settings.slo.enabled`, or `name`. See [Filter](https://developer.okta.com/docs/api/#filter). (optional)
      expand - An optional parameter used for link expansion to embed more resources in the response. Only supports `expand=user/{userId}` and must be used with the `user.id eq \"{userId}\"` filter query for the same user. Returns the assigned [application user](/openapi/okta-management/management/tag/ApplicationUsers/) in the `_embedded` property. (optional)
      includeNonDeleted - Specifies whether to include non-active, but not deleted apps in the results (optional, default to false)
      Returns:
      List<Application>
      Throws:
      ApiException - if fails to make API call

    • listApplications

      public List<Application> listApplications(String q, String after, Boolean useOptimization, Boolean alwaysIncludeVpnSettings, Integer limit, String filter, String expand, Boolean includeNonDeleted, Map<String,String> additionalHeaders) throws ApiException
      List all applications Lists all apps in the org with pagination. A subset of apps can be returned that match a supported filter expression or query. The results are [paginated](/#pagination) according to the `limit` parameter. If there are multiple pages of results, the header contains a `next` link. Treat the link as an opaque value (follow it, don't parse it). > **Note:** To list all of a member's assigned app links, use the [List all assigned app links endpoint in the User Resources API](/openapi/okta-management/management/tag/UserResources/#tag/UserResources/operation/listAppLinks).
      Parameters:
      q - Searches for apps with `name` or `label` properties that starts with the `q` value using the `startsWith` operation (optional)
      after - Specifies the [pagination](/#pagination) cursor for the next page of results. Treat this as an opaque value obtained through the `next` link relationship. (optional)
      useOptimization - Specifies whether to use query optimization. If you specify `useOptimization=true` in the request query, the response contains a subset of app instance properties. (optional, default to false)
      alwaysIncludeVpnSettings - Specifies whether to include the VPN configuration for existing notifications in the result, regardless of whether VPN notifications are configured (optional, default to false)
      limit - Specifies the number of results per page (optional, default to -1)
      filter - Filters apps with a supported expression for a subset of properties. Filtering supports the following limited number of properties: `id`, `status`, `credentials.signing.kid`, `settings.slo.enabled`, or `name`. See [Filter](https://developer.okta.com/docs/api/#filter). (optional)
      expand - An optional parameter used for link expansion to embed more resources in the response. Only supports `expand=user/{userId}` and must be used with the `user.id eq \"{userId}\"` filter query for the same user. Returns the assigned [application user](/openapi/okta-management/management/tag/ApplicationUsers/) in the `_embedded` property. (optional)
      includeNonDeleted - Specifies whether to include non-active, but not deleted apps in the results (optional, default to false)
      additionalHeaders - additionalHeaders for this call
      Returns:
      List<Application>
      Throws:
      ApiException - if fails to make API call

    • listApplicationsPaged

      public Iterable<Application> listApplicationsPaged(String q, String after, Boolean useOptimization, Boolean alwaysIncludeVpnSettings, Integer limit, String filter, String expand, Boolean includeNonDeleted)
      List all applications (Paginated) Lists all apps in the org with pagination. A subset of apps can be returned that match a supported filter expression or query. The results are [paginated](/#pagination) according to the `limit` parameter. If there are multiple pages of results, the header contains a `next` link. Treat the link as an opaque value (follow it, don't parse it). > **Note:** To list all of a member's assigned app links, use the [List all assigned app links endpoint in the User Resources API](/openapi/okta-management/management/tag/UserResources/#tag/UserResources/operation/listAppLinks). This method returns a lazy, paginated iterable that automatically handles pagination. It is thread-safe and does not cause memory leaks. Use this method in a for-each loop to automatically fetch all pages without manual cursor management.
      Parameters:
      q - Searches for apps with `name` or `label` properties that starts with the `q` value using the `startsWith` operation (optional)
      after - Specifies the [pagination](/#pagination) cursor for the next page of results. Treat this as an opaque value obtained through the `next` link relationship. (optional)
      useOptimization - Specifies whether to use query optimization. If you specify `useOptimization=true` in the request query, the response contains a subset of app instance properties. (optional, default to false)
      alwaysIncludeVpnSettings - Specifies whether to include the VPN configuration for existing notifications in the result, regardless of whether VPN notifications are configured (optional, default to false)
      limit - Specifies the number of results per page (optional, default to -1)
      filter - Filters apps with a supported expression for a subset of properties. Filtering supports the following limited number of properties: `id`, `status`, `credentials.signing.kid`, `settings.slo.enabled`, or `name`. See [Filter](https://developer.okta.com/docs/api/#filter). (optional)
      expand - An optional parameter used for link expansion to embed more resources in the response. Only supports `expand=user/{userId}` and must be used with the `user.id eq \"{userId}\"` filter query for the same user. Returns the assigned [application user](/openapi/okta-management/management/tag/ApplicationUsers/) in the `_embedded` property. (optional)
      includeNonDeleted - Specifies whether to include non-active, but not deleted apps in the results (optional, default to false)
      Returns:
      Iterable<Application> lazy iterable over all pages

    • listApplicationsPaged

      public Iterable<Application> listApplicationsPaged(String q, String after, Boolean useOptimization, Boolean alwaysIncludeVpnSettings, Integer limit, String filter, String expand, Boolean includeNonDeleted, Map<String,String> additionalHeaders)
      List all applications (Paginated with additional headers) Lists all apps in the org with pagination. A subset of apps can be returned that match a supported filter expression or query. The results are [paginated](/#pagination) according to the `limit` parameter. If there are multiple pages of results, the header contains a `next` link. Treat the link as an opaque value (follow it, don't parse it). > **Note:** To list all of a member's assigned app links, use the [List all assigned app links endpoint in the User Resources API](/openapi/okta-management/management/tag/UserResources/#tag/UserResources/operation/listAppLinks). This method returns a lazy, paginated iterable that automatically handles pagination. It is thread-safe and does not cause memory leaks.
      Parameters:
      q - Searches for apps with `name` or `label` properties that starts with the `q` value using the `startsWith` operation (optional)
      after - Specifies the [pagination](/#pagination) cursor for the next page of results. Treat this as an opaque value obtained through the `next` link relationship. (optional)
      useOptimization - Specifies whether to use query optimization. If you specify `useOptimization=true` in the request query, the response contains a subset of app instance properties. (optional, default to false)
      alwaysIncludeVpnSettings - Specifies whether to include the VPN configuration for existing notifications in the result, regardless of whether VPN notifications are configured (optional, default to false)
      limit - Specifies the number of results per page (optional, default to -1)
      filter - Filters apps with a supported expression for a subset of properties. Filtering supports the following limited number of properties: `id`, `status`, `credentials.signing.kid`, `settings.slo.enabled`, or `name`. See [Filter](https://developer.okta.com/docs/api/#filter). (optional)
      expand - An optional parameter used for link expansion to embed more resources in the response. Only supports `expand=user/{userId}` and must be used with the `user.id eq \"{userId}\"` filter query for the same user. Returns the assigned [application user](/openapi/okta-management/management/tag/ApplicationUsers/) in the `_embedded` property. (optional)
      includeNonDeleted - Specifies whether to include non-active, but not deleted apps in the results (optional, default to false)
      additionalHeaders - additional headers for this call
      Returns:
      Iterable<Application> lazy iterable over all pages

    • replaceApplication

      public Application replaceApplication(String appId, Application application) throws ApiException
      Replace an application Replaces properties for an application > **Notes:** > * All required properties must be specified in the request body > * You can't modify system-assigned properties, such as `id`, `name`, `status`, `created`, and `lastUpdated`. The values for these properties in the PUT request body are ignored.
      Parameters:
      appId - Application ID (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 properties for an application > **Notes:** > * All required properties must be specified in the request body > * You can't modify system-assigned properties, such as `id`, `name`, `status`, `created`, and `lastUpdated`. The values for these properties in the PUT request body are ignored.
      Parameters:
      appId - Application ID (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()