ClientAuthentication

ClientAuthentication

Represents an authentication on SMHW.


Constructor

new ClientAuthentication(response)

Instantiate a ClientAuthentication object.

Parameters:
Name Type Description
response Object

The data for the object.

Members

access_token :String

The access token to make authorised requests.

Type:
  • String

created_at :Number

The timestamp when the authorisation was granted.

Type:
  • Number

expires_in :Number

When the token expires. (in miliseconds)

Type:
  • Number

refresh_token :String

The refresh token to refresh the access token.

Type:
  • String

school_id :Number

The ID of the school which the authenticated user belongs in.

Type:
  • Number

smhw_token :String

The access token to make authorised requests.

Type:
  • String

token_type :String

The type of token granted.

Type:
  • String

user_id :Number

The ID of the user which the authentication grants access to.

Type:
  • Number

user_type :String

The type of user which the authentication grants access to.

Type:
  • String