Skip to content

AuthenticationEndpoint

AuthenticationEndpoint contains methods that facilitate authenticating with the Kick application to access privledged routes.

Methods

async getTokens()

Retrieves tokens required for the login flow.

Returns

Promise<TokensResponse>


async login(credentials)

Attempts authentication with Kick.

ParameterTypeRequiredDefaultDescription
credentialsLoginCredentialstrueThe credentials for the account that is authenticating

Returns

Promise<void>


Authentication Required async currentUser()

Retrieves details of the currently logged-in user if authenticated.

Returns

Promise<UserResponse>