session.md

Session

3 operation(s). Part of the API index.

Call these as client.<service>.<method>(...). <service> is the client field for this group — the README lists the field name for every service. These pages group operations the way the OpenAPI specification tags them, which is not always one field per page.

---

authValidateAccessToken

GET /identity/v2/auth/access_token/validate

Validate Access Token

Validates an Access Token, returning its expiry if valid, or an error if invalid.

Example

public static void callAuthValidateAccessToken(LoginRadiusClient client) {
  String accessToken = "<accessToken>"; //Optional

  try {
    var response = client.session.authValidateAccessToken(accessToken);
    System.out.println(response);
  } catch (ApiException e) {
    LoginRadiusException lr = LoginRadiusClient.toLoginRadiusException(e);
    System.err.println(lr.description());
  }
}

Parameters

Name	In	Type	Required	Description
access_token	query	string	no	Access Token of the User

Returns

AccessTokenResponse

---

getAccessTokenInfo

GET /identity/v2/auth/access_token

Retrieve Access Token information

Obtains detailed information about the provided Access Token.

Example

public static void callGetAccessTokenInfo(LoginRadiusClient client) {
  try {
    var response = client.session.getAccessTokenInfo();
    System.out.println(response);
  } catch (ApiException e) {
    LoginRadiusException lr = LoginRadiusClient.toLoginRadiusException(e);
    System.err.println(lr.description());
  }
}

Returns

AccessTokenInfo

---

invalidateAccessToken

GET /identity/v2/auth/access_token/invalidate

Invalidate Access Token

Invalidates an active Access Token, expiring its validity.

Example

public static void callInvalidateAccessToken(LoginRadiusClient client) {
  Boolean preventRefresh = true; //Optional

  try {
    var response = client.session.invalidateAccessToken(preventRefresh);
    System.out.println(response);
  } catch (ApiException e) {
    LoginRadiusException lr = LoginRadiusClient.toLoginRadiusException(e);
    System.err.println(lr.description());
  }
}

Parameters

Name	In	Type	Required	Description
preventRefresh	query	boolean	no	Whether to prevent the token from being refreshed (true/false).

Returns

IsPostedResponse