Class AuthorizationServerClientsApi

java.lang.Object
com.okta.sdk.resource.api.AuthorizationServerClientsApi

@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 AuthorizationServerClientsApi extends Object
  • Constructor Details

    • AuthorizationServerClientsApi

      public AuthorizationServerClientsApi()
    • AuthorizationServerClientsApi

      public AuthorizationServerClientsApi(ApiClient apiClient)
  • Method Details

    • getApiClient

      public ApiClient getApiClient()
    • setApiClient

      public void setApiClient(ApiClient apiClient)
    • getRefreshTokenForAuthorizationServerAndClient

      public OAuth2RefreshToken getRefreshTokenForAuthorizationServerAndClient(String authServerId, String clientId, String tokenId, String expand) throws ApiException
      Retrieve a refresh token for a client Retrieves a refresh token for a Client
      Parameters:
      authServerId - `id` of the Authorization Server (required)
      clientId - `client_id` of the app (required)
      tokenId - `id` of Token (required)
      expand - Valid value: `scope`. If specified, scope details are included in the `_embedded` attribute. (optional)
      Returns:
      OAuth2RefreshToken
      Throws:
      ApiException - if fails to make API call
    • getRefreshTokenForAuthorizationServerAndClient

      public OAuth2RefreshToken getRefreshTokenForAuthorizationServerAndClient(String authServerId, String clientId, String tokenId, String expand, Map<String,String> additionalHeaders) throws ApiException
      Retrieve a refresh token for a client Retrieves a refresh token for a Client
      Parameters:
      authServerId - `id` of the Authorization Server (required)
      clientId - `client_id` of the app (required)
      tokenId - `id` of Token (required)
      expand - Valid value: `scope`. If specified, scope details are included in the `_embedded` attribute. (optional)
      additionalHeaders - additionalHeaders for this call
      Returns:
      OAuth2RefreshToken
      Throws:
      ApiException - if fails to make API call
    • listOAuth2ClientsForAuthorizationServer

      public List<OAuth2Client> listOAuth2ClientsForAuthorizationServer(String authServerId) throws ApiException
      List all client resources for an authorization server Lists all client resources for which the specified authorization server has tokens. > **Note:** To list a specific user's client resources for which they have tokens or grants, use the [List all clients endpoint in the User Resources API](/openapi/okta-management/management/tag/UserResources/#tag/UserResources/operation/listUserClients).
      Parameters:
      authServerId - `id` of the Authorization Server (required)
      Returns:
      List<OAuth2Client>
      Throws:
      ApiException - if fails to make API call
    • listOAuth2ClientsForAuthorizationServer

      public List<OAuth2Client> listOAuth2ClientsForAuthorizationServer(String authServerId, Map<String,String> additionalHeaders) throws ApiException
      List all client resources for an authorization server Lists all client resources for which the specified authorization server has tokens. > **Note:** To list a specific user's client resources for which they have tokens or grants, use the [List all clients endpoint in the User Resources API](/openapi/okta-management/management/tag/UserResources/#tag/UserResources/operation/listUserClients).
      Parameters:
      authServerId - `id` of the Authorization Server (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      List<OAuth2Client>
      Throws:
      ApiException - if fails to make API call
    • listOAuth2ClientsForAuthorizationServerPaged

      public Iterable<OAuth2Client> listOAuth2ClientsForAuthorizationServerPaged(String authServerId)
      List all client resources for an authorization server (Paginated) Lists all client resources for which the specified authorization server has tokens. > **Note:** To list a specific user's client resources for which they have tokens or grants, use the [List all clients endpoint in the User Resources API](/openapi/okta-management/management/tag/UserResources/#tag/UserResources/operation/listUserClients). 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:
      authServerId - `id` of the Authorization Server (required)
      Returns:
      Iterable<OAuth2Client> lazy iterable over all pages
    • listOAuth2ClientsForAuthorizationServerPaged

      public Iterable<OAuth2Client> listOAuth2ClientsForAuthorizationServerPaged(String authServerId, Map<String,String> additionalHeaders)
      List all client resources for an authorization server (Paginated with additional headers) Lists all client resources for which the specified authorization server has tokens. > **Note:** To list a specific user's client resources for which they have tokens or grants, use the [List all clients endpoint in the User Resources API](/openapi/okta-management/management/tag/UserResources/#tag/UserResources/operation/listUserClients). This method returns a lazy, paginated iterable that automatically handles pagination. It is thread-safe and does not cause memory leaks.
      Parameters:
      authServerId - `id` of the Authorization Server (required)
      additionalHeaders - additional headers for this call
      Returns:
      Iterable<OAuth2Client> lazy iterable over all pages
    • listRefreshTokensForAuthorizationServerAndClient

      public List<OAuth2RefreshToken> listRefreshTokensForAuthorizationServerAndClient(String authServerId, String clientId, String expand, String after, Integer limit) throws ApiException
      List all refresh tokens for a client Lists all refresh tokens issued by an authorization server for a specific Client
      Parameters:
      authServerId - `id` of the Authorization Server (required)
      clientId - `client_id` of the app (required)
      expand - Valid value: `scope`. If specified, scope details are included in the `_embedded` attribute. (optional)
      after - Specifies the pagination cursor for the next page of tokens (optional)
      limit - The maximum number of tokens to return (maximum 200) (optional, default to -1)
      Returns:
      List<OAuth2RefreshToken>
      Throws:
      ApiException - if fails to make API call
    • listRefreshTokensForAuthorizationServerAndClient

      public List<OAuth2RefreshToken> listRefreshTokensForAuthorizationServerAndClient(String authServerId, String clientId, String expand, String after, Integer limit, Map<String,String> additionalHeaders) throws ApiException
      List all refresh tokens for a client Lists all refresh tokens issued by an authorization server for a specific Client
      Parameters:
      authServerId - `id` of the Authorization Server (required)
      clientId - `client_id` of the app (required)
      expand - Valid value: `scope`. If specified, scope details are included in the `_embedded` attribute. (optional)
      after - Specifies the pagination cursor for the next page of tokens (optional)
      limit - The maximum number of tokens to return (maximum 200) (optional, default to -1)
      additionalHeaders - additionalHeaders for this call
      Returns:
      List<OAuth2RefreshToken>
      Throws:
      ApiException - if fails to make API call
    • listRefreshTokensForAuthorizationServerAndClientPaged

      public Iterable<OAuth2RefreshToken> listRefreshTokensForAuthorizationServerAndClientPaged(String authServerId, String clientId, String expand, String after, Integer limit)
      List all refresh tokens for a client (Paginated) Lists all refresh tokens issued by an authorization server for a specific Client 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:
      authServerId - `id` of the Authorization Server (required)
      clientId - `client_id` of the app (required)
      expand - Valid value: `scope`. If specified, scope details are included in the `_embedded` attribute. (optional)
      after - Specifies the pagination cursor for the next page of tokens (optional)
      limit - The maximum number of tokens to return (maximum 200) (optional, default to -1)
      Returns:
      Iterable<OAuth2RefreshToken> lazy iterable over all pages
    • listRefreshTokensForAuthorizationServerAndClientPaged

      public Iterable<OAuth2RefreshToken> listRefreshTokensForAuthorizationServerAndClientPaged(String authServerId, String clientId, String expand, String after, Integer limit, Map<String,String> additionalHeaders)
      List all refresh tokens for a client (Paginated with additional headers) Lists all refresh tokens issued by an authorization server for a specific Client This method returns a lazy, paginated iterable that automatically handles pagination. It is thread-safe and does not cause memory leaks.
      Parameters:
      authServerId - `id` of the Authorization Server (required)
      clientId - `client_id` of the app (required)
      expand - Valid value: `scope`. If specified, scope details are included in the `_embedded` attribute. (optional)
      after - Specifies the pagination cursor for the next page of tokens (optional)
      limit - The maximum number of tokens to return (maximum 200) (optional, default to -1)
      additionalHeaders - additional headers for this call
      Returns:
      Iterable<OAuth2RefreshToken> lazy iterable over all pages
    • revokeRefreshTokenForAuthorizationServerAndClient

      public void revokeRefreshTokenForAuthorizationServerAndClient(String authServerId, String clientId, String tokenId) throws ApiException
      Revoke a refresh token for a client Revokes a refresh token for a Client
      Parameters:
      authServerId - `id` of the Authorization Server (required)
      clientId - `client_id` of the app (required)
      tokenId - `id` of Token (required)
      Throws:
      ApiException - if fails to make API call
    • revokeRefreshTokenForAuthorizationServerAndClient

      public void revokeRefreshTokenForAuthorizationServerAndClient(String authServerId, String clientId, String tokenId, Map<String,String> additionalHeaders) throws ApiException
      Revoke a refresh token for a client Revokes a refresh token for a Client
      Parameters:
      authServerId - `id` of the Authorization Server (required)
      clientId - `client_id` of the app (required)
      tokenId - `id` of Token (required)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call
    • revokeRefreshTokensForAuthorizationServerAndClient

      public void revokeRefreshTokensForAuthorizationServerAndClient(String authServerId, String clientId) throws ApiException
      Revoke all refresh tokens for a client Revokes all refresh tokens for a Client
      Parameters:
      authServerId - `id` of the Authorization Server (required)
      clientId - `client_id` of the app (required)
      Throws:
      ApiException - if fails to make API call
    • revokeRefreshTokensForAuthorizationServerAndClient

      public void revokeRefreshTokensForAuthorizationServerAndClient(String authServerId, String clientId, Map<String,String> additionalHeaders) throws ApiException
      Revoke all refresh tokens for a client Revokes all refresh tokens for a Client
      Parameters:
      authServerId - `id` of the Authorization Server (required)
      clientId - `client_id` of the app (required)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call
    • getObjectMapper

      protected static com.fasterxml.jackson.databind.ObjectMapper getObjectMapper()