Package org.openapitools.client.api

Class ApplicationApi

java.lang.Object
org.openapitools.client.api.ApplicationApi
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", date="2023-04-19T09:13:44.263607-05:00[America/Chicago]") @Component("org.openapitools.client.api.ApplicationApi") public class ApplicationApi extends Object

  • Constructor Details

    • ApplicationApi

      public ApplicationApi()

    • ApplicationApi

      @Autowired public ApplicationApi(ApiClient apiClient)

  • Method Details

    • getApiClient

      public ApiClient getApiClient()

    • setApiClient

      public void setApiClient(ApiClient apiClient)

    • activateApplication

      public void activateApplication(String appId) throws org.springframework.web.client.RestClientException
      Activate an Application Activates an inactive application

      200 - Success

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      appId - (required)
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • activateApplicationWithHttpInfo

      public org.springframework.http.ResponseEntity<Void> activateApplicationWithHttpInfo(String appId) throws org.springframework.web.client.RestClientException
      Activate an Application Activates an inactive application

      200 - Success

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      appId - (required)
      Returns:
      ResponseEntity<Void>
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • activateDefaultProvisioningConnectionForApplication

      public void activateDefaultProvisioningConnectionForApplication(String appId) throws org.springframework.web.client.RestClientException
      Activate the default Provisioning Connection Activates the default Provisioning Connection for an application

      204 - No Content

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      appId - (required)
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • activateDefaultProvisioningConnectionForApplicationWithHttpInfo

      public org.springframework.http.ResponseEntity<Void> activateDefaultProvisioningConnectionForApplicationWithHttpInfo(String appId) throws org.springframework.web.client.RestClientException
      Activate the default Provisioning Connection Activates the default Provisioning Connection for an application

      204 - No Content

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      appId - (required)
      Returns:
      ResponseEntity<Void>
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • assignApplicationPolicy

      public void assignApplicationPolicy(String appId, String policyId) throws org.springframework.web.client.RestClientException
      Assign an application to a specific policy Assign an application to a specific policy. This unassigns the application from its currently assigned policy.

      204 - No Content

      Parameters:
      appId - (required)
      policyId - (required)
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • assignApplicationPolicyWithHttpInfo

      public org.springframework.http.ResponseEntity<Void> assignApplicationPolicyWithHttpInfo(String appId, String policyId) throws org.springframework.web.client.RestClientException
      Assign an application to a specific policy Assign an application to a specific policy. This unassigns the application from its currently assigned policy.

      204 - No Content

      Parameters:
      appId - (required)
      policyId - (required)
      Returns:
      ResponseEntity<Void>
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • assignGroupToApplication

      public ApplicationGroupAssignment assignGroupToApplication(String appId, String groupId, ApplicationGroupAssignment applicationGroupAssignment) throws org.springframework.web.client.RestClientException
      Assign a Group Assigns a group to an application

      200 - Success

      400 - Bad Request

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      appId - (required)
      groupId - (required)
      applicationGroupAssignment - (optional)
      Returns:
      ApplicationGroupAssignment
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • assignGroupToApplication

      public <T> T assignGroupToApplication(Class<?> T, String appId, String groupId, ApplicationGroupAssignment applicationGroupAssignment) throws org.springframework.web.client.RestClientException
      Assign a Group Assigns a group to an application

      200 - Success

      400 - Bad Request

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      T - (required) - the assignable return type
      appId - (required)
      groupId - (required)
      applicationGroupAssignment - (optional)
      Returns:
      T instance
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • assignGroupToApplicationWithHttpInfo

      public org.springframework.http.ResponseEntity<ApplicationGroupAssignment> assignGroupToApplicationWithHttpInfo(String appId, String groupId, ApplicationGroupAssignment applicationGroupAssignment) throws org.springframework.web.client.RestClientException
      Assign a Group Assigns a group to an application

      200 - Success

      400 - Bad Request

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      appId - (required)
      groupId - (required)
      applicationGroupAssignment - (optional)
      Returns:
      ResponseEntity<ApplicationGroupAssignment>
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • assignGroupToApplicationWithPaginationInfo

      public PagedList assignGroupToApplicationWithPaginationInfo(String appId, String groupId, ApplicationGroupAssignment applicationGroupAssignment) throws org.springframework.web.client.RestClientException
      Assign a Group Assigns a group to an application

      200 - Success

      400 - Bad Request

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      appId - (required)
      groupId - (required)
      applicationGroupAssignment - (optional)
      Returns:
      ResponseEntity<ApplicationGroupAssignment>
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • assignUserToApplication

      public AppUser assignUserToApplication(String appId, AppUser appUser) throws org.springframework.web.client.RestClientException
      Assign a User Assigns an user to an application with [credentials](#application-user-credentials-object) and an app-specific [profile](#application-user-profile-object). Profile mappings defined for the application are first applied before applying any profile properties specified in the request.

      200 - Success

      400 - Bad Request

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      appId - (required)
      appUser - (required)
      Returns:
      AppUser
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • assignUserToApplication

      public <T> T assignUserToApplication(Class<?> T, String appId, AppUser appUser) throws org.springframework.web.client.RestClientException
      Assign a User Assigns an user to an application with [credentials](#application-user-credentials-object) and an app-specific [profile](#application-user-profile-object). Profile mappings defined for the application are first applied before applying any profile properties specified in the request.

      200 - Success

      400 - Bad Request

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      T - (required) - the assignable return type
      appId - (required)
      appUser - (required)
      Returns:
      T instance
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • assignUserToApplicationWithHttpInfo

      public org.springframework.http.ResponseEntity<AppUser> assignUserToApplicationWithHttpInfo(String appId, AppUser appUser) throws org.springframework.web.client.RestClientException
      Assign a User Assigns an user to an application with [credentials](#application-user-credentials-object) and an app-specific [profile](#application-user-profile-object). Profile mappings defined for the application are first applied before applying any profile properties specified in the request.

      200 - Success

      400 - Bad Request

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      appId - (required)
      appUser - (required)
      Returns:
      ResponseEntity<AppUser>
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • assignUserToApplicationWithPaginationInfo

      public PagedList assignUserToApplicationWithPaginationInfo(String appId, AppUser appUser) throws org.springframework.web.client.RestClientException
      Assign a User Assigns an user to an application with [credentials](#application-user-credentials-object) and an app-specific [profile](#application-user-profile-object). Profile mappings defined for the application are first applied before applying any profile properties specified in the request.

      200 - Success

      400 - Bad Request

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      appId - (required)
      appUser - (required)
      Returns:
      ResponseEntity<AppUser>
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • cloneApplicationKey

      public JsonWebKey cloneApplicationKey(String appId, String keyId, String targetAid) throws org.springframework.web.client.RestClientException
      Clone a Key Credential Clones a X.509 certificate for an application key credential from a source application to target application.

      201 - Created

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      appId - (required)
      keyId - (required)
      targetAid - Unique key of the target Application (required)
      Returns:
      JsonWebKey
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • cloneApplicationKeyWithHttpInfo

      public org.springframework.http.ResponseEntity<JsonWebKey> cloneApplicationKeyWithHttpInfo(String appId, String keyId, String targetAid) throws org.springframework.web.client.RestClientException
      Clone a Key Credential Clones a X.509 certificate for an application key credential from a source application to target application.

      201 - Created

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      appId - (required)
      keyId - (required)
      targetAid - Unique key of the target Application (required)
      Returns:
      ResponseEntity<JsonWebKey>
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • cloneApplicationKeyWithPaginationInfo

      public PagedList cloneApplicationKeyWithPaginationInfo(String appId, String keyId, String targetAid) throws org.springframework.web.client.RestClientException
      Clone a Key Credential Clones a X.509 certificate for an application key credential from a source application to target application.

      201 - Created

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      appId - (required)
      keyId - (required)
      targetAid - Unique key of the target Application (required)
      Returns:
      ResponseEntity<JsonWebKey>
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • createApplication

      public Application createApplication(Application application, Boolean activate, String oktaAccessGatewayAgent) throws org.springframework.web.client.RestClientException
      Create an Application Creates a new application to your Okta organization

      200 - Success

      400 - Bad Request

      403 - Forbidden

      429 - Too Many Requests

      Parameters:
      application - (required)
      activate - Executes activation lifecycle operation when creating the app (optional, default to true)
      oktaAccessGatewayAgent - (optional)
      Returns:
      Application
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • createApplication

      public <T> T createApplication(Class<?> T, Application application, Boolean activate, String oktaAccessGatewayAgent) throws org.springframework.web.client.RestClientException
      Create an Application Creates a new application to your Okta organization

      200 - Success

      400 - Bad Request

      403 - Forbidden

      429 - Too Many Requests

      Parameters:
      T - (required) - the assignable return type
      application - (required)
      activate - Executes activation lifecycle operation when creating the app (optional, default to true)
      oktaAccessGatewayAgent - (optional)
      Returns:
      T instance
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • createApplicationWithHttpInfo

      public org.springframework.http.ResponseEntity<Application> createApplicationWithHttpInfo(Application application, Boolean activate, String oktaAccessGatewayAgent) throws org.springframework.web.client.RestClientException
      Create an Application Creates a new application to your Okta organization

      200 - Success

      400 - Bad Request

      403 - Forbidden

      429 - Too Many Requests

      Parameters:
      application - (required)
      activate - Executes activation lifecycle operation when creating the app (optional, default to true)
      oktaAccessGatewayAgent - (optional)
      Returns:
      ResponseEntity<Application>
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • createApplicationWithPaginationInfo

      public PagedList createApplicationWithPaginationInfo(Application application, Boolean activate, String oktaAccessGatewayAgent) throws org.springframework.web.client.RestClientException
      Create an Application Creates a new application to your Okta organization

      200 - Success

      400 - Bad Request

      403 - Forbidden

      429 - Too Many Requests

      Parameters:
      application - (required)
      activate - Executes activation lifecycle operation when creating the app (optional, default to true)
      oktaAccessGatewayAgent - (optional)
      Returns:
      ResponseEntity<Application>
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • deactivateApplication

      public void deactivateApplication(String appId) throws org.springframework.web.client.RestClientException
      Deactivate an Application Deactivates an active application

      200 - Success

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      appId - (required)
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • deactivateApplicationWithHttpInfo

      public org.springframework.http.ResponseEntity<Void> deactivateApplicationWithHttpInfo(String appId) throws org.springframework.web.client.RestClientException
      Deactivate an Application Deactivates an active application

      200 - Success

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      appId - (required)
      Returns:
      ResponseEntity<Void>
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • deactivateDefaultProvisioningConnectionForApplication

      public void deactivateDefaultProvisioningConnectionForApplication(String appId) throws org.springframework.web.client.RestClientException
      Deactivate the default Provisioning Connection for an Application Deactivates the default Provisioning Connection for an application

      204 - No Content

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      appId - (required)
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • deactivateDefaultProvisioningConnectionForApplicationWithHttpInfo

      public org.springframework.http.ResponseEntity<Void> deactivateDefaultProvisioningConnectionForApplicationWithHttpInfo(String appId) throws org.springframework.web.client.RestClientException
      Deactivate the default Provisioning Connection for an Application Deactivates the default Provisioning Connection for an application

      204 - No Content

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      appId - (required)
      Returns:
      ResponseEntity<Void>
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • deleteApplication

      public void deleteApplication(String appId) throws org.springframework.web.client.RestClientException
      Delete an Application Deletes an inactive application

      204 - No Content

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      appId - (required)
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • deleteApplicationWithHttpInfo

      public org.springframework.http.ResponseEntity<Void> deleteApplicationWithHttpInfo(String appId) throws org.springframework.web.client.RestClientException
      Delete an Application Deletes an inactive application

      204 - No Content

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      appId - (required)
      Returns:
      ResponseEntity<Void>
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • generateApplicationKey

      public JsonWebKey generateApplicationKey(String appId, Integer validityYears) throws org.springframework.web.client.RestClientException
      Generate a Key Credential Generates a new X.509 certificate for an application key credential

      201 - Created

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      appId - (required)
      validityYears - (optional)
      Returns:
      JsonWebKey
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • generateApplicationKeyWithHttpInfo

      public org.springframework.http.ResponseEntity<JsonWebKey> generateApplicationKeyWithHttpInfo(String appId, Integer validityYears) throws org.springframework.web.client.RestClientException
      Generate a Key Credential Generates a new X.509 certificate for an application key credential

      201 - Created

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      appId - (required)
      validityYears - (optional)
      Returns:
      ResponseEntity<JsonWebKey>
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • generateApplicationKeyWithPaginationInfo

      public PagedList generateApplicationKeyWithPaginationInfo(String appId, Integer validityYears) throws org.springframework.web.client.RestClientException
      Generate a Key Credential Generates a new X.509 certificate for an application key credential

      201 - Created

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      appId - (required)
      validityYears - (optional)
      Returns:
      ResponseEntity<JsonWebKey>
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • generateCsrForApplication

      public Csr generateCsrForApplication(String appId, CsrMetadata metadata) throws org.springframework.web.client.RestClientException
      Generate a Certificate Signing Request Generates a new key pair and returns the Certificate Signing Request for it

      201 - Created

      400 - Bad Request

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      appId - (required)
      metadata - (required)
      Returns:
      Csr
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • generateCsrForApplication

      public <T> T generateCsrForApplication(Class<?> T, String appId, CsrMetadata metadata) throws org.springframework.web.client.RestClientException
      Generate a Certificate Signing Request Generates a new key pair and returns the Certificate Signing Request for it

      201 - Created

      400 - Bad Request

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      T - (required) - the assignable return type
      appId - (required)
      metadata - (required)
      Returns:
      T instance
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • generateCsrForApplicationWithHttpInfo

      public org.springframework.http.ResponseEntity<Csr> generateCsrForApplicationWithHttpInfo(String appId, CsrMetadata metadata) throws org.springframework.web.client.RestClientException
      Generate a Certificate Signing Request Generates a new key pair and returns the Certificate Signing Request for it

      201 - Created

      400 - Bad Request

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      appId - (required)
      metadata - (required)
      Returns:
      ResponseEntity<Csr>
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • generateCsrForApplicationWithPaginationInfo

      public PagedList generateCsrForApplicationWithPaginationInfo(String appId, CsrMetadata metadata) throws org.springframework.web.client.RestClientException
      Generate a Certificate Signing Request Generates a new key pair and returns the Certificate Signing Request for it

      201 - Created

      400 - Bad Request

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      appId - (required)
      metadata - (required)
      Returns:
      ResponseEntity<Csr>
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • getApplication

      public Application getApplication(String appId, String expand) throws org.springframework.web.client.RestClientException
      Retrieve an Application Retrieves an application from your Okta organization by `id`

      200 - Success

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      appId - (required)
      expand - (optional)
      Returns:
      Application
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • getApplicationWithHttpInfo

      public org.springframework.http.ResponseEntity<Application> getApplicationWithHttpInfo(String appId, String expand) throws org.springframework.web.client.RestClientException
      Retrieve an Application Retrieves an application from your Okta organization by `id`

      200 - Success

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      appId - (required)
      expand - (optional)
      Returns:
      ResponseEntity<Application>
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • getApplicationWithPaginationInfo

      public PagedList getApplicationWithPaginationInfo(String appId, String expand) throws org.springframework.web.client.RestClientException
      Retrieve an Application Retrieves an application from your Okta organization by `id`

      200 - Success

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      appId - (required)
      expand - (optional)
      Returns:
      ResponseEntity<Application>
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • getApplicationGroupAssignment

      public ApplicationGroupAssignment getApplicationGroupAssignment(String appId, String groupId, String expand) throws org.springframework.web.client.RestClientException
      Retrieve an Assigned Group Retrieves an application group assignment

      200 - Success

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      appId - (required)
      groupId - (required)
      expand - (optional)
      Returns:
      ApplicationGroupAssignment
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • getApplicationGroupAssignmentWithHttpInfo

      public org.springframework.http.ResponseEntity<ApplicationGroupAssignment> getApplicationGroupAssignmentWithHttpInfo(String appId, String groupId, String expand) throws org.springframework.web.client.RestClientException
      Retrieve an Assigned Group Retrieves an application group assignment

      200 - Success

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      appId - (required)
      groupId - (required)
      expand - (optional)
      Returns:
      ResponseEntity<ApplicationGroupAssignment>
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • getApplicationGroupAssignmentWithPaginationInfo

      public PagedList getApplicationGroupAssignmentWithPaginationInfo(String appId, String groupId, String expand) throws org.springframework.web.client.RestClientException
      Retrieve an Assigned Group Retrieves an application group assignment

      200 - Success

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      appId - (required)
      groupId - (required)
      expand - (optional)
      Returns:
      ResponseEntity<ApplicationGroupAssignment>
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • getApplicationKey

      public JsonWebKey getApplicationKey(String appId, String keyId) throws org.springframework.web.client.RestClientException
      Retrieve a Key Credential Retrieves a specific application key credential by kid

      200 - Success

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      appId - (required)
      keyId - (required)
      Returns:
      JsonWebKey
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • getApplicationKeyWithHttpInfo

      public org.springframework.http.ResponseEntity<JsonWebKey> getApplicationKeyWithHttpInfo(String appId, String keyId) throws org.springframework.web.client.RestClientException
      Retrieve a Key Credential Retrieves a specific application key credential by kid

      200 - Success

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      appId - (required)
      keyId - (required)
      Returns:
      ResponseEntity<JsonWebKey>
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • getApplicationKeyWithPaginationInfo

      public PagedList getApplicationKeyWithPaginationInfo(String appId, String keyId) throws org.springframework.web.client.RestClientException
      Retrieve a Key Credential Retrieves a specific application key credential by kid

      200 - Success

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      appId - (required)
      keyId - (required)
      Returns:
      ResponseEntity<JsonWebKey>
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • getApplicationUser

      public AppUser getApplicationUser(String appId, String userId, String expand) throws org.springframework.web.client.RestClientException
      Retrieve an Assigned User Retrieves a specific user assignment for application by `id`

      200 - Success

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      appId - (required)
      userId - (required)
      expand - (optional)
      Returns:
      AppUser
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • getApplicationUserWithHttpInfo

      public org.springframework.http.ResponseEntity<AppUser> getApplicationUserWithHttpInfo(String appId, String userId, String expand) throws org.springframework.web.client.RestClientException
      Retrieve an Assigned User Retrieves a specific user assignment for application by `id`

      200 - Success

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      appId - (required)
      userId - (required)
      expand - (optional)
      Returns:
      ResponseEntity<AppUser>
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • getApplicationUserWithPaginationInfo

      public PagedList getApplicationUserWithPaginationInfo(String appId, String userId, String expand) throws org.springframework.web.client.RestClientException
      Retrieve an Assigned User Retrieves a specific user assignment for application by `id`

      200 - Success

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      appId - (required)
      userId - (required)
      expand - (optional)
      Returns:
      ResponseEntity<AppUser>
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • getCsrForApplication

      public Csr getCsrForApplication(String appId, String csrId) throws org.springframework.web.client.RestClientException
      Retrieve a Certificate Signing Request Retrieves a certificate signing request for the app by `id`

      200 - Success

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      appId - (required)
      csrId - (required)
      Returns:
      Csr
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • getCsrForApplicationWithHttpInfo

      public org.springframework.http.ResponseEntity<Csr> getCsrForApplicationWithHttpInfo(String appId, String csrId) throws org.springframework.web.client.RestClientException
      Retrieve a Certificate Signing Request Retrieves a certificate signing request for the app by `id`

      200 - Success

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      appId - (required)
      csrId - (required)
      Returns:
      ResponseEntity<Csr>
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • getCsrForApplicationWithPaginationInfo

      public PagedList getCsrForApplicationWithPaginationInfo(String appId, String csrId) throws org.springframework.web.client.RestClientException
      Retrieve a Certificate Signing Request Retrieves a certificate signing request for the app by `id`

      200 - Success

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      appId - (required)
      csrId - (required)
      Returns:
      ResponseEntity<Csr>
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • getDefaultProvisioningConnectionForApplication

      public ProvisioningConnection getDefaultProvisioningConnectionForApplication(String appId) throws org.springframework.web.client.RestClientException
      Retrieve the default Provisioning Connection Retrieves the default Provisioning Connection for application

      200 - Success

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      appId - (required)
      Returns:
      ProvisioningConnection
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • getDefaultProvisioningConnectionForApplicationWithHttpInfo

      public org.springframework.http.ResponseEntity<ProvisioningConnection> getDefaultProvisioningConnectionForApplicationWithHttpInfo(String appId) throws org.springframework.web.client.RestClientException
      Retrieve the default Provisioning Connection Retrieves the default Provisioning Connection for application

      200 - Success

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      appId - (required)
      Returns:
      ResponseEntity<ProvisioningConnection>
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • getDefaultProvisioningConnectionForApplicationWithPaginationInfo

      public PagedList getDefaultProvisioningConnectionForApplicationWithPaginationInfo(String appId) throws org.springframework.web.client.RestClientException
      Retrieve the default Provisioning Connection Retrieves the default Provisioning Connection for application

      200 - Success

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      appId - (required)
      Returns:
      ResponseEntity<ProvisioningConnection>
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • getFeatureForApplication

      public ApplicationFeature getFeatureForApplication(String appId, String name) throws org.springframework.web.client.RestClientException
      Retrieve a Feature Retrieves a Feature object for an application

      200 - Success

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      appId - (required)
      name - (required)
      Returns:
      ApplicationFeature
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • getFeatureForApplicationWithHttpInfo

      public org.springframework.http.ResponseEntity<ApplicationFeature> getFeatureForApplicationWithHttpInfo(String appId, String name) throws org.springframework.web.client.RestClientException
      Retrieve a Feature Retrieves a Feature object for an application

      200 - Success

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      appId - (required)
      name - (required)
      Returns:
      ResponseEntity<ApplicationFeature>
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • getFeatureForApplicationWithPaginationInfo

      public PagedList getFeatureForApplicationWithPaginationInfo(String appId, String name) throws org.springframework.web.client.RestClientException
      Retrieve a Feature Retrieves a Feature object for an application

      200 - Success

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      appId - (required)
      name - (required)
      Returns:
      ResponseEntity<ApplicationFeature>
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • getOAuth2TokenForApplication

      public OAuth2Token getOAuth2TokenForApplication(String appId, String tokenId, String expand) throws org.springframework.web.client.RestClientException
      Retrieve an OAuth 2.0 Token Retrieves a token for the specified application

      200 - Success

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      appId - (required)
      tokenId - (required)
      expand - (optional)
      Returns:
      OAuth2Token
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • getOAuth2TokenForApplicationWithHttpInfo

      public org.springframework.http.ResponseEntity<OAuth2Token> getOAuth2TokenForApplicationWithHttpInfo(String appId, String tokenId, String expand) throws org.springframework.web.client.RestClientException
      Retrieve an OAuth 2.0 Token Retrieves a token for the specified application

      200 - Success

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      appId - (required)
      tokenId - (required)
      expand - (optional)
      Returns:
      ResponseEntity<OAuth2Token>
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • getOAuth2TokenForApplicationWithPaginationInfo

      public PagedList getOAuth2TokenForApplicationWithPaginationInfo(String appId, String tokenId, String expand) throws org.springframework.web.client.RestClientException
      Retrieve an OAuth 2.0 Token Retrieves a token for the specified application

      200 - Success

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      appId - (required)
      tokenId - (required)
      expand - (optional)
      Returns:
      ResponseEntity<OAuth2Token>
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • getScopeConsentGrant

      public OAuth2ScopeConsentGrant getScopeConsentGrant(String appId, String grantId, String expand) throws org.springframework.web.client.RestClientException
      Retrieve a Scope Consent Grant Retrieves a single scope consent grant for the application

      200 - Success

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      appId - (required)
      grantId - (required)
      expand - (optional)
      Returns:
      OAuth2ScopeConsentGrant
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • getScopeConsentGrantWithHttpInfo

      public org.springframework.http.ResponseEntity<OAuth2ScopeConsentGrant> getScopeConsentGrantWithHttpInfo(String appId, String grantId, String expand) throws org.springframework.web.client.RestClientException
      Retrieve a Scope Consent Grant Retrieves a single scope consent grant for the application

      200 - Success

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      appId - (required)
      grantId - (required)
      expand - (optional)
      Returns:
      ResponseEntity<OAuth2ScopeConsentGrant>
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • getScopeConsentGrantWithPaginationInfo

      public PagedList getScopeConsentGrantWithPaginationInfo(String appId, String grantId, String expand) throws org.springframework.web.client.RestClientException
      Retrieve a Scope Consent Grant Retrieves a single scope consent grant for the application

      200 - Success

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      appId - (required)
      grantId - (required)
      expand - (optional)
      Returns:
      ResponseEntity<OAuth2ScopeConsentGrant>
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • grantConsentToScope

      public OAuth2ScopeConsentGrant grantConsentToScope(String appId, OAuth2ScopeConsentGrant oAuth2ScopeConsentGrant) throws org.springframework.web.client.RestClientException
      Grant Consent to Scope Grants consent for the application to request an OAuth 2.0 Okta scope

      201 - Created

      400 - Bad Request

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      appId - (required)
      oAuth2ScopeConsentGrant - (required)
      Returns:
      OAuth2ScopeConsentGrant
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • grantConsentToScope

      public <T> T grantConsentToScope(Class<?> T, String appId, OAuth2ScopeConsentGrant oAuth2ScopeConsentGrant) throws org.springframework.web.client.RestClientException
      Grant Consent to Scope Grants consent for the application to request an OAuth 2.0 Okta scope

      201 - Created

      400 - Bad Request

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      T - (required) - the assignable return type
      appId - (required)
      oAuth2ScopeConsentGrant - (required)
      Returns:
      T instance
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • grantConsentToScopeWithHttpInfo

      public org.springframework.http.ResponseEntity<OAuth2ScopeConsentGrant> grantConsentToScopeWithHttpInfo(String appId, OAuth2ScopeConsentGrant oAuth2ScopeConsentGrant) throws org.springframework.web.client.RestClientException
      Grant Consent to Scope Grants consent for the application to request an OAuth 2.0 Okta scope

      201 - Created

      400 - Bad Request

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      appId - (required)
      oAuth2ScopeConsentGrant - (required)
      Returns:
      ResponseEntity<OAuth2ScopeConsentGrant>
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • grantConsentToScopeWithPaginationInfo

      public PagedList grantConsentToScopeWithPaginationInfo(String appId, OAuth2ScopeConsentGrant oAuth2ScopeConsentGrant) throws org.springframework.web.client.RestClientException
      Grant Consent to Scope Grants consent for the application to request an OAuth 2.0 Okta scope

      201 - Created

      400 - Bad Request

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      appId - (required)
      oAuth2ScopeConsentGrant - (required)
      Returns:
      ResponseEntity<OAuth2ScopeConsentGrant>
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • listApplicationGroupAssignments

      public List<ApplicationGroupAssignment> listApplicationGroupAssignments(String appId, String q, String after, Integer limit, String expand) throws org.springframework.web.client.RestClientException
      List all Assigned Groups Lists all group assignments for an application

      200 - Success

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      appId - (required)
      q - (optional)
      after - Specifies the pagination cursor for the next page of assignments (optional)
      limit - Specifies the number of results for a page (optional, default to -1)
      expand - (optional)
      Returns:
      List<ApplicationGroupAssignment>
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • listApplicationGroupAssignmentsWithHttpInfo

      public org.springframework.http.ResponseEntity<List<ApplicationGroupAssignment>> listApplicationGroupAssignmentsWithHttpInfo(String appId, String q, String after, Integer limit, String expand) throws org.springframework.web.client.RestClientException
      List all Assigned Groups Lists all group assignments for an application

      200 - Success

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      appId - (required)
      q - (optional)
      after - Specifies the pagination cursor for the next page of assignments (optional)
      limit - Specifies the number of results for a page (optional, default to -1)
      expand - (optional)
      Returns:
      ResponseEntity<List<ApplicationGroupAssignment>>
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • listApplicationGroupAssignmentsWithPaginationInfo

      public PagedList listApplicationGroupAssignmentsWithPaginationInfo(String appId, String q, String after, Integer limit, String expand) throws org.springframework.web.client.RestClientException
      List all Assigned Groups Lists all group assignments for an application

      200 - Success

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      appId - (required)
      q - (optional)
      after - Specifies the pagination cursor for the next page of assignments (optional)
      limit - Specifies the number of results for a page (optional, default to -1)
      expand - (optional)
      Returns:
      ResponseEntity<List<ApplicationGroupAssignment>>
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • listApplicationKeys

      public List<JsonWebKey> listApplicationKeys(String appId) throws org.springframework.web.client.RestClientException
      List all Key Credentials Lists all key credentials for an application

      200 - Success

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      appId - (required)
      Returns:
      List<JsonWebKey>
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • listApplicationKeysWithHttpInfo

      public org.springframework.http.ResponseEntity<List<JsonWebKey>> listApplicationKeysWithHttpInfo(String appId) throws org.springframework.web.client.RestClientException
      List all Key Credentials Lists all key credentials for an application

      200 - Success

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      appId - (required)
      Returns:
      ResponseEntity<List<JsonWebKey>>
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • listApplicationKeysWithPaginationInfo

      public PagedList listApplicationKeysWithPaginationInfo(String appId) throws org.springframework.web.client.RestClientException
      List all Key Credentials Lists all key credentials for an application

      200 - Success

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      appId - (required)
      Returns:
      ResponseEntity<List<JsonWebKey>>
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • listApplicationUsers

      public List<AppUser> listApplicationUsers(String appId, String q, String queryScope, String after, Integer limit, String filter, String expand) throws org.springframework.web.client.RestClientException
      List all Assigned Users Lists all assigned [application users](#application-user-model) for an application

      200 - Success

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      appId - (required)
      q - (optional)
      queryScope - (optional)
      after - specifies the pagination cursor for the next page of assignments (optional)
      limit - specifies the number of results for a page (optional, default to -1)
      filter - (optional)
      expand - (optional)
      Returns:
      List<AppUser>
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • listApplicationUsersWithHttpInfo

      public org.springframework.http.ResponseEntity<List<AppUser>> listApplicationUsersWithHttpInfo(String appId, String q, String queryScope, String after, Integer limit, String filter, String expand) throws org.springframework.web.client.RestClientException
      List all Assigned Users Lists all assigned [application users](#application-user-model) for an application

      200 - Success

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      appId - (required)
      q - (optional)
      queryScope - (optional)
      after - specifies the pagination cursor for the next page of assignments (optional)
      limit - specifies the number of results for a page (optional, default to -1)
      filter - (optional)
      expand - (optional)
      Returns:
      ResponseEntity<List<AppUser>>
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • listApplicationUsersWithPaginationInfo

      public PagedList listApplicationUsersWithPaginationInfo(String appId, String q, String queryScope, String after, Integer limit, String filter, String expand) throws org.springframework.web.client.RestClientException
      List all Assigned Users Lists all assigned [application users](#application-user-model) for an application

      200 - Success

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      appId - (required)
      q - (optional)
      queryScope - (optional)
      after - specifies the pagination cursor for the next page of assignments (optional)
      limit - specifies the number of results for a page (optional, default to -1)
      filter - (optional)
      expand - (optional)
      Returns:
      ResponseEntity<List<AppUser>>
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • listApplications

      public List<Application> listApplications(String q, String after, Integer limit, String filter, String expand, Boolean includeNonDeleted) throws org.springframework.web.client.RestClientException
      List all Applications Lists all applications with pagination. A subset of apps can be returned that match a supported filter expression or query.

      200 - Success

      403 - Forbidden

      429 - Too Many Requests

      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:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • listApplicationsWithHttpInfo

      public org.springframework.http.ResponseEntity<List<Application>> listApplicationsWithHttpInfo(String q, String after, Integer limit, String filter, String expand, Boolean includeNonDeleted) throws org.springframework.web.client.RestClientException
      List all Applications Lists all applications with pagination. A subset of apps can be returned that match a supported filter expression or query.

      200 - Success

      403 - Forbidden

      429 - Too Many Requests

      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:
      ResponseEntity<List<Application>>
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • listApplicationsWithPaginationInfo

      public PagedList listApplicationsWithPaginationInfo(String q, String after, Integer limit, String filter, String expand, Boolean includeNonDeleted) throws org.springframework.web.client.RestClientException
      List all Applications Lists all applications with pagination. A subset of apps can be returned that match a supported filter expression or query.

      200 - Success

      403 - Forbidden

      429 - Too Many Requests

      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:
      ResponseEntity<List<Application>>
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • listCsrsForApplication

      public List<Csr> listCsrsForApplication(String appId) throws org.springframework.web.client.RestClientException
      List all Certificate Signing Requests Lists all Certificate Signing Requests for an application

      200 - Success

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      appId - (required)
      Returns:
      List<Csr>
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • listCsrsForApplicationWithHttpInfo

      public org.springframework.http.ResponseEntity<List<Csr>> listCsrsForApplicationWithHttpInfo(String appId) throws org.springframework.web.client.RestClientException
      List all Certificate Signing Requests Lists all Certificate Signing Requests for an application

      200 - Success

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      appId - (required)
      Returns:
      ResponseEntity<List<Csr>>
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • listCsrsForApplicationWithPaginationInfo

      public PagedList listCsrsForApplicationWithPaginationInfo(String appId) throws org.springframework.web.client.RestClientException
      List all Certificate Signing Requests Lists all Certificate Signing Requests for an application

      200 - Success

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      appId - (required)
      Returns:
      ResponseEntity<List<Csr>>
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • listFeaturesForApplication

      public List<ApplicationFeature> listFeaturesForApplication(String appId) throws org.springframework.web.client.RestClientException
      List all Features Lists all features for an application

      200 - Success

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      appId - (required)
      Returns:
      List<ApplicationFeature>
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • listFeaturesForApplicationWithHttpInfo

      public org.springframework.http.ResponseEntity<List<ApplicationFeature>> listFeaturesForApplicationWithHttpInfo(String appId) throws org.springframework.web.client.RestClientException
      List all Features Lists all features for an application

      200 - Success

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      appId - (required)
      Returns:
      ResponseEntity<List<ApplicationFeature>>
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • listFeaturesForApplicationWithPaginationInfo

      public PagedList listFeaturesForApplicationWithPaginationInfo(String appId) throws org.springframework.web.client.RestClientException
      List all Features Lists all features for an application

      200 - Success

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      appId - (required)
      Returns:
      ResponseEntity<List<ApplicationFeature>>
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • listOAuth2TokensForApplication

      public List<OAuth2Token> listOAuth2TokensForApplication(String appId, String expand, String after, Integer limit) throws org.springframework.web.client.RestClientException
      List all OAuth 2.0 Tokens Lists all tokens for the application

      200 - Success

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      appId - (required)
      expand - (optional)
      after - (optional)
      limit - (optional, default to 20)
      Returns:
      List<OAuth2Token>
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • listOAuth2TokensForApplicationWithHttpInfo

      public org.springframework.http.ResponseEntity<List<OAuth2Token>> listOAuth2TokensForApplicationWithHttpInfo(String appId, String expand, String after, Integer limit) throws org.springframework.web.client.RestClientException
      List all OAuth 2.0 Tokens Lists all tokens for the application

      200 - Success

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      appId - (required)
      expand - (optional)
      after - (optional)
      limit - (optional, default to 20)
      Returns:
      ResponseEntity<List<OAuth2Token>>
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • listOAuth2TokensForApplicationWithPaginationInfo

      public PagedList listOAuth2TokensForApplicationWithPaginationInfo(String appId, String expand, String after, Integer limit) throws org.springframework.web.client.RestClientException
      List all OAuth 2.0 Tokens Lists all tokens for the application

      200 - Success

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      appId - (required)
      expand - (optional)
      after - (optional)
      limit - (optional, default to 20)
      Returns:
      ResponseEntity<List<OAuth2Token>>
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • listScopeConsentGrants

      public List<OAuth2ScopeConsentGrant> listScopeConsentGrants(String appId, String expand) throws org.springframework.web.client.RestClientException
      List all Scope Consent Grants Lists all scope consent grants for the application

      200 - Success

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      appId - (required)
      expand - (optional)
      Returns:
      List<OAuth2ScopeConsentGrant>
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • listScopeConsentGrantsWithHttpInfo

      public org.springframework.http.ResponseEntity<List<OAuth2ScopeConsentGrant>> listScopeConsentGrantsWithHttpInfo(String appId, String expand) throws org.springframework.web.client.RestClientException
      List all Scope Consent Grants Lists all scope consent grants for the application

      200 - Success

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      appId - (required)
      expand - (optional)
      Returns:
      ResponseEntity<List<OAuth2ScopeConsentGrant>>
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • listScopeConsentGrantsWithPaginationInfo

      public PagedList listScopeConsentGrantsWithPaginationInfo(String appId, String expand) throws org.springframework.web.client.RestClientException
      List all Scope Consent Grants Lists all scope consent grants for the application

      200 - Success

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      appId - (required)
      expand - (optional)
      Returns:
      ResponseEntity<List<OAuth2ScopeConsentGrant>>
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • publishCsrFromApplication

      public JsonWebKey publishCsrFromApplication(String appId, String csrId, File body) throws org.springframework.web.client.RestClientException
      Publish a Certificate Signing Request Updates a certificate signing request for the app with a signed X.509 certificate and adds it into the application key credentials

      201 - Created

      400 - Bad Request

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      appId - (required)
      csrId - (required)
      body - (required)
      Returns:
      JsonWebKey
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • publishCsrFromApplication

      public <T> T publishCsrFromApplication(Class<?> T, String appId, String csrId, File body) throws org.springframework.web.client.RestClientException
      Publish a Certificate Signing Request Updates a certificate signing request for the app with a signed X.509 certificate and adds it into the application key credentials

      201 - Created

      400 - Bad Request

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      T - (required) - the assignable return type
      appId - (required)
      csrId - (required)
      body - (required)
      Returns:
      T instance
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • publishCsrFromApplicationWithHttpInfo

      public org.springframework.http.ResponseEntity<JsonWebKey> publishCsrFromApplicationWithHttpInfo(String appId, String csrId, File body) throws org.springframework.web.client.RestClientException
      Publish a Certificate Signing Request Updates a certificate signing request for the app with a signed X.509 certificate and adds it into the application key credentials

      201 - Created

      400 - Bad Request

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      appId - (required)
      csrId - (required)
      body - (required)
      Returns:
      ResponseEntity<JsonWebKey>
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • publishCsrFromApplicationWithPaginationInfo

      public PagedList publishCsrFromApplicationWithPaginationInfo(String appId, String csrId, File body) throws org.springframework.web.client.RestClientException
      Publish a Certificate Signing Request Updates a certificate signing request for the app with a signed X.509 certificate and adds it into the application key credentials

      201 - Created

      400 - Bad Request

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      appId - (required)
      csrId - (required)
      body - (required)
      Returns:
      ResponseEntity<JsonWebKey>
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • replaceApplication

      public Application replaceApplication(String appId, Application application) throws org.springframework.web.client.RestClientException
      Replace an Application Replaces an application

      200 - Success

      400 - Bad Request

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      appId - (required)
      application - (required)
      Returns:
      Application
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • replaceApplication

      public <T> T replaceApplication(Class<?> T, String appId, Application application) throws org.springframework.web.client.RestClientException
      Replace an Application Replaces an application

      200 - Success

      400 - Bad Request

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      T - (required) - the assignable return type
      appId - (required)
      application - (required)
      Returns:
      T instance
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • replaceApplicationWithHttpInfo

      public org.springframework.http.ResponseEntity<Application> replaceApplicationWithHttpInfo(String appId, Application application) throws org.springframework.web.client.RestClientException
      Replace an Application Replaces an application

      200 - Success

      400 - Bad Request

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      appId - (required)
      application - (required)
      Returns:
      ResponseEntity<Application>
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • replaceApplicationWithPaginationInfo

      public PagedList replaceApplicationWithPaginationInfo(String appId, Application application) throws org.springframework.web.client.RestClientException
      Replace an Application Replaces an application

      200 - Success

      400 - Bad Request

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      appId - (required)
      application - (required)
      Returns:
      ResponseEntity<Application>
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • revokeCsrFromApplication

      public void revokeCsrFromApplication(String appId, String csrId) throws org.springframework.web.client.RestClientException
      Revoke a Certificate Signing Request Revokes a certificate signing request and deletes the key pair from the application

      204 - No Content

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      appId - (required)
      csrId - (required)
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • revokeCsrFromApplicationWithHttpInfo

      public org.springframework.http.ResponseEntity<Void> revokeCsrFromApplicationWithHttpInfo(String appId, String csrId) throws org.springframework.web.client.RestClientException
      Revoke a Certificate Signing Request Revokes a certificate signing request and deletes the key pair from the application

      204 - No Content

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      appId - (required)
      csrId - (required)
      Returns:
      ResponseEntity<Void>
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • revokeOAuth2TokenForApplication

      public void revokeOAuth2TokenForApplication(String appId, String tokenId) throws org.springframework.web.client.RestClientException
      Revoke an OAuth 2.0 Token Revokes the specified token for the specified application

      204 - No Content

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      appId - (required)
      tokenId - (required)
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • revokeOAuth2TokenForApplicationWithHttpInfo

      public org.springframework.http.ResponseEntity<Void> revokeOAuth2TokenForApplicationWithHttpInfo(String appId, String tokenId) throws org.springframework.web.client.RestClientException
      Revoke an OAuth 2.0 Token Revokes the specified token for the specified application

      204 - No Content

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      appId - (required)
      tokenId - (required)
      Returns:
      ResponseEntity<Void>
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • revokeOAuth2TokensForApplication

      public void revokeOAuth2TokensForApplication(String appId) throws org.springframework.web.client.RestClientException
      Revoke all OAuth 2.0 Tokens Revokes all tokens for the specified application

      204 - No Content

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      appId - (required)
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • revokeOAuth2TokensForApplicationWithHttpInfo

      public org.springframework.http.ResponseEntity<Void> revokeOAuth2TokensForApplicationWithHttpInfo(String appId) throws org.springframework.web.client.RestClientException
      Revoke all OAuth 2.0 Tokens Revokes all tokens for the specified application

      204 - No Content

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      appId - (required)
      Returns:
      ResponseEntity<Void>
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • revokeScopeConsentGrant

      public void revokeScopeConsentGrant(String appId, String grantId) throws org.springframework.web.client.RestClientException
      Revoke a Scope Consent Grant Revokes permission for the application to request the given scope

      204 - No Content

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      appId - (required)
      grantId - (required)
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • revokeScopeConsentGrantWithHttpInfo

      public org.springframework.http.ResponseEntity<Void> revokeScopeConsentGrantWithHttpInfo(String appId, String grantId) throws org.springframework.web.client.RestClientException
      Revoke a Scope Consent Grant Revokes permission for the application to request the given scope

      204 - No Content

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      appId - (required)
      grantId - (required)
      Returns:
      ResponseEntity<Void>
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • unassignApplicationFromGroup

      public void unassignApplicationFromGroup(String appId, String groupId) throws org.springframework.web.client.RestClientException
      Unassign a Group Unassigns a group from an application

      204 - No Content

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      appId - (required)
      groupId - (required)
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • unassignApplicationFromGroupWithHttpInfo

      public org.springframework.http.ResponseEntity<Void> unassignApplicationFromGroupWithHttpInfo(String appId, String groupId) throws org.springframework.web.client.RestClientException
      Unassign a Group Unassigns a group from an application

      204 - No Content

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      appId - (required)
      groupId - (required)
      Returns:
      ResponseEntity<Void>
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • unassignUserFromApplication

      public void unassignUserFromApplication(String appId, String userId, Boolean sendEmail) throws org.springframework.web.client.RestClientException
      Unassign a User Unassigns a user from an application

      204 - No Content

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      appId - (required)
      userId - (required)
      sendEmail - (optional, default to false)
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • unassignUserFromApplicationWithHttpInfo

      public org.springframework.http.ResponseEntity<Void> unassignUserFromApplicationWithHttpInfo(String appId, String userId, Boolean sendEmail) throws org.springframework.web.client.RestClientException
      Unassign a User Unassigns a user from an application

      204 - No Content

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      appId - (required)
      userId - (required)
      sendEmail - (optional, default to false)
      Returns:
      ResponseEntity<Void>
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • updateApplicationUser

      public AppUser updateApplicationUser(String appId, String userId, AppUser appUser) throws org.springframework.web.client.RestClientException
      Update an Application Profile for Assigned User Updates a user's profile for an application

      200 - Success

      400 - Bad Request

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      appId - (required)
      userId - (required)
      appUser - (required)
      Returns:
      AppUser
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • updateApplicationUser

      public <T> T updateApplicationUser(Class<?> T, String appId, String userId, AppUser appUser) throws org.springframework.web.client.RestClientException
      Update an Application Profile for Assigned User Updates a user's profile for an application

      200 - Success

      400 - Bad Request

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      T - (required) - the assignable return type
      appId - (required)
      userId - (required)
      appUser - (required)
      Returns:
      T instance
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • updateApplicationUserWithHttpInfo

      public org.springframework.http.ResponseEntity<AppUser> updateApplicationUserWithHttpInfo(String appId, String userId, AppUser appUser) throws org.springframework.web.client.RestClientException
      Update an Application Profile for Assigned User Updates a user's profile for an application

      200 - Success

      400 - Bad Request

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      appId - (required)
      userId - (required)
      appUser - (required)
      Returns:
      ResponseEntity<AppUser>
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • updateApplicationUserWithPaginationInfo

      public PagedList updateApplicationUserWithPaginationInfo(String appId, String userId, AppUser appUser) throws org.springframework.web.client.RestClientException
      Update an Application Profile for Assigned User Updates a user's profile for an application

      200 - Success

      400 - Bad Request

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      appId - (required)
      userId - (required)
      appUser - (required)
      Returns:
      ResponseEntity<AppUser>
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • updateDefaultProvisioningConnectionForApplication

      public ProvisioningConnection updateDefaultProvisioningConnectionForApplication(String appId, ProvisioningConnectionRequest provisioningConnectionRequest, Boolean activate) throws org.springframework.web.client.RestClientException
      Update the default Provisioning Connection Updates the default provisioning connection for application

      201 - Created

      400 - Bad Request

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      appId - (required)
      provisioningConnectionRequest - (required)
      activate - (optional)
      Returns:
      ProvisioningConnection
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • updateDefaultProvisioningConnectionForApplication

      public <T> T updateDefaultProvisioningConnectionForApplication(Class<?> T, String appId, ProvisioningConnectionRequest provisioningConnectionRequest, Boolean activate) throws org.springframework.web.client.RestClientException
      Update the default Provisioning Connection Updates the default provisioning connection for application

      201 - Created

      400 - Bad Request

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      T - (required) - the assignable return type
      appId - (required)
      provisioningConnectionRequest - (required)
      activate - (optional)
      Returns:
      T instance
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • updateDefaultProvisioningConnectionForApplicationWithHttpInfo

      public org.springframework.http.ResponseEntity<ProvisioningConnection> updateDefaultProvisioningConnectionForApplicationWithHttpInfo(String appId, ProvisioningConnectionRequest provisioningConnectionRequest, Boolean activate) throws org.springframework.web.client.RestClientException
      Update the default Provisioning Connection Updates the default provisioning connection for application

      201 - Created

      400 - Bad Request

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      appId - (required)
      provisioningConnectionRequest - (required)
      activate - (optional)
      Returns:
      ResponseEntity<ProvisioningConnection>
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • updateDefaultProvisioningConnectionForApplicationWithPaginationInfo

      public PagedList updateDefaultProvisioningConnectionForApplicationWithPaginationInfo(String appId, ProvisioningConnectionRequest provisioningConnectionRequest, Boolean activate) throws org.springframework.web.client.RestClientException
      Update the default Provisioning Connection Updates the default provisioning connection for application

      201 - Created

      400 - Bad Request

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      appId - (required)
      provisioningConnectionRequest - (required)
      activate - (optional)
      Returns:
      ResponseEntity<ProvisioningConnection>
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • updateFeatureForApplication

      public ApplicationFeature updateFeatureForApplication(String appId, String name, CapabilitiesObject capabilitiesObject) throws org.springframework.web.client.RestClientException
      Update a Feature Updates a Feature object for an application

      200 - Success

      400 - Bad Request

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      appId - (required)
      name - (required)
      capabilitiesObject - (required)
      Returns:
      ApplicationFeature
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • updateFeatureForApplication

      public <T> T updateFeatureForApplication(Class<?> T, String appId, String name, CapabilitiesObject capabilitiesObject) throws org.springframework.web.client.RestClientException
      Update a Feature Updates a Feature object for an application

      200 - Success

      400 - Bad Request

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      T - (required) - the assignable return type
      appId - (required)
      name - (required)
      capabilitiesObject - (required)
      Returns:
      T instance
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • updateFeatureForApplicationWithHttpInfo

      public org.springframework.http.ResponseEntity<ApplicationFeature> updateFeatureForApplicationWithHttpInfo(String appId, String name, CapabilitiesObject capabilitiesObject) throws org.springframework.web.client.RestClientException
      Update a Feature Updates a Feature object for an application

      200 - Success

      400 - Bad Request

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      appId - (required)
      name - (required)
      capabilitiesObject - (required)
      Returns:
      ResponseEntity<ApplicationFeature>
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • updateFeatureForApplicationWithPaginationInfo

      public PagedList updateFeatureForApplicationWithPaginationInfo(String appId, String name, CapabilitiesObject capabilitiesObject) throws org.springframework.web.client.RestClientException
      Update a Feature Updates a Feature object for an application

      200 - Success

      400 - Bad Request

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      appId - (required)
      name - (required)
      capabilitiesObject - (required)
      Returns:
      ResponseEntity<ApplicationFeature>
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • uploadApplicationLogo

      public void uploadApplicationLogo(String appId, File _file) throws org.springframework.web.client.RestClientException
      Upload a Logo The file must be in PNG, JPG, or GIF format, and less than 1 MB in size. For best results use landscape orientation, a transparent background, and a minimum size of 420px by 120px to prevent upscaling.

      201 - Created

      400 - Bad Request

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      appId - (required)
      _file - (required)
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • uploadApplicationLogoWithHttpInfo

      public org.springframework.http.ResponseEntity<Void> uploadApplicationLogoWithHttpInfo(String appId, File _file) throws org.springframework.web.client.RestClientException
      Upload a Logo The file must be in PNG, JPG, or GIF format, and less than 1 MB in size. For best results use landscape orientation, a transparent background, and a minimum size of 420px by 120px to prevent upscaling.

      201 - Created

      400 - Bad Request

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      appId - (required)
      _file - (required)
      Returns:
      ResponseEntity<Void>
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API