@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", date="2023-01-18T04:14:02.238-06:00[America/Chicago]") @Component(value="org.openapitools.client.api.ApplicationApi") public class ApplicationApi extends Object
Constructor and Description |
---|
ApplicationApi() |
ApplicationApi(ApiClient apiClient) |
Modifier and Type | Method and Description |
---|---|
void |
activateApplication(String appId)
Activate an Application
Activates an inactive application
|
void |
activateDefaultProvisioningConnectionForApplication(String appId)
Activate the default Provisioning Connection
Activates the default Provisioning Connection for an application
|
void |
assignApplicationPolicy(String appId,
String policyId)
Assign an application to a specific policy
Assign an application to a specific policy.
|
<T> T |
assignGroupToApplication(Class<?> T,
String appId,
String groupId,
ApplicationGroupAssignment applicationGroupAssignment)
Assign a Group
Assigns a group to an application
|
ApplicationGroupAssignment |
assignGroupToApplication(String appId,
String groupId,
ApplicationGroupAssignment applicationGroupAssignment)
Assign a Group
Assigns a group to an application
|
PagedList |
assignGroupToApplicationWithPaginationInfo(String appId,
String groupId,
ApplicationGroupAssignment applicationGroupAssignment)
Assign a Group
Assigns a group to an application
|
<T> T |
assignUserToApplication(Class<?> T,
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).
|
AppUser |
assignUserToApplication(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).
|
PagedList |
assignUserToApplicationWithPaginationInfo(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).
|
JsonWebKey |
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.
|
PagedList |
cloneApplicationKeyWithPaginationInfo(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.
|
Application |
createApplication(Application application,
Boolean activate,
String oktaAccessGatewayAgent)
Create an Application
Creates a new application to your Okta organization
|
<T> T |
createApplication(Class<?> T,
Application application,
Boolean activate,
String oktaAccessGatewayAgent)
Create an Application
Creates a new application to your Okta organization
|
PagedList |
createApplicationWithPaginationInfo(Application application,
Boolean activate,
String oktaAccessGatewayAgent)
Create an Application
Creates a new application to your Okta organization
|
void |
deactivateApplication(String appId)
Deactivate an Application
Deactivates an active application
|
void |
deactivateDefaultProvisioningConnectionForApplication(String appId)
Deactivate the default Provisioning Connection for an Application
Deactivates the default Provisioning Connection for an application
|
void |
deleteApplication(String appId)
Delete an Application
Deletes an inactive application
|
JsonWebKey |
generateApplicationKey(String appId,
Integer validityYears)
Generate a Key Credential
Generates a new X.509 certificate for an application key credential
|
PagedList |
generateApplicationKeyWithPaginationInfo(String appId,
Integer validityYears)
Generate a Key Credential
Generates a new X.509 certificate for an application key credential
|
<T> T |
generateCsrForApplication(Class<?> T,
String appId,
CsrMetadata metadata)
Generate a Certificate Signing Request
Generates a new key pair and returns the Certificate Signing Request for it
|
Csr |
generateCsrForApplication(String appId,
CsrMetadata metadata)
Generate a Certificate Signing Request
Generates a new key pair and returns the Certificate Signing Request for it
|
PagedList |
generateCsrForApplicationWithPaginationInfo(String appId,
CsrMetadata metadata)
Generate a Certificate Signing Request
Generates a new key pair and returns the Certificate Signing Request for it
|
ApiClient |
getApiClient() |
Application |
getApplication(String appId,
String expand)
Retrieve an Application
Retrieves an application from your Okta organization by `id`
|
ApplicationGroupAssignment |
getApplicationGroupAssignment(String appId,
String groupId,
String expand)
Retrieve an Assigned Group
Retrieves an application group assignment
|
PagedList |
getApplicationGroupAssignmentWithPaginationInfo(String appId,
String groupId,
String expand)
Retrieve an Assigned Group
Retrieves an application group assignment
|
JsonWebKey |
getApplicationKey(String appId,
String keyId)
Retrieve a Key Credential
Retrieves a specific application key credential by kid
|
PagedList |
getApplicationKeyWithPaginationInfo(String appId,
String keyId)
Retrieve a Key Credential
Retrieves a specific application key credential by kid
|
AppUser |
getApplicationUser(String appId,
String userId,
String expand)
Retrieve an Assigned User
Retrieves a specific user assignment for application by `id`
|
PagedList |
getApplicationUserWithPaginationInfo(String appId,
String userId,
String expand)
Retrieve an Assigned User
Retrieves a specific user assignment for application by `id`
|
PagedList |
getApplicationWithPaginationInfo(String appId,
String expand)
Retrieve an Application
Retrieves an application from your Okta organization by `id`
|
Csr |
getCsrForApplication(String appId,
String csrId)
Retrieve a Certificate Signing Request
Retrieves a certificate signing request for the app by `id`
|
PagedList |
getCsrForApplicationWithPaginationInfo(String appId,
String csrId)
Retrieve a Certificate Signing Request
Retrieves a certificate signing request for the app by `id`
|
ProvisioningConnection |
getDefaultProvisioningConnectionForApplication(String appId)
Retrieve the default Provisioning Connection
Retrieves the default Provisioning Connection for application
|
PagedList |
getDefaultProvisioningConnectionForApplicationWithPaginationInfo(String appId)
Retrieve the default Provisioning Connection
Retrieves the default Provisioning Connection for application
|
ApplicationFeature |
getFeatureForApplication(String appId,
String name)
Retrieve a Feature
Retrieves a Feature object for an application
|
PagedList |
getFeatureForApplicationWithPaginationInfo(String appId,
String name)
Retrieve a Feature
Retrieves a Feature object for an application
|
OAuth2Token |
getOAuth2TokenForApplication(String appId,
String tokenId,
String expand)
Retrieve an OAuth 2.0 Token
Retrieves a token for the specified application
|
PagedList |
getOAuth2TokenForApplicationWithPaginationInfo(String appId,
String tokenId,
String expand)
Retrieve an OAuth 2.0 Token
Retrieves a token for the specified application
|
OAuth2ScopeConsentGrant |
getScopeConsentGrant(String appId,
String grantId,
String expand)
Retrieve a Scope Consent Grant
Retrieves a single scope consent grant for the application
|
PagedList |
getScopeConsentGrantWithPaginationInfo(String appId,
String grantId,
String expand)
Retrieve a Scope Consent Grant
Retrieves a single scope consent grant for the application
|
<T> T |
grantConsentToScope(Class<?> T,
String appId,
OAuth2ScopeConsentGrant oAuth2ScopeConsentGrant)
Grant Consent to Scope
Grants consent for the application to request an OAuth 2.0 Okta scope
|
OAuth2ScopeConsentGrant |
grantConsentToScope(String appId,
OAuth2ScopeConsentGrant oAuth2ScopeConsentGrant)
Grant Consent to Scope
Grants consent for the application to request an OAuth 2.0 Okta scope
|
PagedList |
grantConsentToScopeWithPaginationInfo(String appId,
OAuth2ScopeConsentGrant oAuth2ScopeConsentGrant)
Grant Consent to Scope
Grants consent for the application to request an OAuth 2.0 Okta scope
|
List<ApplicationGroupAssignment> |
listApplicationGroupAssignments(String appId,
String q,
String after,
Integer limit,
String expand)
List all Assigned Groups
Lists all group assignments for an application
|
PagedList |
listApplicationGroupAssignmentsWithPaginationInfo(String appId,
String q,
String after,
Integer limit,
String expand)
List all Assigned Groups
Lists all group assignments for an application
|
List<JsonWebKey> |
listApplicationKeys(String appId)
List all Key Credentials
Lists all key credentials for an application
|
PagedList |
listApplicationKeysWithPaginationInfo(String appId)
List all Key Credentials
Lists all key credentials for an application
|
List<Application> |
listApplications(String q,
String after,
Integer limit,
String filter,
String expand,
Boolean includeNonDeleted)
List all Applications
Lists all applications with pagination.
|
PagedList |
listApplicationsWithPaginationInfo(String q,
String after,
Integer limit,
String filter,
String expand,
Boolean includeNonDeleted)
List all Applications
Lists all applications with pagination.
|
List<AppUser> |
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 application
|
PagedList |
listApplicationUsersWithPaginationInfo(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 application
|
List<Csr> |
listCsrsForApplication(String appId)
List all Certificate Signing Requests
Lists all Certificate Signing Requests for an application
|
PagedList |
listCsrsForApplicationWithPaginationInfo(String appId)
List all Certificate Signing Requests
Lists all Certificate Signing Requests for an application
|
List<ApplicationFeature> |
listFeaturesForApplication(String appId)
List all Features
Lists all features for an application
|
PagedList |
listFeaturesForApplicationWithPaginationInfo(String appId)
List all Features
Lists all features for an application
|
List<OAuth2Token> |
listOAuth2TokensForApplication(String appId,
String expand,
String after,
Integer limit)
List all OAuth 2.0 Tokens
Lists all tokens for the application
|
PagedList |
listOAuth2TokensForApplicationWithPaginationInfo(String appId,
String expand,
String after,
Integer limit)
List all OAuth 2.0 Tokens
Lists all tokens for the application
|
List<OAuth2ScopeConsentGrant> |
listScopeConsentGrants(String appId,
String expand)
List all Scope Consent Grants
Lists all scope consent grants for the application
|
PagedList |
listScopeConsentGrantsWithPaginationInfo(String appId,
String expand)
List all Scope Consent Grants
Lists all scope consent grants for the application
|
<T> T |
publishCsrFromApplication(Class<?> T,
String appId,
String csrId,
File body)
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
|
JsonWebKey |
publishCsrFromApplication(String appId,
String csrId,
File body)
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
|
PagedList |
publishCsrFromApplicationWithPaginationInfo(String appId,
String csrId,
File body)
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
|
<T> T |
replaceApplication(Class<?> T,
String appId,
Application application)
Replace an Application
Replaces an application
|
Application |
replaceApplication(String appId,
Application application)
Replace an Application
Replaces an application
|
PagedList |
replaceApplicationWithPaginationInfo(String appId,
Application application)
Replace an Application
Replaces an application
|
void |
revokeCsrFromApplication(String appId,
String csrId)
Revoke a Certificate Signing Request
Revokes a certificate signing request and deletes the key pair from the application
|
void |
revokeOAuth2TokenForApplication(String appId,
String tokenId)
Revoke an OAuth 2.0 Token
Revokes the specified token for the specified application
|
void |
revokeOAuth2TokensForApplication(String appId)
Revoke all OAuth 2.0 Tokens
Revokes all tokens for the specified application
|
void |
revokeScopeConsentGrant(String appId,
String grantId)
Revoke a Scope Consent Grant
Revokes permission for the application to request the given scope
|
void |
setApiClient(ApiClient apiClient) |
void |
unassignApplicationFromGroup(String appId,
String groupId)
Unassign a Group
Unassigns a group from an application
|
void |
unassignUserFromApplication(String appId,
String userId,
Boolean sendEmail)
Unassign a User
Unassigns a user from an application
|
<T> T |
updateApplicationUser(Class<?> T,
String appId,
String userId,
AppUser appUser)
Update an Application Profile for Assigned User
Updates a user's profile for an application
|
AppUser |
updateApplicationUser(String appId,
String userId,
AppUser appUser)
Update an Application Profile for Assigned User
Updates a user's profile for an application
|
PagedList |
updateApplicationUserWithPaginationInfo(String appId,
String userId,
AppUser appUser)
Update an Application Profile for Assigned User
Updates a user's profile for an application
|
<T> T |
updateDefaultProvisioningConnectionForApplication(Class<?> T,
String appId,
ProvisioningConnectionRequest provisioningConnectionRequest,
Boolean activate)
Update the default Provisioning Connection
Updates the default provisioning connection for application
|
ProvisioningConnection |
updateDefaultProvisioningConnectionForApplication(String appId,
ProvisioningConnectionRequest provisioningConnectionRequest,
Boolean activate)
Update the default Provisioning Connection
Updates the default provisioning connection for application
|
PagedList |
updateDefaultProvisioningConnectionForApplicationWithPaginationInfo(String appId,
ProvisioningConnectionRequest provisioningConnectionRequest,
Boolean activate)
Update the default Provisioning Connection
Updates the default provisioning connection for application
|
<T> T |
updateFeatureForApplication(Class<?> T,
String appId,
String name,
CapabilitiesObject capabilitiesObject)
Update a Feature
Updates a Feature object for an application
|
ApplicationFeature |
updateFeatureForApplication(String appId,
String name,
CapabilitiesObject capabilitiesObject)
Update a Feature
Updates a Feature object for an application
|
PagedList |
updateFeatureForApplicationWithPaginationInfo(String appId,
String name,
CapabilitiesObject capabilitiesObject)
Update a Feature
Updates a Feature object for an application
|
void |
uploadApplicationLogo(String appId,
File _file)
Upload a Logo
The file must be in PNG, JPG, or GIF format, and less than 1 MB in size.
|
public ApplicationApi()
@Autowired public ApplicationApi(ApiClient apiClient)
public ApiClient getApiClient()
public void setApiClient(ApiClient apiClient)
public void activateApplication(String appId) throws org.springframework.web.client.RestClientException
200 - Success
403 - Forbidden
404 - Not Found
429 - Too Many Requests
appId
- (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic void activateDefaultProvisioningConnectionForApplication(String appId) throws org.springframework.web.client.RestClientException
204 - No Content
403 - Forbidden
404 - Not Found
429 - Too Many Requests
appId
- (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic void assignApplicationPolicy(String appId, String policyId) throws org.springframework.web.client.RestClientException
204 - No Content
appId
- (required)policyId
- (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic ApplicationGroupAssignment assignGroupToApplication(String appId, String groupId, ApplicationGroupAssignment applicationGroupAssignment) throws org.springframework.web.client.RestClientException
200 - Success
400 - Bad Request
403 - Forbidden
404 - Not Found
429 - Too Many Requests
appId
- (required)groupId
- (required)applicationGroupAssignment
- (optional)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic <T> T assignGroupToApplication(Class<?> T, String appId, String groupId, ApplicationGroupAssignment applicationGroupAssignment) throws org.springframework.web.client.RestClientException
200 - Success
400 - Bad Request
403 - Forbidden
404 - Not Found
429 - Too Many Requests
T
- (required) - the assignable return typeappId
- (required)groupId
- (required)applicationGroupAssignment
- (optional)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic PagedList assignGroupToApplicationWithPaginationInfo(String appId, String groupId, ApplicationGroupAssignment applicationGroupAssignment) throws org.springframework.web.client.RestClientException
200 - Success
400 - Bad Request
403 - Forbidden
404 - Not Found
429 - Too Many Requests
appId
- (required)groupId
- (required)applicationGroupAssignment
- (optional)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic AppUser assignUserToApplication(String appId, AppUser appUser) throws org.springframework.web.client.RestClientException
200 - Success
400 - Bad Request
403 - Forbidden
404 - Not Found
429 - Too Many Requests
appId
- (required)appUser
- (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic <T> T assignUserToApplication(Class<?> T, String appId, AppUser appUser) throws org.springframework.web.client.RestClientException
200 - Success
400 - Bad Request
403 - Forbidden
404 - Not Found
429 - Too Many Requests
T
- (required) - the assignable return typeappId
- (required)appUser
- (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic PagedList assignUserToApplicationWithPaginationInfo(String appId, AppUser appUser) throws org.springframework.web.client.RestClientException
200 - Success
400 - Bad Request
403 - Forbidden
404 - Not Found
429 - Too Many Requests
appId
- (required)appUser
- (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic JsonWebKey cloneApplicationKey(String appId, String keyId, String targetAid) throws org.springframework.web.client.RestClientException
201 - Created
403 - Forbidden
404 - Not Found
429 - Too Many Requests
appId
- (required)keyId
- (required)targetAid
- Unique key of the target Application (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic PagedList cloneApplicationKeyWithPaginationInfo(String appId, String keyId, String targetAid) throws org.springframework.web.client.RestClientException
201 - Created
403 - Forbidden
404 - Not Found
429 - Too Many Requests
appId
- (required)keyId
- (required)targetAid
- Unique key of the target Application (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic Application createApplication(Application application, Boolean activate, String oktaAccessGatewayAgent) throws org.springframework.web.client.RestClientException
200 - Success
400 - Bad Request
403 - Forbidden
429 - Too Many Requests
application
- (required)activate
- Executes activation lifecycle operation when creating the app (optional, default to true)oktaAccessGatewayAgent
- (optional)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic <T> T createApplication(Class<?> T, Application application, Boolean activate, String oktaAccessGatewayAgent) throws org.springframework.web.client.RestClientException
200 - Success
400 - Bad Request
403 - Forbidden
429 - Too Many Requests
T
- (required) - the assignable return typeapplication
- (required)activate
- Executes activation lifecycle operation when creating the app (optional, default to true)oktaAccessGatewayAgent
- (optional)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic PagedList createApplicationWithPaginationInfo(Application application, Boolean activate, String oktaAccessGatewayAgent) throws org.springframework.web.client.RestClientException
200 - Success
400 - Bad Request
403 - Forbidden
429 - Too Many Requests
application
- (required)activate
- Executes activation lifecycle operation when creating the app (optional, default to true)oktaAccessGatewayAgent
- (optional)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic void deactivateApplication(String appId) throws org.springframework.web.client.RestClientException
200 - Success
403 - Forbidden
404 - Not Found
429 - Too Many Requests
appId
- (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic void deactivateDefaultProvisioningConnectionForApplication(String appId) throws org.springframework.web.client.RestClientException
204 - No Content
403 - Forbidden
404 - Not Found
429 - Too Many Requests
appId
- (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic void deleteApplication(String appId) throws org.springframework.web.client.RestClientException
204 - No Content
403 - Forbidden
404 - Not Found
429 - Too Many Requests
appId
- (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic JsonWebKey generateApplicationKey(String appId, Integer validityYears) throws org.springframework.web.client.RestClientException
201 - Created
403 - Forbidden
404 - Not Found
429 - Too Many Requests
appId
- (required)validityYears
- (optional)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic PagedList generateApplicationKeyWithPaginationInfo(String appId, Integer validityYears) throws org.springframework.web.client.RestClientException
201 - Created
403 - Forbidden
404 - Not Found
429 - Too Many Requests
appId
- (required)validityYears
- (optional)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic Csr generateCsrForApplication(String appId, CsrMetadata metadata) throws org.springframework.web.client.RestClientException
201 - Created
400 - Bad Request
403 - Forbidden
404 - Not Found
429 - Too Many Requests
appId
- (required)metadata
- (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic <T> T generateCsrForApplication(Class<?> T, String appId, CsrMetadata metadata) throws org.springframework.web.client.RestClientException
201 - Created
400 - Bad Request
403 - Forbidden
404 - Not Found
429 - Too Many Requests
T
- (required) - the assignable return typeappId
- (required)metadata
- (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic PagedList generateCsrForApplicationWithPaginationInfo(String appId, CsrMetadata metadata) throws org.springframework.web.client.RestClientException
201 - Created
400 - Bad Request
403 - Forbidden
404 - Not Found
429 - Too Many Requests
appId
- (required)metadata
- (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic Application getApplication(String appId, String expand) throws org.springframework.web.client.RestClientException
200 - Success
403 - Forbidden
404 - Not Found
429 - Too Many Requests
appId
- (required)expand
- (optional)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic PagedList getApplicationWithPaginationInfo(String appId, String expand) throws org.springframework.web.client.RestClientException
200 - Success
403 - Forbidden
404 - Not Found
429 - Too Many Requests
appId
- (required)expand
- (optional)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic ApplicationGroupAssignment getApplicationGroupAssignment(String appId, String groupId, String expand) throws org.springframework.web.client.RestClientException
200 - Success
403 - Forbidden
404 - Not Found
429 - Too Many Requests
appId
- (required)groupId
- (required)expand
- (optional)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic PagedList getApplicationGroupAssignmentWithPaginationInfo(String appId, String groupId, String expand) throws org.springframework.web.client.RestClientException
200 - Success
403 - Forbidden
404 - Not Found
429 - Too Many Requests
appId
- (required)groupId
- (required)expand
- (optional)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic JsonWebKey getApplicationKey(String appId, String keyId) throws org.springframework.web.client.RestClientException
200 - Success
403 - Forbidden
404 - Not Found
429 - Too Many Requests
appId
- (required)keyId
- (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic PagedList getApplicationKeyWithPaginationInfo(String appId, String keyId) throws org.springframework.web.client.RestClientException
200 - Success
403 - Forbidden
404 - Not Found
429 - Too Many Requests
appId
- (required)keyId
- (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic AppUser getApplicationUser(String appId, String userId, String expand) throws org.springframework.web.client.RestClientException
200 - Success
403 - Forbidden
404 - Not Found
429 - Too Many Requests
appId
- (required)userId
- (required)expand
- (optional)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic PagedList getApplicationUserWithPaginationInfo(String appId, String userId, String expand) throws org.springframework.web.client.RestClientException
200 - Success
403 - Forbidden
404 - Not Found
429 - Too Many Requests
appId
- (required)userId
- (required)expand
- (optional)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic Csr getCsrForApplication(String appId, String csrId) throws org.springframework.web.client.RestClientException
200 - Success
403 - Forbidden
404 - Not Found
429 - Too Many Requests
appId
- (required)csrId
- (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic PagedList getCsrForApplicationWithPaginationInfo(String appId, String csrId) throws org.springframework.web.client.RestClientException
200 - Success
403 - Forbidden
404 - Not Found
429 - Too Many Requests
appId
- (required)csrId
- (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic ProvisioningConnection getDefaultProvisioningConnectionForApplication(String appId) throws org.springframework.web.client.RestClientException
200 - Success
403 - Forbidden
404 - Not Found
429 - Too Many Requests
appId
- (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic PagedList getDefaultProvisioningConnectionForApplicationWithPaginationInfo(String appId) throws org.springframework.web.client.RestClientException
200 - Success
403 - Forbidden
404 - Not Found
429 - Too Many Requests
appId
- (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic ApplicationFeature getFeatureForApplication(String appId, String name) throws org.springframework.web.client.RestClientException
200 - Success
403 - Forbidden
404 - Not Found
429 - Too Many Requests
appId
- (required)name
- (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic PagedList getFeatureForApplicationWithPaginationInfo(String appId, String name) throws org.springframework.web.client.RestClientException
200 - Success
403 - Forbidden
404 - Not Found
429 - Too Many Requests
appId
- (required)name
- (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic OAuth2Token getOAuth2TokenForApplication(String appId, String tokenId, String expand) throws org.springframework.web.client.RestClientException
200 - Success
403 - Forbidden
404 - Not Found
429 - Too Many Requests
appId
- (required)tokenId
- (required)expand
- (optional)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic PagedList getOAuth2TokenForApplicationWithPaginationInfo(String appId, String tokenId, String expand) throws org.springframework.web.client.RestClientException
200 - Success
403 - Forbidden
404 - Not Found
429 - Too Many Requests
appId
- (required)tokenId
- (required)expand
- (optional)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic OAuth2ScopeConsentGrant getScopeConsentGrant(String appId, String grantId, String expand) throws org.springframework.web.client.RestClientException
200 - Success
403 - Forbidden
404 - Not Found
429 - Too Many Requests
appId
- (required)grantId
- (required)expand
- (optional)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic PagedList getScopeConsentGrantWithPaginationInfo(String appId, String grantId, String expand) throws org.springframework.web.client.RestClientException
200 - Success
403 - Forbidden
404 - Not Found
429 - Too Many Requests
appId
- (required)grantId
- (required)expand
- (optional)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic OAuth2ScopeConsentGrant grantConsentToScope(String appId, OAuth2ScopeConsentGrant oAuth2ScopeConsentGrant) throws org.springframework.web.client.RestClientException
201 - Created
400 - Bad Request
403 - Forbidden
404 - Not Found
429 - Too Many Requests
appId
- (required)oAuth2ScopeConsentGrant
- (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic <T> T grantConsentToScope(Class<?> T, String appId, OAuth2ScopeConsentGrant oAuth2ScopeConsentGrant) throws org.springframework.web.client.RestClientException
201 - Created
400 - Bad Request
403 - Forbidden
404 - Not Found
429 - Too Many Requests
T
- (required) - the assignable return typeappId
- (required)oAuth2ScopeConsentGrant
- (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic PagedList grantConsentToScopeWithPaginationInfo(String appId, OAuth2ScopeConsentGrant oAuth2ScopeConsentGrant) throws org.springframework.web.client.RestClientException
201 - Created
400 - Bad Request
403 - Forbidden
404 - Not Found
429 - Too Many Requests
appId
- (required)oAuth2ScopeConsentGrant
- (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic List<ApplicationGroupAssignment> listApplicationGroupAssignments(String appId, String q, String after, Integer limit, String expand) throws org.springframework.web.client.RestClientException
200 - Success
403 - Forbidden
404 - Not Found
429 - Too Many Requests
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)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic PagedList listApplicationGroupAssignmentsWithPaginationInfo(String appId, String q, String after, Integer limit, String expand) throws org.springframework.web.client.RestClientException
200 - Success
403 - Forbidden
404 - Not Found
429 - Too Many Requests
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)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic List<JsonWebKey> listApplicationKeys(String appId) throws org.springframework.web.client.RestClientException
200 - Success
403 - Forbidden
404 - Not Found
429 - Too Many Requests
appId
- (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic PagedList listApplicationKeysWithPaginationInfo(String appId) throws org.springframework.web.client.RestClientException
200 - Success
403 - Forbidden
404 - Not Found
429 - Too Many Requests
appId
- (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic List<AppUser> listApplicationUsers(String appId, String q, String queryScope, String after, Integer limit, String filter, String expand) throws org.springframework.web.client.RestClientException
200 - Success
403 - Forbidden
404 - Not Found
429 - Too Many Requests
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)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic PagedList listApplicationUsersWithPaginationInfo(String appId, String q, String queryScope, String after, Integer limit, String filter, String expand) throws org.springframework.web.client.RestClientException
200 - Success
403 - Forbidden
404 - Not Found
429 - Too Many Requests
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)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic List<Application> listApplications(String q, String after, Integer limit, String filter, String expand, Boolean includeNonDeleted) throws org.springframework.web.client.RestClientException
200 - Success
403 - Forbidden
429 - Too Many Requests
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)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic PagedList listApplicationsWithPaginationInfo(String q, String after, Integer limit, String filter, String expand, Boolean includeNonDeleted) throws org.springframework.web.client.RestClientException
200 - Success
403 - Forbidden
429 - Too Many Requests
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)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic List<Csr> listCsrsForApplication(String appId) throws org.springframework.web.client.RestClientException
200 - Success
403 - Forbidden
404 - Not Found
429 - Too Many Requests
appId
- (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic PagedList listCsrsForApplicationWithPaginationInfo(String appId) throws org.springframework.web.client.RestClientException
200 - Success
403 - Forbidden
404 - Not Found
429 - Too Many Requests
appId
- (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic List<ApplicationFeature> listFeaturesForApplication(String appId) throws org.springframework.web.client.RestClientException
200 - Success
403 - Forbidden
404 - Not Found
429 - Too Many Requests
appId
- (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic PagedList listFeaturesForApplicationWithPaginationInfo(String appId) throws org.springframework.web.client.RestClientException
200 - Success
403 - Forbidden
404 - Not Found
429 - Too Many Requests
appId
- (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic List<OAuth2Token> listOAuth2TokensForApplication(String appId, String expand, String after, Integer limit) throws org.springframework.web.client.RestClientException
200 - Success
403 - Forbidden
404 - Not Found
429 - Too Many Requests
appId
- (required)expand
- (optional)after
- (optional)limit
- (optional, default to 20)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic PagedList listOAuth2TokensForApplicationWithPaginationInfo(String appId, String expand, String after, Integer limit) throws org.springframework.web.client.RestClientException
200 - Success
403 - Forbidden
404 - Not Found
429 - Too Many Requests
appId
- (required)expand
- (optional)after
- (optional)limit
- (optional, default to 20)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic List<OAuth2ScopeConsentGrant> listScopeConsentGrants(String appId, String expand) throws org.springframework.web.client.RestClientException
200 - Success
403 - Forbidden
404 - Not Found
429 - Too Many Requests
appId
- (required)expand
- (optional)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic PagedList listScopeConsentGrantsWithPaginationInfo(String appId, String expand) throws org.springframework.web.client.RestClientException
200 - Success
403 - Forbidden
404 - Not Found
429 - Too Many Requests
appId
- (required)expand
- (optional)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic JsonWebKey publishCsrFromApplication(String appId, String csrId, File body) throws org.springframework.web.client.RestClientException
201 - Created
400 - Bad Request
403 - Forbidden
404 - Not Found
429 - Too Many Requests
appId
- (required)csrId
- (required)body
- (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic <T> T publishCsrFromApplication(Class<?> T, String appId, String csrId, File body) throws org.springframework.web.client.RestClientException
201 - Created
400 - Bad Request
403 - Forbidden
404 - Not Found
429 - Too Many Requests
T
- (required) - the assignable return typeappId
- (required)csrId
- (required)body
- (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic PagedList publishCsrFromApplicationWithPaginationInfo(String appId, String csrId, File body) throws org.springframework.web.client.RestClientException
201 - Created
400 - Bad Request
403 - Forbidden
404 - Not Found
429 - Too Many Requests
appId
- (required)csrId
- (required)body
- (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic Application replaceApplication(String appId, Application application) throws org.springframework.web.client.RestClientException
200 - Success
400 - Bad Request
403 - Forbidden
404 - Not Found
429 - Too Many Requests
appId
- (required)application
- (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic <T> T replaceApplication(Class<?> T, String appId, Application application) throws org.springframework.web.client.RestClientException
200 - Success
400 - Bad Request
403 - Forbidden
404 - Not Found
429 - Too Many Requests
T
- (required) - the assignable return typeappId
- (required)application
- (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic PagedList replaceApplicationWithPaginationInfo(String appId, Application application) throws org.springframework.web.client.RestClientException
200 - Success
400 - Bad Request
403 - Forbidden
404 - Not Found
429 - Too Many Requests
appId
- (required)application
- (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic void revokeCsrFromApplication(String appId, String csrId) throws org.springframework.web.client.RestClientException
204 - No Content
403 - Forbidden
404 - Not Found
429 - Too Many Requests
appId
- (required)csrId
- (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic void revokeOAuth2TokenForApplication(String appId, String tokenId) throws org.springframework.web.client.RestClientException
204 - No Content
403 - Forbidden
404 - Not Found
429 - Too Many Requests
appId
- (required)tokenId
- (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic void revokeOAuth2TokensForApplication(String appId) throws org.springframework.web.client.RestClientException
204 - No Content
403 - Forbidden
404 - Not Found
429 - Too Many Requests
appId
- (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic void revokeScopeConsentGrant(String appId, String grantId) throws org.springframework.web.client.RestClientException
204 - No Content
403 - Forbidden
404 - Not Found
429 - Too Many Requests
appId
- (required)grantId
- (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic void unassignApplicationFromGroup(String appId, String groupId) throws org.springframework.web.client.RestClientException
204 - No Content
403 - Forbidden
404 - Not Found
429 - Too Many Requests
appId
- (required)groupId
- (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic void unassignUserFromApplication(String appId, String userId, Boolean sendEmail) throws org.springframework.web.client.RestClientException
204 - No Content
403 - Forbidden
404 - Not Found
429 - Too Many Requests
appId
- (required)userId
- (required)sendEmail
- (optional, default to false)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic AppUser updateApplicationUser(String appId, String userId, AppUser appUser) throws org.springframework.web.client.RestClientException
200 - Success
400 - Bad Request
403 - Forbidden
404 - Not Found
429 - Too Many Requests
appId
- (required)userId
- (required)appUser
- (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic <T> T updateApplicationUser(Class<?> T, String appId, String userId, AppUser appUser) throws org.springframework.web.client.RestClientException
200 - Success
400 - Bad Request
403 - Forbidden
404 - Not Found
429 - Too Many Requests
T
- (required) - the assignable return typeappId
- (required)userId
- (required)appUser
- (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic PagedList updateApplicationUserWithPaginationInfo(String appId, String userId, AppUser appUser) throws org.springframework.web.client.RestClientException
200 - Success
400 - Bad Request
403 - Forbidden
404 - Not Found
429 - Too Many Requests
appId
- (required)userId
- (required)appUser
- (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic ProvisioningConnection updateDefaultProvisioningConnectionForApplication(String appId, ProvisioningConnectionRequest provisioningConnectionRequest, Boolean activate) throws org.springframework.web.client.RestClientException
201 - Created
400 - Bad Request
403 - Forbidden
404 - Not Found
429 - Too Many Requests
appId
- (required)provisioningConnectionRequest
- (required)activate
- (optional)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic <T> T updateDefaultProvisioningConnectionForApplication(Class<?> T, String appId, ProvisioningConnectionRequest provisioningConnectionRequest, Boolean activate) throws org.springframework.web.client.RestClientException
201 - Created
400 - Bad Request
403 - Forbidden
404 - Not Found
429 - Too Many Requests
T
- (required) - the assignable return typeappId
- (required)provisioningConnectionRequest
- (required)activate
- (optional)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic PagedList updateDefaultProvisioningConnectionForApplicationWithPaginationInfo(String appId, ProvisioningConnectionRequest provisioningConnectionRequest, Boolean activate) throws org.springframework.web.client.RestClientException
201 - Created
400 - Bad Request
403 - Forbidden
404 - Not Found
429 - Too Many Requests
appId
- (required)provisioningConnectionRequest
- (required)activate
- (optional)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic ApplicationFeature updateFeatureForApplication(String appId, String name, CapabilitiesObject capabilitiesObject) throws org.springframework.web.client.RestClientException
200 - Success
400 - Bad Request
403 - Forbidden
404 - Not Found
429 - Too Many Requests
appId
- (required)name
- (required)capabilitiesObject
- (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic <T> T updateFeatureForApplication(Class<?> T, String appId, String name, CapabilitiesObject capabilitiesObject) throws org.springframework.web.client.RestClientException
200 - Success
400 - Bad Request
403 - Forbidden
404 - Not Found
429 - Too Many Requests
T
- (required) - the assignable return typeappId
- (required)name
- (required)capabilitiesObject
- (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic PagedList updateFeatureForApplicationWithPaginationInfo(String appId, String name, CapabilitiesObject capabilitiesObject) throws org.springframework.web.client.RestClientException
200 - Success
400 - Bad Request
403 - Forbidden
404 - Not Found
429 - Too Many Requests
appId
- (required)name
- (required)capabilitiesObject
- (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic void uploadApplicationLogo(String appId, File _file) throws org.springframework.web.client.RestClientException
201 - Created
400 - Bad Request
403 - Forbidden
404 - Not Found
429 - Too Many Requests
appId
- (required)_file
- (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APICopyright © 2017–2023 Okta. All rights reserved.