Package com.okta.sdk.resource.api
Class ServiceAccountApi
java.lang.Object
com.okta.sdk.resource.api.ServiceAccountApi
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
date="2026-03-13T17:36:05.533634+05:30[Asia/Kolkata]",
comments="Generator version: 7.15.0")
public class ServiceAccountApi
extends Object
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionCreate an app service account Creates a new app service account for managing an app accountcreateAppServiceAccount(AppServiceAccount body, Map<String, String> additionalHeaders) Create an app service account Creates a new app service account for managing an app accountvoidDelete an app service account Deletes an app service account specified by IDvoiddeleteAppServiceAccount(String id, Map<String, String> additionalHeaders) Delete an app service account Deletes an app service account specified by IDRetrieve an app service account Retrieves an app service account specified by IDgetAppServiceAccount(String id, Map<String, String> additionalHeaders) Retrieve an app service account Retrieves an app service account specified by IDprotected static com.fasterxml.jackson.databind.ObjectMapperlistAppServiceAccounts(Integer limit, String after, String match) List all app service accounts Lists all app service accountslistAppServiceAccounts(Integer limit, String after, String match, Map<String, String> additionalHeaders) List all app service accounts Lists all app service accountslistAppServiceAccountsPaged(Integer limit, String after, String match) List all app service accounts (Paginated) Lists all app service accounts This method returns a lazy, paginated iterable that automatically handles pagination.listAppServiceAccountsPaged(Integer limit, String after, String match, Map<String, String> additionalHeaders) List all app service accounts (Paginated with additional headers) Lists all app service accounts This method returns a lazy, paginated iterable that automatically handles pagination.voidsetApiClient(ApiClient apiClient) Update an existing app service account Updates an existing app service account specified by IDupdateAppServiceAccount(String id, AppServiceAccountForUpdate body, Map<String, String> additionalHeaders) Update an existing app service account Updates an existing app service account specified by ID
-
Constructor Details
-
ServiceAccountApi
public ServiceAccountApi() -
ServiceAccountApi
-
-
Method Details
-
getApiClient
-
setApiClient
-
createAppServiceAccount
Create an app service account Creates a new app service account for managing an app account- Parameters:
body- (required)- Returns:
- AppServiceAccount
- Throws:
ApiException- if fails to make API call
-
createAppServiceAccount
public AppServiceAccount createAppServiceAccount(AppServiceAccount body, Map<String, String> additionalHeaders) throws ApiExceptionCreate an app service account Creates a new app service account for managing an app account- Parameters:
body- (required)additionalHeaders- additionalHeaders for this call- Returns:
- AppServiceAccount
- Throws:
ApiException- if fails to make API call
-
deleteAppServiceAccount
Delete an app service account Deletes an app service account specified by ID- Parameters:
id- ID of an existing service account (required)- Throws:
ApiException- if fails to make API call
-
deleteAppServiceAccount
public void deleteAppServiceAccount(String id, Map<String, String> additionalHeaders) throws ApiExceptionDelete an app service account Deletes an app service account specified by ID- Parameters:
id- ID of an existing service account (required)additionalHeaders- additionalHeaders for this call- Throws:
ApiException- if fails to make API call
-
getAppServiceAccount
Retrieve an app service account Retrieves an app service account specified by ID- Parameters:
id- ID of an existing service account (required)- Returns:
- AppServiceAccount
- Throws:
ApiException- if fails to make API call
-
getAppServiceAccount
public AppServiceAccount getAppServiceAccount(String id, Map<String, String> additionalHeaders) throws ApiExceptionRetrieve an app service account Retrieves an app service account specified by ID- Parameters:
id- ID of an existing service account (required)additionalHeaders- additionalHeaders for this call- Returns:
- AppServiceAccount
- Throws:
ApiException- if fails to make API call
-
listAppServiceAccounts
public List<AppServiceAccount> listAppServiceAccounts(Integer limit, String after, String match) throws ApiException List all app service accounts Lists all app service accounts- Parameters:
limit- A limit on the number of objects to return (optional, default to 20)after- The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the `Link` response header. See [Pagination](https://developer.okta.com/docs/api/#pagination) and [Link header](https://developer.okta.com/docs/api/#link-header). (optional)match- Searches for app service accounts where the account name (`name`), username (`username`), app instance label (`containerInstanceName`), or OIN app key name (`containerGlobalName`) contains the given value (optional)- Returns:
- List<AppServiceAccount>
- Throws:
ApiException- if fails to make API call
-
listAppServiceAccounts
public List<AppServiceAccount> listAppServiceAccounts(Integer limit, String after, String match, Map<String, String> additionalHeaders) throws ApiExceptionList all app service accounts Lists all app service accounts- Parameters:
limit- A limit on the number of objects to return (optional, default to 20)after- The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the `Link` response header. See [Pagination](https://developer.okta.com/docs/api/#pagination) and [Link header](https://developer.okta.com/docs/api/#link-header). (optional)match- Searches for app service accounts where the account name (`name`), username (`username`), app instance label (`containerInstanceName`), or OIN app key name (`containerGlobalName`) contains the given value (optional)additionalHeaders- additionalHeaders for this call- Returns:
- List<AppServiceAccount>
- Throws:
ApiException- if fails to make API call
-
listAppServiceAccountsPaged
public Iterable<AppServiceAccount> listAppServiceAccountsPaged(Integer limit, String after, String match) List all app service accounts (Paginated) Lists all app service accounts This method returns a lazy, paginated iterable that automatically handles pagination. It is thread-safe and does not cause memory leaks. Use this method in a for-each loop to automatically fetch all pages without manual cursor management.- Parameters:
limit- A limit on the number of objects to return (optional, default to 20)after- The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the `Link` response header. See [Pagination](https://developer.okta.com/docs/api/#pagination) and [Link header](https://developer.okta.com/docs/api/#link-header). (optional)match- Searches for app service accounts where the account name (`name`), username (`username`), app instance label (`containerInstanceName`), or OIN app key name (`containerGlobalName`) contains the given value (optional)- Returns:
- Iterable<AppServiceAccount> lazy iterable over all pages
-
listAppServiceAccountsPaged
public Iterable<AppServiceAccount> listAppServiceAccountsPaged(Integer limit, String after, String match, Map<String, String> additionalHeaders) List all app service accounts (Paginated with additional headers) Lists all app service accounts This method returns a lazy, paginated iterable that automatically handles pagination. It is thread-safe and does not cause memory leaks.- Parameters:
limit- A limit on the number of objects to return (optional, default to 20)after- The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the `Link` response header. See [Pagination](https://developer.okta.com/docs/api/#pagination) and [Link header](https://developer.okta.com/docs/api/#link-header). (optional)match- Searches for app service accounts where the account name (`name`), username (`username`), app instance label (`containerInstanceName`), or OIN app key name (`containerGlobalName`) contains the given value (optional)additionalHeaders- additional headers for this call- Returns:
- Iterable<AppServiceAccount> lazy iterable over all pages
-
updateAppServiceAccount
public AppServiceAccount updateAppServiceAccount(String id, AppServiceAccountForUpdate body) throws ApiException Update an existing app service account Updates an existing app service account specified by ID- Parameters:
id- ID of an existing service account (required)body- (optional)- Returns:
- AppServiceAccount
- Throws:
ApiException- if fails to make API call
-
updateAppServiceAccount
public AppServiceAccount updateAppServiceAccount(String id, AppServiceAccountForUpdate body, Map<String, String> additionalHeaders) throws ApiExceptionUpdate an existing app service account Updates an existing app service account specified by ID- Parameters:
id- ID of an existing service account (required)body- (optional)additionalHeaders- additionalHeaders for this call- Returns:
- AppServiceAccount
- Throws:
ApiException- if fails to make API call
-
getObjectMapper
protected static com.fasterxml.jackson.databind.ObjectMapper getObjectMapper()
-