Package com.okta.sdk.resource.api

Class UserOAuthApi

java.lang.Object

com.okta.sdk.resource.api.UserOAuthApi

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2024-09-23T16:19:57.008753975Z[Etc/UTC]",
           comments="Generator version: 7.8.0")
public class UserOAuthApi
extends Object

Constructor Summary

Constructors

Constructor	Description
UserOAuthApi()
UserOAuthApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
ApiClient	getApiClient()
protected static com.fasterxml.jackson.databind.ObjectMapper	getObjectMapper()
OAuth2RefreshToken	getRefreshTokenForUserAndClient(String userId, String clientId, String tokenId, String expand)	Retrieve a Refresh Token for a Client Retrieves a refresh Token issued for the specified User and client
OAuth2RefreshToken	getRefreshTokenForUserAndClient(String userId, String clientId, String tokenId, String expand, Map<String,String> additionalHeaders)	Retrieve a Refresh Token for a Client Retrieves a refresh Token issued for the specified User and client
List<OAuth2RefreshToken>	listRefreshTokensForUserAndClient(String userId, String clientId, String expand, String after, Integer limit)	List all Refresh Tokens for a Client Lists all refresh Tokens issued for the specified User and client
List<OAuth2RefreshToken>	listRefreshTokensForUserAndClient(String userId, String clientId, String expand, String after, Integer limit, Map<String,String> additionalHeaders)	List all Refresh Tokens for a Client Lists all refresh Tokens issued for the specified User and client
void	revokeTokenForUserAndClient(String userId, String clientId, String tokenId)	Revoke a Token for a Client Revokes the specified refresh Token
void	revokeTokenForUserAndClient(String userId, String clientId, String tokenId, Map<String,String> additionalHeaders)	Revoke a Token for a Client Revokes the specified refresh Token
void	revokeTokensForUserAndClient(String userId, String clientId)	Revoke all Refresh Tokens for a Client Revokes all refresh Tokens issued for the specified User and client
void	revokeTokensForUserAndClient(String userId, String clientId, Map<String,String> additionalHeaders)	Revoke all Refresh Tokens for a Client Revokes all refresh Tokens issued for the specified User and client
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

UserOAuthApi

public UserOAuthApi()

UserOAuthApi

public UserOAuthApi(ApiClient apiClient)

Method Details

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getRefreshTokenForUserAndClient

public OAuth2RefreshToken getRefreshTokenForUserAndClient(String userId,
 String clientId,
 String tokenId,
 String expand)
                                                   throws ApiException

Retrieve a Refresh Token for a Client Retrieves a refresh Token issued for the specified User and client

Parameters:

userId - ID of an existing Okta user (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

getRefreshTokenForUserAndClient

public OAuth2RefreshToken getRefreshTokenForUserAndClient(String userId,
 String clientId,
 String tokenId,
 String expand,
 Map<String,String> additionalHeaders)
                                                   throws ApiException

Retrieve a Refresh Token for a Client Retrieves a refresh Token issued for the specified User and client

Parameters:

userId - ID of an existing Okta user (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

listRefreshTokensForUserAndClient

public List<OAuth2RefreshToken> listRefreshTokensForUserAndClient(String userId,
 String clientId,
 String expand,
 String after,
 Integer limit)
                                                           throws ApiException

List all Refresh Tokens for a Client Lists all refresh Tokens issued for the specified User and client

Parameters:

userId - ID of an existing Okta user (required)

clientId - `client_id` of the app (required)

expand - Valid value: `scope`. If specified, scope details are included in the `_embedded` attribute. (optional)

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). (optional)

limit - Specifies the number of tokens to return (optional, default to 20)

Returns:

List<OAuth2RefreshToken>

Throws:

ApiException - if fails to make API call

listRefreshTokensForUserAndClient

public List<OAuth2RefreshToken> listRefreshTokensForUserAndClient(String userId,
 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 for the specified User and client

Parameters:

userId - ID of an existing Okta user (required)

clientId - `client_id` of the app (required)

expand - Valid value: `scope`. If specified, scope details are included in the `_embedded` attribute. (optional)

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). (optional)

limit - Specifies the number of tokens to return (optional, default to 20)

additionalHeaders - additionalHeaders for this call

Returns:

List<OAuth2RefreshToken>

Throws:

ApiException - if fails to make API call

revokeTokenForUserAndClient

public void revokeTokenForUserAndClient(String userId,
 String clientId,
 String tokenId)
                                 throws ApiException

Revoke a Token for a Client Revokes the specified refresh Token

Parameters:

userId - ID of an existing Okta user (required)

clientId - `client_id` of the app (required)

tokenId - `id` of Token (required)

Throws:

ApiException - if fails to make API call

revokeTokenForUserAndClient

public void revokeTokenForUserAndClient(String userId,
 String clientId,
 String tokenId,
 Map<String,String> additionalHeaders)
                                 throws ApiException

Revoke a Token for a Client Revokes the specified refresh Token

Parameters:

userId - ID of an existing Okta user (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

revokeTokensForUserAndClient

public void revokeTokensForUserAndClient(String userId,
 String clientId)
                                  throws ApiException

Revoke all Refresh Tokens for a Client Revokes all refresh Tokens issued for the specified User and client

Parameters:

userId - ID of an existing Okta user (required)

clientId - `client_id` of the app (required)

Throws:

ApiException - if fails to make API call

revokeTokensForUserAndClient

public void revokeTokensForUserAndClient(String userId,
 String clientId,
 Map<String,String> additionalHeaders)
                                  throws ApiException

Revoke all Refresh Tokens for a Client Revokes all refresh Tokens issued for the specified User and client

Parameters:

userId - ID of an existing Okta user (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()