org.openapitools.client.api

Class SessionApi

java.lang.Object

org.openapitools.client.api.SessionApi

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2023-01-18T04:14:02.238-06:00[America/Chicago]")
 @Component(value="org.openapitools.client.api.SessionApi")
public class SessionApi
extends Object

Constructor Summary

Constructors

Constructor and Description
SessionApi()
SessionApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
<T> T	createSession(Class<?> T, CreateSessionRequest createSessionRequest) Create a Session with Session Token Creates a new session for a user with a valid session token.
Session	createSession(CreateSessionRequest createSessionRequest) Create a Session with Session Token Creates a new session for a user with a valid session token.
PagedList	createSessionWithPaginationInfo(CreateSessionRequest createSessionRequest) Create a Session with Session Token Creates a new session for a user with a valid session token.
ApiClient	getApiClient()
Session	getSession(String sessionId) Retrieve a Session Retrieves the details about a session
PagedList	getSessionWithPaginationInfo(String sessionId) Retrieve a Session Retrieves the details about a session
Session	refreshSession(String sessionId) Refresh a Session Refresh a session
PagedList	refreshSessionWithPaginationInfo(String sessionId) Refresh a Session Refresh a session
void	revokeSession(String sessionId) Revoke a Session Revokes a session
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

SessionApi

public SessionApi()

SessionApi

@Autowired
public SessionApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

createSession

public Session createSession(CreateSessionRequest createSessionRequest)
                      throws org.springframework.web.client.RestClientException

Create a Session with Session Token Creates a new session for a user with a valid session token. Use this API if, for example, you want to set the session cookie yourself instead of allowing Okta to set it, or want to hold the session ID in order to delete a session via the API instead of visiting the logout URL.

200 - Success

400 - Bad Request

403 - Forbidden

429 - Too Many Requests

Parameters:

createSessionRequest - (required)

Returns:

Session

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

createSession

public <T> T createSession(Class<?> T,
                           CreateSessionRequest createSessionRequest)
                    throws org.springframework.web.client.RestClientException

Create a Session with Session Token Creates a new session for a user with a valid session token. Use this API if, for example, you want to set the session cookie yourself instead of allowing Okta to set it, or want to hold the session ID in order to delete a session via the API instead of visiting the logout URL.

200 - Success

400 - Bad Request

403 - Forbidden

429 - Too Many Requests

Parameters:

T - (required) - the assignable return type

createSessionRequest - (required)

Returns:

T instance

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

createSessionWithPaginationInfo

public PagedList createSessionWithPaginationInfo(CreateSessionRequest createSessionRequest)
                                          throws org.springframework.web.client.RestClientException

Create a Session with Session Token Creates a new session for a user with a valid session token. Use this API if, for example, you want to set the session cookie yourself instead of allowing Okta to set it, or want to hold the session ID in order to delete a session via the API instead of visiting the logout URL.

200 - Success

400 - Bad Request

403 - Forbidden

429 - Too Many Requests

Parameters:

createSessionRequest - (required)

Returns:

ResponseEntity<Session>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

getSession

public Session getSession(String sessionId)
                   throws org.springframework.web.client.RestClientException

Retrieve a Session Retrieves the details about a session

200 - Success

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

sessionId - (required)

Returns:

Session

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

getSessionWithPaginationInfo

public PagedList getSessionWithPaginationInfo(String sessionId)
                                       throws org.springframework.web.client.RestClientException

Retrieve a Session Retrieves the details about a session

200 - Success

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

sessionId - (required)

Returns:

ResponseEntity<Session>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

refreshSession

public Session refreshSession(String sessionId)
                       throws org.springframework.web.client.RestClientException

Refresh a Session Refresh a session

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

sessionId - (required)

Returns:

Session

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

refreshSessionWithPaginationInfo

public PagedList refreshSessionWithPaginationInfo(String sessionId)
                                           throws org.springframework.web.client.RestClientException

Refresh a Session Refresh a session

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

sessionId - (required)

Returns:

ResponseEntity<Session>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

revokeSession

public void revokeSession(String sessionId)
                   throws org.springframework.web.client.RestClientException

Revoke a Session Revokes a session

204 - No Content

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

sessionId - (required)

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API