Package com.okta.sdk.resource.api

Class UserSessionsApi

java.lang.Object

com.okta.sdk.resource.api.UserSessionsApi

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

Constructor Summary

Constructors

Constructor	Description
UserSessionsApi()
UserSessionsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
void	endUserSessions(KeepCurrent keepCurrent)	End a current User session Ends Okta sessions for the currently signed in User.
void	endUserSessions(KeepCurrent keepCurrent, Map<String,String> additionalHeaders)	End a current User session Ends Okta sessions for the currently signed in User.
ApiClient	getApiClient()
protected static com.fasterxml.jackson.databind.ObjectMapper	getObjectMapper()
void	revokeUserSessions(String userId, Boolean oauthTokens)	Revoke all User sessions Revokes all active Identity Provider sessions of the User.
void	revokeUserSessions(String userId, Boolean oauthTokens, Map<String,String> additionalHeaders)	Revoke all User sessions Revokes all active Identity Provider sessions of the User.
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Details

UserSessionsApi

public UserSessionsApi()

UserSessionsApi

public UserSessionsApi(ApiClient apiClient)

Method Details

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

endUserSessions

public void endUserSessions(KeepCurrent keepCurrent)
                     throws ApiException

End a current User session Ends Okta sessions for the currently signed in User. By default, the current session remains active. Use this method in a browser-based app. > **Note:** This operation requires a session cookie for the User. The API token isn't allowed for this operation.

Parameters:

keepCurrent - (optional)

Throws:

ApiException - if fails to make API call

endUserSessions

public void endUserSessions(KeepCurrent keepCurrent,
 Map<String,String> additionalHeaders)
                     throws ApiException

End a current User session Ends Okta sessions for the currently signed in User. By default, the current session remains active. Use this method in a browser-based app. > **Note:** This operation requires a session cookie for the User. The API token isn't allowed for this operation.

Parameters:

keepCurrent - (optional)

additionalHeaders - additionalHeaders for this call

Throws:

ApiException - if fails to make API call

revokeUserSessions

public void revokeUserSessions(String userId,
 Boolean oauthTokens)
                        throws ApiException

Revoke all User sessions Revokes all active Identity Provider sessions of the User. This forces the user to authenticate on the next operation. Optionally revokes OpenID Connect and OAuth refresh and access tokens issued to the User. > **Note:** This operation doesn't clear the sessions created for web or native apps.

Parameters:

userId - ID of an existing Okta user (required)

oauthTokens - Revoke issued OpenID Connect and OAuth refresh and access tokens (optional, default to false)

Throws:

ApiException - if fails to make API call

revokeUserSessions

public void revokeUserSessions(String userId,
 Boolean oauthTokens,
 Map<String,String> additionalHeaders)
                        throws ApiException

Revoke all User sessions Revokes all active Identity Provider sessions of the User. This forces the user to authenticate on the next operation. Optionally revokes OpenID Connect and OAuth refresh and access tokens issued to the User. > **Note:** This operation doesn't clear the sessions created for web or native apps.

Parameters:

userId - ID of an existing Okta user (required)

oauthTokens - Revoke issued OpenID Connect and OAuth refresh and access tokens (optional, default to false)

additionalHeaders - additionalHeaders for this call

Throws:

ApiException - if fails to make API call

getObjectMapper

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