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

async function callAuthValidateAccessToken(client: LoginRadius) {
  const access_token: string = '<access_token>'; //Optional

  try {
    const res = await client.<service>.authValidateAccessToken({ access_token });
    console.log(res.data);
  } catch (err) {
    if (err instanceof LoginRadiusError) {
      console.error(err.description);
    } else {
      throw err;
    }
  }
}

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

async function callGetAccessTokenInfo(client: LoginRadius) {
  try {
    const res = await client.<service>.getAccessTokenInfo();
    console.log(res.data);
  } catch (err) {
    if (err instanceof LoginRadiusError) {
      console.error(err.description);
    } else {
      throw err;
    }
  }
}

Returns

AccessTokenInfo

---

invalidateAccessToken

GET /identity/v2/auth/access_token/invalidate

Invalidate Access Token

Invalidates an active Access Token, expiring its validity.

Example

async function callInvalidateAccessToken(client: LoginRadius) {
  const preventRefresh: string = '<preventRefresh>'; //Optional

  try {
    const res = await client.<service>.invalidateAccessToken({ preventRefresh });
    console.log(res.data);
  } catch (err) {
    if (err instanceof LoginRadiusError) {
      console.error(err.description);
    } else {
      throw err;
    }
  }
}

Parameters

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

Returns

IsPostedResponse