Package org.openapitools.client.api
Class ApplicationApi
java.lang.Object
org.openapitools.client.api.ApplicationApi
- Direct Known Subclasses:
ApplicationApiHelper
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
date="2023-06-14T14:39:12.692995-05:00[America/Chicago]")
public class ApplicationApi
extends Object
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
activateApplication
(String appId) Activate an Application Activates an inactive applicationvoid
activateApplication
(String appId, Map<String, String> additionalHeaders) Activate an Application Activates an inactive applicationvoid
Activate the default Provisioning Connection Activates the default Provisioning Connection for an applicationvoid
activateDefaultProvisioningConnectionForApplication
(String appId, Map<String, String> additionalHeaders) Activate the default Provisioning Connection Activates the default Provisioning Connection for an applicationvoid
assignApplicationPolicy
(String appId, String policyId) Assign an Application to a Policy Assigns an application to a policy identified by `policyId`.void
Assign an Application to a Policy Assigns an application to a policy identified by `policyId`.assignGroupToApplication
(String appId, String groupId, ApplicationGroupAssignment applicationGroupAssignment) Assign a Group Assigns a group to an applicationassignGroupToApplication
(String appId, String groupId, ApplicationGroupAssignment applicationGroupAssignment, Map<String, String> additionalHeaders) Assign a Group Assigns a group to an applicationassignUserToApplication
(String appId, AppUser appUser) Assign a User Assigns an user to an application with [credentials](#application-user-credentials-object) and an app-specific [profile](#application-user-profile-object).Assign a User Assigns an user to an application with [credentials](#application-user-credentials-object) and an app-specific [profile](#application-user-profile-object).cloneApplicationKey
(String appId, String keyId, String targetAid) Clone a Key Credential Clones a X.509 certificate for an application key credential from a source application to target application.cloneApplicationKey
(String appId, String keyId, String targetAid, Map<String, String> additionalHeaders) Clone a Key Credential Clones a X.509 certificate for an application key credential from a source application to target application.createApplication
(Application application, Boolean activate, String oktaAccessGatewayAgent) Create an Application Creates a new application to your Okta organizationcreateApplication
(Application application, Boolean activate, String oktaAccessGatewayAgent, Map<String, String> additionalHeaders) Create an Application Creates a new application to your Okta organizationvoid
deactivateApplication
(String appId) Deactivate an Application Deactivates an active applicationvoid
deactivateApplication
(String appId, Map<String, String> additionalHeaders) Deactivate an Application Deactivates an active applicationvoid
Deactivate the default Provisioning Connection for an Application Deactivates the default Provisioning Connection for an applicationvoid
deactivateDefaultProvisioningConnectionForApplication
(String appId, Map<String, String> additionalHeaders) Deactivate the default Provisioning Connection for an Application Deactivates the default Provisioning Connection for an applicationvoid
deleteApplication
(String appId) Delete an Application Deletes an inactive applicationvoid
deleteApplication
(String appId, Map<String, String> additionalHeaders) Delete an Application Deletes an inactive applicationgenerateApplicationKey
(String appId, Integer validityYears) Generate a Key Credential Generates a new X.509 certificate for an application key credentialGenerate a Key Credential Generates a new X.509 certificate for an application key credentialgenerateCsrForApplication
(String appId, CsrMetadata metadata) Generate a Certificate Signing Request Generates a new key pair and returns the Certificate Signing Request for itgenerateCsrForApplication
(String appId, CsrMetadata metadata, Map<String, String> additionalHeaders) Generate a Certificate Signing Request Generates a new key pair and returns the Certificate Signing Request for itgetApplication
(String appId, String expand) Retrieve an Application Retrieves an application from your Okta organization by `id`Retrieve an Application Retrieves an application from your Okta organization by `id`getApplicationGroupAssignment
(String appId, String groupId, String expand) Retrieve an Assigned Group Retrieves an application group assignmentgetApplicationGroupAssignment
(String appId, String groupId, String expand, Map<String, String> additionalHeaders) Retrieve an Assigned Group Retrieves an application group assignmentgetApplicationKey
(String appId, String keyId) Retrieve a Key Credential Retrieves a specific application key credential by kidRetrieve a Key Credential Retrieves a specific application key credential by kidgetApplicationUser
(String appId, String userId, String expand) Retrieve an Assigned User Retrieves a specific user assignment for application by `id`getApplicationUser
(String appId, String userId, String expand, Map<String, String> additionalHeaders) Retrieve an Assigned User Retrieves a specific user assignment for application by `id`getCsrForApplication
(String appId, String csrId) Retrieve a Certificate Signing Request Retrieves a certificate signing request for the app by `id`Retrieve a Certificate Signing Request Retrieves a certificate signing request for the app by `id`Retrieve the default Provisioning Connection Retrieves the default Provisioning Connection for applicationgetDefaultProvisioningConnectionForApplication
(String appId, Map<String, String> additionalHeaders) Retrieve the default Provisioning Connection Retrieves the default Provisioning Connection for applicationgetFeatureForApplication
(String appId, String featureName) Retrieve a Feature Retrieves a Feature object for an applicationRetrieve a Feature Retrieves a Feature object for an applicationgetOAuth2TokenForApplication
(String appId, String tokenId, String expand) Retrieve an OAuth 2.0 Token Retrieves a token for the specified applicationgetOAuth2TokenForApplication
(String appId, String tokenId, String expand, Map<String, String> additionalHeaders) Retrieve an OAuth 2.0 Token Retrieves a token for the specified applicationprotected static com.fasterxml.jackson.databind.ObjectMapper
getScopeConsentGrant
(String appId, String grantId, String expand) Retrieve a Scope Consent Grant Retrieves a single scope consent grant for the applicationgetScopeConsentGrant
(String appId, String grantId, String expand, Map<String, String> additionalHeaders) Retrieve a Scope Consent Grant Retrieves a single scope consent grant for the applicationgrantConsentToScope
(String appId, OAuth2ScopeConsentGrant oAuth2ScopeConsentGrant) Grant Consent to Scope Grants consent for the application to request an OAuth 2.0 Okta scopegrantConsentToScope
(String appId, OAuth2ScopeConsentGrant oAuth2ScopeConsentGrant, Map<String, String> additionalHeaders) Grant Consent to Scope Grants consent for the application to request an OAuth 2.0 Okta scopeList all Assigned Groups Lists all group assignments for an applicationlistApplicationGroupAssignments
(String appId, String q, String after, Integer limit, String expand, Map<String, String> additionalHeaders) List all Assigned Groups Lists all group assignments for an applicationlistApplicationKeys
(String appId) List all Key Credentials Lists all key credentials for an applicationlistApplicationKeys
(String appId, Map<String, String> additionalHeaders) List all Key Credentials Lists all key credentials for an applicationlistApplications
(String q, String after, Integer limit, String filter, String expand, Boolean includeNonDeleted) List all Applications Lists all applications with pagination.listApplications
(String q, String after, Integer limit, String filter, String expand, Boolean includeNonDeleted, Map<String, String> additionalHeaders) List all Applications Lists all applications with pagination.listApplicationUsers
(String appId, String q, String queryScope, String after, Integer limit, String filter, String expand) List all Assigned Users Lists all assigned [application users](#application-user-model) for an applicationlistApplicationUsers
(String appId, String q, String queryScope, String after, Integer limit, String filter, String expand, Map<String, String> additionalHeaders) List all Assigned Users Lists all assigned [application users](#application-user-model) for an applicationlistCsrsForApplication
(String appId) List all Certificate Signing Requests Lists all Certificate Signing Requests for an applicationlistCsrsForApplication
(String appId, Map<String, String> additionalHeaders) List all Certificate Signing Requests Lists all Certificate Signing Requests for an applicationlistFeaturesForApplication
(String appId) List all Features Lists all features for an applicationlistFeaturesForApplication
(String appId, Map<String, String> additionalHeaders) List all Features Lists all features for an applicationlistOAuth2TokensForApplication
(String appId, String expand, String after, Integer limit) List all OAuth 2.0 Tokens Lists all tokens for the applicationlistOAuth2TokensForApplication
(String appId, String expand, String after, Integer limit, Map<String, String> additionalHeaders) List all OAuth 2.0 Tokens Lists all tokens for the applicationlistScopeConsentGrants
(String appId, String expand) List all Scope Consent Grants Lists all scope consent grants for the applicationList all Scope Consent Grants Lists all scope consent grants for the applicationpublishCsrFromApplication
(String appId, String csrId, File body) Publish a Certificate Signing Request Publishes a certificate signing request for the app with a signed X.509 certificate and adds it into the application key credentialspublishCsrFromApplication
(String appId, String csrId, File body, Map<String, String> additionalHeaders) Publish a Certificate Signing Request Publishes a certificate signing request for the app with a signed X.509 certificate and adds it into the application key credentialsreplaceApplication
(String appId, Application application) Replace an Application Replaces an applicationreplaceApplication
(String appId, Application application, Map<String, String> additionalHeaders) Replace an Application Replaces an applicationvoid
revokeCsrFromApplication
(String appId, String csrId) Revoke a Certificate Signing Request Revokes a certificate signing request and deletes the key pair from the applicationvoid
Revoke a Certificate Signing Request Revokes a certificate signing request and deletes the key pair from the applicationvoid
revokeOAuth2TokenForApplication
(String appId, String tokenId) Revoke an OAuth 2.0 Token Revokes the specified token for the specified applicationvoid
Revoke an OAuth 2.0 Token Revokes the specified token for the specified applicationvoid
Revoke all OAuth 2.0 Tokens Revokes all tokens for the specified applicationvoid
revokeOAuth2TokensForApplication
(String appId, Map<String, String> additionalHeaders) Revoke all OAuth 2.0 Tokens Revokes all tokens for the specified applicationvoid
revokeScopeConsentGrant
(String appId, String grantId) Revoke a Scope Consent Grant Revokes permission for the application to request the given scopevoid
Revoke a Scope Consent Grant Revokes permission for the application to request the given scopevoid
setApiClient
(ApiClient apiClient) void
unassignApplicationFromGroup
(String appId, String groupId) Unassign a Group Unassigns a group from an applicationvoid
Unassign a Group Unassigns a group from an applicationvoid
unassignUserFromApplication
(String appId, String userId, Boolean sendEmail) Unassign a User Unassigns a user from an applicationvoid
unassignUserFromApplication
(String appId, String userId, Boolean sendEmail, Map<String, String> additionalHeaders) Unassign a User Unassigns a user from an applicationupdateApplicationUser
(String appId, String userId, AppUser appUser) Update an Application Profile for Assigned User Updates a user's profile for an applicationupdateApplicationUser
(String appId, String userId, AppUser appUser, Map<String, String> additionalHeaders) Update an Application Profile for Assigned User Updates a user's profile for an applicationupdateDefaultProvisioningConnectionForApplication
(String appId, ProvisioningConnectionRequest provisioningConnectionRequest, Boolean activate) Update the default Provisioning Connection Updates the default provisioning connection for applicationupdateDefaultProvisioningConnectionForApplication
(String appId, ProvisioningConnectionRequest provisioningConnectionRequest, Boolean activate, Map<String, String> additionalHeaders) Update the default Provisioning Connection Updates the default provisioning connection for applicationupdateFeatureForApplication
(String appId, String featureName, CapabilitiesObject capabilitiesObject) Update a Feature Updates a Feature object for an applicationupdateFeatureForApplication
(String appId, String featureName, CapabilitiesObject capabilitiesObject, Map<String, String> additionalHeaders) Update a Feature Updates a Feature object for an applicationvoid
uploadApplicationLogo
(String appId, File _file) Upload a Logo Uploads a logo for the application.void
Upload a Logo Uploads a logo for the application.
-
Constructor Details
-
ApplicationApi
public ApplicationApi() -
ApplicationApi
-
-
Method Details
-
getApiClient
-
setApiClient
-
activateApplication
Activate an Application Activates an inactive application- Parameters:
appId
- `id` of the Application (required)- Throws:
ApiException
- if fails to make API call
-
activateApplication
public void activateApplication(String appId, Map<String, String> additionalHeaders) throws ApiExceptionActivate an Application Activates an inactive application- Parameters:
appId
- `id` of the Application (required)additionalHeaders
- additionalHeaders for this call- Throws:
ApiException
- if fails to make API call
-
activateDefaultProvisioningConnectionForApplication
Activate the default Provisioning Connection Activates the default Provisioning Connection for an application- Parameters:
appId
- `id` of the Application (required)- Throws:
ApiException
- if fails to make API call
-
activateDefaultProvisioningConnectionForApplication
public void activateDefaultProvisioningConnectionForApplication(String appId, Map<String, String> additionalHeaders) throws ApiExceptionActivate the default Provisioning Connection Activates the default Provisioning Connection for an application- Parameters:
appId
- `id` of the Application (required)additionalHeaders
- additionalHeaders for this call- Throws:
ApiException
- if fails to make API call
-
assignApplicationPolicy
Assign an Application to a Policy Assigns an application to a policy identified by `policyId`. If the application was previously assigned to another policy, this removes that assignment.- Parameters:
appId
- `id` of the Application (required)policyId
- `id` of the Policy (required)- Throws:
ApiException
- if fails to make API call
-
assignApplicationPolicy
public void assignApplicationPolicy(String appId, String policyId, Map<String, String> additionalHeaders) throws ApiExceptionAssign an Application to a Policy Assigns an application to a policy identified by `policyId`. If the application was previously assigned to another policy, this removes that assignment.- Parameters:
appId
- `id` of the Application (required)policyId
- `id` of the Policy (required)additionalHeaders
- additionalHeaders for this call- Throws:
ApiException
- if fails to make API call
-
assignGroupToApplication
public ApplicationGroupAssignment assignGroupToApplication(String appId, String groupId, ApplicationGroupAssignment applicationGroupAssignment) throws ApiException Assign a Group Assigns a group to an application- Parameters:
appId
- `id` of the Application (required)groupId
- The `id` of the group (required)applicationGroupAssignment
- (optional)- Returns:
- ApplicationGroupAssignment
- Throws:
ApiException
- if fails to make API call
-
assignGroupToApplication
public ApplicationGroupAssignment assignGroupToApplication(String appId, String groupId, ApplicationGroupAssignment applicationGroupAssignment, Map<String, String> additionalHeaders) throws ApiExceptionAssign a Group Assigns a group to an application- Parameters:
appId
- `id` of the Application (required)groupId
- The `id` of the group (required)applicationGroupAssignment
- (optional)additionalHeaders
- additionalHeaders for this call- Returns:
- ApplicationGroupAssignment
- Throws:
ApiException
- if fails to make API call
-
assignUserToApplication
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.- Parameters:
appId
- `id` of the Application (required)appUser
- (required)- Returns:
- AppUser
- Throws:
ApiException
- if fails to make API call
-
assignUserToApplication
public AppUser assignUserToApplication(String appId, AppUser appUser, Map<String, String> additionalHeaders) throws ApiExceptionAssign 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.- Parameters:
appId
- `id` of the Application (required)appUser
- (required)additionalHeaders
- additionalHeaders for this call- Returns:
- AppUser
- Throws:
ApiException
- if fails to make API call
-
cloneApplicationKey
public JsonWebKey cloneApplicationKey(String appId, String keyId, String targetAid) throws ApiException Clone a Key Credential Clones a X.509 certificate for an application key credential from a source application to target application.- Parameters:
appId
- `id` of the Application (required)keyId
- `id` of the Key (required)targetAid
- Unique key of the target Application (required)- Returns:
- JsonWebKey
- Throws:
ApiException
- if fails to make API call
-
cloneApplicationKey
public JsonWebKey cloneApplicationKey(String appId, String keyId, String targetAid, Map<String, String> additionalHeaders) throws ApiExceptionClone a Key Credential Clones a X.509 certificate for an application key credential from a source application to target application.- Parameters:
appId
- `id` of the Application (required)keyId
- `id` of the Key (required)targetAid
- Unique key of the target Application (required)additionalHeaders
- additionalHeaders for this call- Returns:
- JsonWebKey
- Throws:
ApiException
- if fails to make API call
-
createApplication
public Application createApplication(Application application, Boolean activate, String oktaAccessGatewayAgent) throws ApiException Create an Application Creates a new application to your Okta organization- Parameters:
application
- (required)activate
- Executes activation lifecycle operation when creating the app (optional, default to true)oktaAccessGatewayAgent
- (optional)- Returns:
- Application
- Throws:
ApiException
- if fails to make API call
-
createApplication
public Application createApplication(Application application, Boolean activate, String oktaAccessGatewayAgent, Map<String, String> additionalHeaders) throws ApiExceptionCreate an Application Creates a new application to your Okta organization- Parameters:
application
- (required)activate
- Executes activation lifecycle operation when creating the app (optional, default to true)oktaAccessGatewayAgent
- (optional)additionalHeaders
- additionalHeaders for this call- Returns:
- Application
- Throws:
ApiException
- if fails to make API call
-
deactivateApplication
Deactivate an Application Deactivates an active application- Parameters:
appId
- `id` of the Application (required)- Throws:
ApiException
- if fails to make API call
-
deactivateApplication
public void deactivateApplication(String appId, Map<String, String> additionalHeaders) throws ApiExceptionDeactivate an Application Deactivates an active application- Parameters:
appId
- `id` of the Application (required)additionalHeaders
- additionalHeaders for this call- Throws:
ApiException
- if fails to make API call
-
deactivateDefaultProvisioningConnectionForApplication
Deactivate the default Provisioning Connection for an Application Deactivates the default Provisioning Connection for an application- Parameters:
appId
- `id` of the Application (required)- Throws:
ApiException
- if fails to make API call
-
deactivateDefaultProvisioningConnectionForApplication
public void deactivateDefaultProvisioningConnectionForApplication(String appId, Map<String, String> additionalHeaders) throws ApiExceptionDeactivate the default Provisioning Connection for an Application Deactivates the default Provisioning Connection for an application- Parameters:
appId
- `id` of the Application (required)additionalHeaders
- additionalHeaders for this call- Throws:
ApiException
- if fails to make API call
-
deleteApplication
Delete an Application Deletes an inactive application- Parameters:
appId
- `id` of the Application (required)- Throws:
ApiException
- if fails to make API call
-
deleteApplication
public void deleteApplication(String appId, Map<String, String> additionalHeaders) throws ApiExceptionDelete an Application Deletes an inactive application- Parameters:
appId
- `id` of the Application (required)additionalHeaders
- additionalHeaders for this call- Throws:
ApiException
- if fails to make API call
-
generateApplicationKey
Generate a Key Credential Generates a new X.509 certificate for an application key credential- Parameters:
appId
- `id` of the Application (required)validityYears
- (optional)- Returns:
- JsonWebKey
- Throws:
ApiException
- if fails to make API call
-
generateApplicationKey
public JsonWebKey generateApplicationKey(String appId, Integer validityYears, Map<String, String> additionalHeaders) throws ApiExceptionGenerate a Key Credential Generates a new X.509 certificate for an application key credential- Parameters:
appId
- `id` of the Application (required)validityYears
- (optional)additionalHeaders
- additionalHeaders for this call- Returns:
- JsonWebKey
- Throws:
ApiException
- if fails to make API call
-
generateCsrForApplication
Generate a Certificate Signing Request Generates a new key pair and returns the Certificate Signing Request for it- Parameters:
appId
- `id` of the Application (required)metadata
- (required)- Returns:
- Csr
- Throws:
ApiException
- if fails to make API call
-
generateCsrForApplication
public Csr generateCsrForApplication(String appId, CsrMetadata metadata, Map<String, String> additionalHeaders) throws ApiExceptionGenerate a Certificate Signing Request Generates a new key pair and returns the Certificate Signing Request for it- Parameters:
appId
- `id` of the Application (required)metadata
- (required)additionalHeaders
- additionalHeaders for this call- Returns:
- Csr
- Throws:
ApiException
- if fails to make API call
-
getApplication
Retrieve an Application Retrieves an application from your Okta organization by `id`- Parameters:
appId
- `id` of the Application (required)expand
- (optional)- Returns:
- Application
- Throws:
ApiException
- if fails to make API call
-
getApplication
public Application getApplication(String appId, String expand, Map<String, String> additionalHeaders) throws ApiExceptionRetrieve an Application Retrieves an application from your Okta organization by `id`- Parameters:
appId
- `id` of the Application (required)expand
- (optional)additionalHeaders
- additionalHeaders for this call- Returns:
- Application
- Throws:
ApiException
- if fails to make API call
-
getApplicationGroupAssignment
public ApplicationGroupAssignment getApplicationGroupAssignment(String appId, String groupId, String expand) throws ApiException Retrieve an Assigned Group Retrieves an application group assignment- Parameters:
appId
- `id` of the Application (required)groupId
- The `id` of the group (required)expand
- (optional)- Returns:
- ApplicationGroupAssignment
- Throws:
ApiException
- if fails to make API call
-
getApplicationGroupAssignment
public ApplicationGroupAssignment getApplicationGroupAssignment(String appId, String groupId, String expand, Map<String, String> additionalHeaders) throws ApiExceptionRetrieve an Assigned Group Retrieves an application group assignment- Parameters:
appId
- `id` of the Application (required)groupId
- The `id` of the group (required)expand
- (optional)additionalHeaders
- additionalHeaders for this call- Returns:
- ApplicationGroupAssignment
- Throws:
ApiException
- if fails to make API call
-
getApplicationKey
Retrieve a Key Credential Retrieves a specific application key credential by kid- Parameters:
appId
- `id` of the Application (required)keyId
- `id` of the Key (required)- Returns:
- JsonWebKey
- Throws:
ApiException
- if fails to make API call
-
getApplicationKey
public JsonWebKey getApplicationKey(String appId, String keyId, Map<String, String> additionalHeaders) throws ApiExceptionRetrieve a Key Credential Retrieves a specific application key credential by kid- Parameters:
appId
- `id` of the Application (required)keyId
- `id` of the Key (required)additionalHeaders
- additionalHeaders for this call- Returns:
- JsonWebKey
- Throws:
ApiException
- if fails to make API call
-
getApplicationUser
Retrieve an Assigned User Retrieves a specific user assignment for application by `id`- Parameters:
appId
- `id` of the Application (required)userId
- (required)expand
- (optional)- Returns:
- AppUser
- Throws:
ApiException
- if fails to make API call
-
getApplicationUser
public AppUser getApplicationUser(String appId, String userId, String expand, Map<String, String> additionalHeaders) throws ApiExceptionRetrieve an Assigned User Retrieves a specific user assignment for application by `id`- Parameters:
appId
- `id` of the Application (required)userId
- (required)expand
- (optional)additionalHeaders
- additionalHeaders for this call- Returns:
- AppUser
- Throws:
ApiException
- if fails to make API call
-
getCsrForApplication
Retrieve a Certificate Signing Request Retrieves a certificate signing request for the app by `id`- Parameters:
appId
- `id` of the Application (required)csrId
- `id` of the CSR (required)- Returns:
- Csr
- Throws:
ApiException
- if fails to make API call
-
getCsrForApplication
public Csr getCsrForApplication(String appId, String csrId, Map<String, String> additionalHeaders) throws ApiExceptionRetrieve a Certificate Signing Request Retrieves a certificate signing request for the app by `id`- Parameters:
appId
- `id` of the Application (required)csrId
- `id` of the CSR (required)additionalHeaders
- additionalHeaders for this call- Returns:
- Csr
- Throws:
ApiException
- if fails to make API call
-
getDefaultProvisioningConnectionForApplication
public ProvisioningConnection getDefaultProvisioningConnectionForApplication(String appId) throws ApiException Retrieve the default Provisioning Connection Retrieves the default Provisioning Connection for application- Parameters:
appId
- `id` of the Application (required)- Returns:
- ProvisioningConnection
- Throws:
ApiException
- if fails to make API call
-
getDefaultProvisioningConnectionForApplication
public ProvisioningConnection getDefaultProvisioningConnectionForApplication(String appId, Map<String, String> additionalHeaders) throws ApiExceptionRetrieve the default Provisioning Connection Retrieves the default Provisioning Connection for application- Parameters:
appId
- `id` of the Application (required)additionalHeaders
- additionalHeaders for this call- Returns:
- ProvisioningConnection
- Throws:
ApiException
- if fails to make API call
-
getFeatureForApplication
public ApplicationFeature getFeatureForApplication(String appId, String featureName) throws ApiException Retrieve a Feature Retrieves a Feature object for an application- Parameters:
appId
- `id` of the Application (required)featureName
- Name of the Feature (required)- Returns:
- ApplicationFeature
- Throws:
ApiException
- if fails to make API call
-
getFeatureForApplication
public ApplicationFeature getFeatureForApplication(String appId, String featureName, Map<String, String> additionalHeaders) throws ApiExceptionRetrieve a Feature Retrieves a Feature object for an application- Parameters:
appId
- `id` of the Application (required)featureName
- Name of the Feature (required)additionalHeaders
- additionalHeaders for this call- Returns:
- ApplicationFeature
- Throws:
ApiException
- if fails to make API call
-
getOAuth2TokenForApplication
public OAuth2Token getOAuth2TokenForApplication(String appId, String tokenId, String expand) throws ApiException Retrieve an OAuth 2.0 Token Retrieves a token for the specified application- Parameters:
appId
- `id` of the Application (required)tokenId
- `id` of Token (required)expand
- (optional)- Returns:
- OAuth2Token
- Throws:
ApiException
- if fails to make API call
-
getOAuth2TokenForApplication
public OAuth2Token getOAuth2TokenForApplication(String appId, String tokenId, String expand, Map<String, String> additionalHeaders) throws ApiExceptionRetrieve an OAuth 2.0 Token Retrieves a token for the specified application- Parameters:
appId
- `id` of the Application (required)tokenId
- `id` of Token (required)expand
- (optional)additionalHeaders
- additionalHeaders for this call- Returns:
- OAuth2Token
- Throws:
ApiException
- if fails to make API call
-
getScopeConsentGrant
public OAuth2ScopeConsentGrant getScopeConsentGrant(String appId, String grantId, String expand) throws ApiException Retrieve a Scope Consent Grant Retrieves a single scope consent grant for the application- Parameters:
appId
- `id` of the Application (required)grantId
- `id` of the Grant (required)expand
- (optional)- Returns:
- OAuth2ScopeConsentGrant
- Throws:
ApiException
- if fails to make API call
-
getScopeConsentGrant
public OAuth2ScopeConsentGrant getScopeConsentGrant(String appId, String grantId, String expand, Map<String, String> additionalHeaders) throws ApiExceptionRetrieve a Scope Consent Grant Retrieves a single scope consent grant for the application- Parameters:
appId
- `id` of the Application (required)grantId
- `id` of the Grant (required)expand
- (optional)additionalHeaders
- additionalHeaders for this call- Returns:
- OAuth2ScopeConsentGrant
- Throws:
ApiException
- if fails to make API call
-
grantConsentToScope
public OAuth2ScopeConsentGrant grantConsentToScope(String appId, OAuth2ScopeConsentGrant oAuth2ScopeConsentGrant) throws ApiException Grant Consent to Scope Grants consent for the application to request an OAuth 2.0 Okta scope- Parameters:
appId
- `id` of the Application (required)oAuth2ScopeConsentGrant
- (required)- Returns:
- OAuth2ScopeConsentGrant
- Throws:
ApiException
- if fails to make API call
-
grantConsentToScope
public OAuth2ScopeConsentGrant grantConsentToScope(String appId, OAuth2ScopeConsentGrant oAuth2ScopeConsentGrant, Map<String, String> additionalHeaders) throws ApiExceptionGrant Consent to Scope Grants consent for the application to request an OAuth 2.0 Okta scope- Parameters:
appId
- `id` of the Application (required)oAuth2ScopeConsentGrant
- (required)additionalHeaders
- additionalHeaders for this call- Returns:
- OAuth2ScopeConsentGrant
- Throws:
ApiException
- if fails to make API call
-
listApplicationGroupAssignments
public List<ApplicationGroupAssignment> listApplicationGroupAssignments(String appId, String q, String after, Integer limit, String expand) throws ApiException List all Assigned Groups Lists all group assignments for an application- Parameters:
appId
- `id` of the Application (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:
ApiException
- if fails to make API call
-
listApplicationGroupAssignments
public List<ApplicationGroupAssignment> listApplicationGroupAssignments(String appId, String q, String after, Integer limit, String expand, Map<String, String> additionalHeaders) throws ApiExceptionList all Assigned Groups Lists all group assignments for an application- Parameters:
appId
- `id` of the Application (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)additionalHeaders
- additionalHeaders for this call- Returns:
- List<ApplicationGroupAssignment>
- Throws:
ApiException
- if fails to make API call
-
listApplicationKeys
List all Key Credentials Lists all key credentials for an application- Parameters:
appId
- `id` of the Application (required)- Returns:
- List<JsonWebKey>
- Throws:
ApiException
- if fails to make API call
-
listApplicationKeys
public List<JsonWebKey> listApplicationKeys(String appId, Map<String, String> additionalHeaders) throws ApiExceptionList all Key Credentials Lists all key credentials for an application- Parameters:
appId
- `id` of the Application (required)additionalHeaders
- additionalHeaders for this call- Returns:
- List<JsonWebKey>
- Throws:
ApiException
- if fails to make API call
-
listApplicationUsers
public List<AppUser> listApplicationUsers(String appId, String q, String queryScope, String after, Integer limit, String filter, String expand) throws ApiException List all Assigned Users Lists all assigned [application users](#application-user-model) for an application- Parameters:
appId
- `id` of the Application (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:
ApiException
- if fails to make API call
-
listApplicationUsers
public List<AppUser> listApplicationUsers(String appId, String q, String queryScope, String after, Integer limit, String filter, String expand, Map<String, String> additionalHeaders) throws ApiExceptionList all Assigned Users Lists all assigned [application users](#application-user-model) for an application- Parameters:
appId
- `id` of the Application (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)additionalHeaders
- additionalHeaders for this call- Returns:
- List<AppUser>
- Throws:
ApiException
- if fails to make API call
-
listApplications
public List<Application> listApplications(String q, String after, Integer limit, String filter, String expand, Boolean includeNonDeleted) throws ApiException List all Applications Lists all applications with pagination. A subset of apps can be returned that match a supported filter expression or query.- Parameters:
q
- (optional)after
- Specifies the pagination cursor for the next page of apps (optional)limit
- Specifies the number of results for a page (optional, default to -1)filter
- Filters apps by status, user.id, group.id or credentials.signing.kid expression (optional)expand
- Traverses users link relationship and optionally embeds Application User resource (optional)includeNonDeleted
- (optional, default to false)- Returns:
- List<Application>
- Throws:
ApiException
- if fails to make API call
-
listApplications
public List<Application> listApplications(String q, String after, Integer limit, String filter, String expand, Boolean includeNonDeleted, Map<String, String> additionalHeaders) throws ApiExceptionList all Applications Lists all applications with pagination. A subset of apps can be returned that match a supported filter expression or query.- Parameters:
q
- (optional)after
- Specifies the pagination cursor for the next page of apps (optional)limit
- Specifies the number of results for a page (optional, default to -1)filter
- Filters apps by status, user.id, group.id or credentials.signing.kid expression (optional)expand
- Traverses users link relationship and optionally embeds Application User resource (optional)includeNonDeleted
- (optional, default to false)additionalHeaders
- additionalHeaders for this call- Returns:
- List<Application>
- Throws:
ApiException
- if fails to make API call
-
listCsrsForApplication
List all Certificate Signing Requests Lists all Certificate Signing Requests for an application- Parameters:
appId
- `id` of the Application (required)- Returns:
- List<Csr>
- Throws:
ApiException
- if fails to make API call
-
listCsrsForApplication
public List<Csr> listCsrsForApplication(String appId, Map<String, String> additionalHeaders) throws ApiExceptionList all Certificate Signing Requests Lists all Certificate Signing Requests for an application- Parameters:
appId
- `id` of the Application (required)additionalHeaders
- additionalHeaders for this call- Returns:
- List<Csr>
- Throws:
ApiException
- if fails to make API call
-
listFeaturesForApplication
List all Features Lists all features for an application- Parameters:
appId
- `id` of the Application (required)- Returns:
- List<ApplicationFeature>
- Throws:
ApiException
- if fails to make API call
-
listFeaturesForApplication
public List<ApplicationFeature> listFeaturesForApplication(String appId, Map<String, String> additionalHeaders) throws ApiExceptionList all Features Lists all features for an application- Parameters:
appId
- `id` of the Application (required)additionalHeaders
- additionalHeaders for this call- Returns:
- List<ApplicationFeature>
- Throws:
ApiException
- if fails to make API call
-
listOAuth2TokensForApplication
public List<OAuth2Token> listOAuth2TokensForApplication(String appId, String expand, String after, Integer limit) throws ApiException List all OAuth 2.0 Tokens Lists all tokens for the application- Parameters:
appId
- `id` of the Application (required)expand
- (optional)after
- (optional)limit
- (optional, default to 20)- Returns:
- List<OAuth2Token>
- Throws:
ApiException
- if fails to make API call
-
listOAuth2TokensForApplication
public List<OAuth2Token> listOAuth2TokensForApplication(String appId, String expand, String after, Integer limit, Map<String, String> additionalHeaders) throws ApiExceptionList all OAuth 2.0 Tokens Lists all tokens for the application- Parameters:
appId
- `id` of the Application (required)expand
- (optional)after
- (optional)limit
- (optional, default to 20)additionalHeaders
- additionalHeaders for this call- Returns:
- List<OAuth2Token>
- Throws:
ApiException
- if fails to make API call
-
listScopeConsentGrants
public List<OAuth2ScopeConsentGrant> listScopeConsentGrants(String appId, String expand) throws ApiException List all Scope Consent Grants Lists all scope consent grants for the application- Parameters:
appId
- `id` of the Application (required)expand
- (optional)- Returns:
- List<OAuth2ScopeConsentGrant>
- Throws:
ApiException
- if fails to make API call
-
listScopeConsentGrants
public List<OAuth2ScopeConsentGrant> listScopeConsentGrants(String appId, String expand, Map<String, String> additionalHeaders) throws ApiExceptionList all Scope Consent Grants Lists all scope consent grants for the application- Parameters:
appId
- `id` of the Application (required)expand
- (optional)additionalHeaders
- additionalHeaders for this call- Returns:
- List<OAuth2ScopeConsentGrant>
- Throws:
ApiException
- if fails to make API call
-
publishCsrFromApplication
public JsonWebKey publishCsrFromApplication(String appId, String csrId, File body) throws ApiException Publish a Certificate Signing Request Publishes a certificate signing request for the app with a signed X.509 certificate and adds it into the application key credentials- Parameters:
appId
- `id` of the Application (required)csrId
- `id` of the CSR (required)body
- (required)- Returns:
- JsonWebKey
- Throws:
ApiException
- if fails to make API call
-
publishCsrFromApplication
public JsonWebKey publishCsrFromApplication(String appId, String csrId, File body, Map<String, String> additionalHeaders) throws ApiExceptionPublish a Certificate Signing Request Publishes a certificate signing request for the app with a signed X.509 certificate and adds it into the application key credentials- Parameters:
appId
- `id` of the Application (required)csrId
- `id` of the CSR (required)body
- (required)additionalHeaders
- additionalHeaders for this call- Returns:
- JsonWebKey
- Throws:
ApiException
- if fails to make API call
-
replaceApplication
Replace an Application Replaces an application- Parameters:
appId
- `id` of the Application (required)application
- (required)- Returns:
- Application
- Throws:
ApiException
- if fails to make API call
-
replaceApplication
public Application replaceApplication(String appId, Application application, Map<String, String> additionalHeaders) throws ApiExceptionReplace an Application Replaces an application- Parameters:
appId
- `id` of the Application (required)application
- (required)additionalHeaders
- additionalHeaders for this call- Returns:
- Application
- Throws:
ApiException
- if fails to make API call
-
revokeCsrFromApplication
Revoke a Certificate Signing Request Revokes a certificate signing request and deletes the key pair from the application- Parameters:
appId
- `id` of the Application (required)csrId
- `id` of the CSR (required)- Throws:
ApiException
- if fails to make API call
-
revokeCsrFromApplication
public void revokeCsrFromApplication(String appId, String csrId, Map<String, String> additionalHeaders) throws ApiExceptionRevoke a Certificate Signing Request Revokes a certificate signing request and deletes the key pair from the application- Parameters:
appId
- `id` of the Application (required)csrId
- `id` of the CSR (required)additionalHeaders
- additionalHeaders for this call- Throws:
ApiException
- if fails to make API call
-
revokeOAuth2TokenForApplication
Revoke an OAuth 2.0 Token Revokes the specified token for the specified application- Parameters:
appId
- `id` of the Application (required)tokenId
- `id` of Token (required)- Throws:
ApiException
- if fails to make API call
-
revokeOAuth2TokenForApplication
public void revokeOAuth2TokenForApplication(String appId, String tokenId, Map<String, String> additionalHeaders) throws ApiExceptionRevoke an OAuth 2.0 Token Revokes the specified token for the specified application- Parameters:
appId
- `id` of the Application (required)tokenId
- `id` of Token (required)additionalHeaders
- additionalHeaders for this call- Throws:
ApiException
- if fails to make API call
-
revokeOAuth2TokensForApplication
Revoke all OAuth 2.0 Tokens Revokes all tokens for the specified application- Parameters:
appId
- `id` of the Application (required)- Throws:
ApiException
- if fails to make API call
-
revokeOAuth2TokensForApplication
public void revokeOAuth2TokensForApplication(String appId, Map<String, String> additionalHeaders) throws ApiExceptionRevoke all OAuth 2.0 Tokens Revokes all tokens for the specified application- Parameters:
appId
- `id` of the Application (required)additionalHeaders
- additionalHeaders for this call- Throws:
ApiException
- if fails to make API call
-
revokeScopeConsentGrant
Revoke a Scope Consent Grant Revokes permission for the application to request the given scope- Parameters:
appId
- `id` of the Application (required)grantId
- `id` of the Grant (required)- Throws:
ApiException
- if fails to make API call
-
revokeScopeConsentGrant
public void revokeScopeConsentGrant(String appId, String grantId, Map<String, String> additionalHeaders) throws ApiExceptionRevoke a Scope Consent Grant Revokes permission for the application to request the given scope- Parameters:
appId
- `id` of the Application (required)grantId
- `id` of the Grant (required)additionalHeaders
- additionalHeaders for this call- Throws:
ApiException
- if fails to make API call
-
unassignApplicationFromGroup
Unassign a Group Unassigns a group from an application- Parameters:
appId
- `id` of the Application (required)groupId
- The `id` of the group (required)- Throws:
ApiException
- if fails to make API call
-
unassignApplicationFromGroup
public void unassignApplicationFromGroup(String appId, String groupId, Map<String, String> additionalHeaders) throws ApiExceptionUnassign a Group Unassigns a group from an application- Parameters:
appId
- `id` of the Application (required)groupId
- The `id` of the group (required)additionalHeaders
- additionalHeaders for this call- Throws:
ApiException
- if fails to make API call
-
unassignUserFromApplication
public void unassignUserFromApplication(String appId, String userId, Boolean sendEmail) throws ApiException Unassign a User Unassigns a user from an application- Parameters:
appId
- `id` of the Application (required)userId
- (required)sendEmail
- (optional, default to false)- Throws:
ApiException
- if fails to make API call
-
unassignUserFromApplication
public void unassignUserFromApplication(String appId, String userId, Boolean sendEmail, Map<String, String> additionalHeaders) throws ApiExceptionUnassign a User Unassigns a user from an application- Parameters:
appId
- `id` of the Application (required)userId
- (required)sendEmail
- (optional, default to false)additionalHeaders
- additionalHeaders for this call- Throws:
ApiException
- if fails to make API call
-
updateApplicationUser
public AppUser updateApplicationUser(String appId, String userId, AppUser appUser) throws ApiException Update an Application Profile for Assigned User Updates a user's profile for an application- Parameters:
appId
- `id` of the Application (required)userId
- (required)appUser
- (required)- Returns:
- AppUser
- Throws:
ApiException
- if fails to make API call
-
updateApplicationUser
public AppUser updateApplicationUser(String appId, String userId, AppUser appUser, Map<String, String> additionalHeaders) throws ApiExceptionUpdate an Application Profile for Assigned User Updates a user's profile for an application- Parameters:
appId
- `id` of the Application (required)userId
- (required)appUser
- (required)additionalHeaders
- additionalHeaders for this call- Returns:
- AppUser
- Throws:
ApiException
- if fails to make API call
-
updateDefaultProvisioningConnectionForApplication
public ProvisioningConnection updateDefaultProvisioningConnectionForApplication(String appId, ProvisioningConnectionRequest provisioningConnectionRequest, Boolean activate) throws ApiException Update the default Provisioning Connection Updates the default provisioning connection for application- Parameters:
appId
- `id` of the Application (required)provisioningConnectionRequest
- (required)activate
- (optional)- Returns:
- ProvisioningConnection
- Throws:
ApiException
- if fails to make API call
-
updateDefaultProvisioningConnectionForApplication
public ProvisioningConnection updateDefaultProvisioningConnectionForApplication(String appId, ProvisioningConnectionRequest provisioningConnectionRequest, Boolean activate, Map<String, String> additionalHeaders) throws ApiExceptionUpdate the default Provisioning Connection Updates the default provisioning connection for application- Parameters:
appId
- `id` of the Application (required)provisioningConnectionRequest
- (required)activate
- (optional)additionalHeaders
- additionalHeaders for this call- Returns:
- ProvisioningConnection
- Throws:
ApiException
- if fails to make API call
-
updateFeatureForApplication
public ApplicationFeature updateFeatureForApplication(String appId, String featureName, CapabilitiesObject capabilitiesObject) throws ApiException Update a Feature Updates a Feature object for an application- Parameters:
appId
- `id` of the Application (required)featureName
- Name of the Feature (required)capabilitiesObject
- (required)- Returns:
- ApplicationFeature
- Throws:
ApiException
- if fails to make API call
-
updateFeatureForApplication
public ApplicationFeature updateFeatureForApplication(String appId, String featureName, CapabilitiesObject capabilitiesObject, Map<String, String> additionalHeaders) throws ApiExceptionUpdate a Feature Updates a Feature object for an application- Parameters:
appId
- `id` of the Application (required)featureName
- Name of the Feature (required)capabilitiesObject
- (required)additionalHeaders
- additionalHeaders for this call- Returns:
- ApplicationFeature
- Throws:
ApiException
- if fails to make API call
-
uploadApplicationLogo
Upload a Logo Uploads a logo for the application. 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.- Parameters:
appId
- `id` of the Application (required)_file
- (required)- Throws:
ApiException
- if fails to make API call
-
uploadApplicationLogo
public void uploadApplicationLogo(String appId, File _file, Map<String, String> additionalHeaders) throws ApiExceptionUpload a Logo Uploads a logo for the application. 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.- Parameters:
appId
- `id` of the Application (required)_file
- (required)additionalHeaders
- additionalHeaders for this call- Throws:
ApiException
- if fails to make API call
-
getObjectMapper
protected static com.fasterxml.jackson.databind.ObjectMapper getObjectMapper()
-