Login

Authenticate and obtain a session: email/password, SSO (Apple, Google, Microsoft, OpenID), login tokens, and resume.

Endpoints

Endpoint	Arguments	Returns
v3.login	username: string, password: string	string
v3.loginApple	idToken: string	string
v3.loginGoogle	idToken: string	string
v3.loginMicrosoft	idToken: string	string
v3.loginOpenId	idToken: string	string
v3.loginToken	loginToken: string	string
v3.resume	sessionId: string	string

v3.login

Description

Returns sessionId which, can be used as header hlrkey: <sessionId> or as cookie hlrkey: <sessionId>, or to connect a socket.io connection using the resume command

Parameters

Argument 1 (string, required): username

Argument 2 (string, required): password

Example

const { Client } = require('@hailer/cli');

const client = await Client.create({
  host: 'https://api.hailer.com',
  username: 'you@example.com',
  password: '••••••',
});

const result = await client.request('v3.login', [
  'string', // username (required)
  'string', // password (required)
]);
console.log(result);

Returns

string

Auth: callable without authentication.

Errors: on failure returns the standard Hailer error object { code, msg, details?, debug? }.

v3.loginApple

Description

Login with Apple SSO. Returns sessionId which, can be used as header hlrkey: <sessionId> or as cookie hlrkey: <sessionId>, or to connect a socket.io connection using the resume command

Parameters

Argument 1 (string, required): idToken

Example

const { Client } = require('@hailer/cli');

const client = await Client.create({
  host: 'https://api.hailer.com',
  username: 'you@example.com',
  password: '••••••',
});

const result = await client.request('v3.loginApple', [
  'string', // idToken (required)
]);
console.log(result);

Returns

string

Auth: callable without authentication.

Errors: on failure returns the standard Hailer error object { code, msg, details?, debug? }.

v3.loginGoogle

Description

Login with Google SSO. Returns sessionId which, can be used as header hlrkey: <sessionId> or as cookie hlrkey: <sessionId>, or to connect a socket.io connection using the resume command

Parameters

Argument 1 (string, required): idToken

Example

const { Client } = require('@hailer/cli');

const client = await Client.create({
  host: 'https://api.hailer.com',
  username: 'you@example.com',
  password: '••••••',
});

const result = await client.request('v3.loginGoogle', [
  'string', // idToken (required)
]);
console.log(result);

Returns

string

Auth: callable without authentication.

Errors: on failure returns the standard Hailer error object { code, msg, details?, debug? }.

v3.loginMicrosoft

Description

Login with OIDC. Returns sessionId which, can be used as header hlrkey: <sessionId> or as cookie hlrkey: <sessionId>, or to connect a socket.io connection using the resume command

Parameters

Argument 1 (string, required): idToken

Example

const { Client } = require('@hailer/cli');

const client = await Client.create({
  host: 'https://api.hailer.com',
  username: 'you@example.com',
  password: '••••••',
});

const result = await client.request('v3.loginMicrosoft', [
  'string', // idToken (required)
]);
console.log(result);

Returns

string

Auth: callable without authentication.

Errors: on failure returns the standard Hailer error object { code, msg, details?, debug? }.

v3.loginOpenId

Description

Login with OIDC. Returns sessionId which, can be used as header hlrkey: <sessionId> or as cookie hlrkey: <sessionId>, or to connect a socket.io connection using the resume command

Parameters

Argument 1 (string, required): idToken

Example

const { Client } = require('@hailer/cli');

const client = await Client.create({
  host: 'https://api.hailer.com',
  username: 'you@example.com',
  password: '••••••',
});

const result = await client.request('v3.loginOpenId', [
  'string', // idToken (required)
]);
console.log(result);

Returns

string

Auth: callable without authentication.

Errors: on failure returns the standard Hailer error object { code, msg, details?, debug? }.

v3.loginToken

Description

Undocumented

This endpoint has no description in the source yet.

Parameters

Argument 1 (string, required): loginToken

Example

const { Client } = require('@hailer/cli');

const client = await Client.create({
  host: 'https://api.hailer.com',
  username: 'you@example.com',
  password: '••••••',
});

const result = await client.request('v3.loginToken', [
  'string', // loginToken (required)
]);
console.log(result);

Returns

string

Auth: callable without authentication.

Errors: on failure returns the standard Hailer error object { code, msg, details?, debug? }.

v3.resume

Description

Resume session - Used for resuming session with socket connection.

Parameters

Argument 1 (string, required):

Example

const { Client } = require('@hailer/cli');

const client = await Client.create({
  host: 'https://api.hailer.com',
  username: 'you@example.com',
  password: '••••••',
});

const result = await client.request('v3.resume', [
  'string', // argument 1 (required)
]);
console.log(result);

Returns

string

Auth: callable without authentication.

Errors: on failure returns the standard Hailer error object { code, msg, details?, debug? }.