title

language_tabs

language_clients

toc_footers

includes

search

highlight_theme

headingLevel

Authentication Service v1.0.0

javascript
JavaScript

javascript--nodejs
Node.JS

javascript
request

javascript--nodejs

false

darkula

2

Authentication Service v1.0.0

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

services

Base URLs:

/

Authentication

HTTP Authentication, scheme: bearer

AppleLoginController

AppleLoginController.appleCallback

Code samples

const headers = {
  'Accept':'application/json'
};

fetch('/auth/apple-oauth-redirect',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json'
};

fetch('/auth/apple-oauth-redirect',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /auth/apple-oauth-redirect

Parameters

Name	In	Type	Required	Description
code	query	string	false	none
state	query	string	false	none

Example responses

200 Response

{
  "accessToken": "string",
  "refreshToken": "string",
  "expires": 0,
  "pubnubToken": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Apple Redirect Token Response	TokenResponse

This operation does not require authentication

AppleLoginController.postLoginViaApple

Code samples

const inputBody = '{
  "client_id": "string",
  "client_secret": "string"
}';
const headers = {
  'Content-Type':'application/x-www-form-urlencoded'
};

fetch('/auth/oauth-apple',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');
const inputBody = {
  "client_id": "string",
  "client_secret": "string"
};
const headers = {
  'Content-Type':'application/x-www-form-urlencoded'
};

fetch('/auth/oauth-apple',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /auth/oauth-apple

Body parameter

client_id: string
client_secret: string

Parameters

Name	In	Type	Required	Description
body	body	ClientAuthRequest	false	none

Example responses

Responses

Status	Meaning	Description	Schema
200	OK	POST Call for Apple based login	None

Response Schema

This operation does not require authentication

LoginController

LoginController.resetPassword

Code samples

const inputBody = '{
  "refreshToken": "string",
  "username": "string",
  "password": "string",
  "oldPassword": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Authorization':'string'
};

fetch('/auth/change-password',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');
const inputBody = {
  "refreshToken": "string",
  "username": "string",
  "password": "string",
  "oldPassword": "string"
};
const headers = {
  'Content-Type':'application/json',
  'Authorization':'string'
};

fetch('/auth/change-password',
{
  method: 'PATCH',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PATCH /auth/change-password

Body parameter

{
  "refreshToken": "string",
  "username": "string",
  "password": "string",
  "oldPassword": "string"
}

Parameters

Name	In	Type	Required	Description
Authorization	header	string	false	none
body	body	ResetPasswordPartial	false	none

Responses

Status	Meaning	Description	Schema
200	OK	If User password successfully changed.	None

To perform this operation, you must be authenticated by means of one of the following methods: HTTPBearer

LoginController.login

Code samples

const inputBody = '{
  "client_id": "string",
  "client_secret": "string",
  "username": "string",
  "password": "string"
}';
const headers = {
  'Content-Type':'application/json'
};

fetch('/auth/login',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');
const inputBody = {
  "client_id": "string",
  "client_secret": "string",
  "username": "string",
  "password": "string"
};
const headers = {
  'Content-Type':'application/json'
};

fetch('/auth/login',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /auth/login

Gets you the code that will be used for getting token (webapps)

Body parameter

{
  "client_id": "string",
  "client_secret": "string",
  "username": "string",
  "password": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	LoginRequest	false	none

Example responses

Responses

Status	Meaning	Description	Schema
200	OK	Auth Code that you can use to generate access and refresh tokens using the POST /auth/token API	None
400	Bad Request	The syntax of the request entity is incorrect.	None
401	Unauthorized	Invalid Credentials.	None
404	Not Found	The entity requested does not exist.	None
422	Unprocessable Entity	The syntax of the request entity is incorrect	None

Response Schema

This operation does not require authentication

LoginController.loginWithClientUser

Code samples

const inputBody = '{
  "client_id": "string",
  "client_secret": "string",
  "username": "string",
  "password": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'device_id':'string'
};

fetch('/auth/login-token',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');
const inputBody = {
  "client_id": "string",
  "client_secret": "string",
  "username": "string",
  "password": "string"
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'device_id':'string'
};

fetch('/auth/login-token',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /auth/login-token

Gets you refresh token and access token in one hit. (mobile app)

Body parameter

{
  "client_id": "string",
  "client_secret": "string",
  "username": "string",
  "password": "string"
}

Parameters

Name	In	Type	Required	Description
device_id	header	string	false	none
body	body	LoginRequest	false	none

Example responses

200 Response

{
  "accessToken": "string",
  "refreshToken": "string",
  "expires": 0,
  "pubnubToken": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Token Response Model	TokenResponse
400	Bad Request	The syntax of the request entity is incorrect.	None
401	Unauthorized	Invalid Credentials.	None
404	Not Found	The entity requested does not exist.	None
422	Unprocessable Entity	The syntax of the request entity is incorrect	None

This operation does not require authentication

LoginController.me

Code samples

const headers = {
  'Authorization':'Bearer {access-token}'
};

fetch('/auth/me',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');

const headers = {
  'Authorization':'Bearer {access-token}'
};

fetch('/auth/me',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /auth/me

To get the user details

Example responses

Responses

Status	Meaning	Description	Schema
200	OK	User Object	None
400	Bad Request	The syntax of the request entity is incorrect.	None
401	Unauthorized	Invalid Credentials.	None
404	Not Found	The entity requested does not exist.	None
422	Unprocessable Entity	The syntax of the request entity is incorrect	None

Response Schema

To perform this operation, you must be authenticated by means of one of the following methods: HTTPBearer

LoginController.getToken

Code samples

const inputBody = '{
  "code": "string",
  "clientId": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'device_id':'string'
};

fetch('/auth/token',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');
const inputBody = {
  "code": "string",
  "clientId": "string"
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'device_id':'string'
};

fetch('/auth/token',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /auth/token

Send the code received from the POST /auth/login api and get refresh token and access token (webapps)

Body parameter

{
  "code": "string",
  "clientId": "string"
}

Parameters

Name	In	Type	Required	Description
device_id	header	string	false	none
body	body	AuthTokenRequest	false	none

Example responses

200 Response

{
  "accessToken": "string",
  "refreshToken": "string",
  "expires": 0,
  "pubnubToken": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Token Response	TokenResponse
400	Bad Request	The syntax of the request entity is incorrect.	None
401	Unauthorized	Invalid Credentials.	None
404	Not Found	The entity requested does not exist.	None
422	Unprocessable Entity	The syntax of the request entity is incorrect	None

This operation does not require authentication

LoginController.exchangeToken

Code samples

const inputBody = '{
  "refreshToken": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'device_id':'string',
  'Authorization':'string'
};

fetch('/auth/token-refresh',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');
const inputBody = {
  "refreshToken": "string"
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'device_id':'string',
  'Authorization':'string'
};

fetch('/auth/token-refresh',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /auth/token-refresh

Gets you a new access and refresh token once your access token is expired. (both mobile and web)

Body parameter

{
  "refreshToken": "string"
}

Parameters

Name	In	Type	Required	Description
device_id	header	string	false	none
Authorization	header	string	false	none
body	body	AuthRefreshTokenRequest	false	none

Example responses

200 Response

{
  "accessToken": "string",
  "refreshToken": "string",
  "expires": 0,
  "pubnubToken": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	New Token Response	TokenResponse
400	Bad Request	The syntax of the request entity is incorrect.	None
401	Unauthorized	Invalid Credentials.	None
404	Not Found	The entity requested does not exist.	None
422	Unprocessable Entity	The syntax of the request entity is incorrect	None

To perform this operation, you must be authenticated by means of one of the following methods: HTTPBearer

FacebookLoginController

FacebookLoginController.postLoginViaFacebook

Code samples

const inputBody = '{
  "client_id": "string",
  "client_secret": "string"
}';
const headers = {
  'Content-Type':'application/x-www-form-urlencoded',
  'Accept':'application/json'
};

fetch('/auth/facebook',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');
const inputBody = {
  "client_id": "string",
  "client_secret": "string"
};
const headers = {
  'Content-Type':'application/x-www-form-urlencoded',
  'Accept':'application/json'
};

fetch('/auth/facebook',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /auth/facebook

Body parameter

client_id: string
client_secret: string

Parameters

Name	In	Type	Required	Description
body	body	ClientAuthRequest	false	none

Example responses

200 Response

{
  "accessToken": "string",
  "refreshToken": "string",
  "expires": 0,
  "pubnubToken": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	POST Call for Facebook based login	TokenResponse

This operation does not require authentication

FacebookLoginController.facebookCallback

Code samples

const headers = {
  'Accept':'application/json'
};

fetch('/auth/facebook-auth-redirect',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json'
};

fetch('/auth/facebook-auth-redirect',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /auth/facebook-auth-redirect

Parameters

Name	In	Type	Required	Description
code	query	string	false	none
state	query	string	false	none

Example responses

200 Response

{
  "accessToken": "string",
  "refreshToken": "string",
  "expires": 0,
  "pubnubToken": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Facebook Redirect Token Response	TokenResponse

This operation does not require authentication

ForgetPasswordController

ForgetPasswordController.forgetPassword

Code samples

const inputBody = '{
  "username": "string",
  "client_id": "string",
  "client_secret": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/auth/forget-password',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');
const inputBody = {
  "username": "string",
  "client_id": "string",
  "client_secret": "string"
};
const headers = {
  'Content-Type':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/auth/forget-password',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /auth/forget-password

Body parameter

{
  "username": "string",
  "client_id": "string",
  "client_secret": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	ForgetPasswordDto	false	none

Responses

Status	Meaning	Description	Schema
204	No Content	Success Response.	None
400	Bad Request	The syntax of the request entity is incorrect.	None
401	Unauthorized	Invalid Credentials.	None
404	Not Found	The entity requested does not exist.	None
422	Unprocessable Entity	The syntax of the request entity is incorrect	None

To perform this operation, you must be authenticated by means of one of the following methods: HTTPBearer

ForgetPasswordController.resetPassword

Code samples

const inputBody = '{
  "token": "string",
  "password": "string",
  "client_id": "string",
  "client_secret": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/auth/reset-password',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');
const inputBody = {
  "token": "string",
  "password": "string",
  "client_id": "string",
  "client_secret": "string"
};
const headers = {
  'Content-Type':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/auth/reset-password',
{
  method: 'PATCH',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PATCH /auth/reset-password

Body parameter

{
  "token": "string",
  "password": "string",
  "client_id": "string",
  "client_secret": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	ResetPasswordWithClient	false	none

Responses

Status	Meaning	Description	Schema
204	No Content	If User password successfully changed.	None

To perform this operation, you must be authenticated by means of one of the following methods: HTTPBearer

ForgetPasswordController.verifyResetPasswordLink

Code samples

fetch('/auth/verify-reset-password-link?token=string',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');

fetch('/auth/verify-reset-password-link?token=string',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /auth/verify-reset-password-link

Parameters

Name	In	Type	Required	Description
token	query	string	true	none

Responses

Status	Meaning	Description	Schema
200	OK	Check if Token Is Valid and not Expired.	None

This operation does not require authentication

GoogleLoginController

GoogleLoginController.postLoginViaGoogle

Code samples

const inputBody = '{
  "client_id": "string",
  "client_secret": "string"
}';
const headers = {
  'Content-Type':'application/x-www-form-urlencoded',
  'Accept':'application/json'
};

fetch('/auth/google',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');
const inputBody = {
  "client_id": "string",
  "client_secret": "string"
};
const headers = {
  'Content-Type':'application/x-www-form-urlencoded',
  'Accept':'application/json'
};

fetch('/auth/google',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /auth/google

Body parameter

client_id: string
client_secret: string

Parameters

Name	In	Type	Required	Description
body	body	ClientAuthRequest	false	none

Example responses

200 Response

{
  "accessToken": "string",
  "refreshToken": "string",
  "expires": 0,
  "pubnubToken": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	POST Call for Google based login	TokenResponse

This operation does not require authentication

GoogleLoginController.loginViaGoogle

Code samples

const headers = {
  'Accept':'application/json'
};

fetch('/auth/google',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json'
};

fetch('/auth/google',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /auth/google

Parameters

Name	In	Type	Required	Description
client_id	query	string	false	none
client_secret	query	string	false	none

Example responses

200 Response

{
  "accessToken": "string",
  "refreshToken": "string",
  "expires": 0,
  "pubnubToken": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Google Token Response (Deprecated: Possible security issue if secret is passed via query params, please use the post endpoint)	TokenResponse

This operation does not require authentication

GoogleLoginController.googleCallback

Code samples

const headers = {
  'Accept':'application/json'
};

fetch('/auth/google-auth-redirect',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json'
};

fetch('/auth/google-auth-redirect',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /auth/google-auth-redirect

Parameters

Name	In	Type	Required	Description
code	query	string	false	none
state	query	string	false	none

Example responses

200 Response

{
  "accessToken": "string",
  "refreshToken": "string",
  "expires": 0,
  "pubnubToken": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Google Redirect Token Response	TokenResponse

This operation does not require authentication

InstagramLoginController

InstagramLoginController.postLoginViaInstagram

Code samples

const inputBody = '{
  "client_id": "string",
  "client_secret": "string"
}';
const headers = {
  'Content-Type':'application/x-www-form-urlencoded',
  'Accept':'application/json'
};

fetch('/auth/instagram',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');
const inputBody = {
  "client_id": "string",
  "client_secret": "string"
};
const headers = {
  'Content-Type':'application/x-www-form-urlencoded',
  'Accept':'application/json'
};

fetch('/auth/instagram',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /auth/instagram

Body parameter

client_id: string
client_secret: string

Parameters

Name	In	Type	Required	Description
body	body	ClientAuthRequest	false	none

Example responses

200 Response

{
  "accessToken": "string",
  "refreshToken": "string",
  "expires": 0,
  "pubnubToken": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	POST Call for Instagram based login	TokenResponse

This operation does not require authentication

InstagramLoginController.instagramCallback

Code samples

const headers = {
  'Accept':'application/json'
};

fetch('/auth/instagram-auth-redirect',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json'
};

fetch('/auth/instagram-auth-redirect',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /auth/instagram-auth-redirect

Parameters

Name	In	Type	Required	Description
code	query	string	false	none
state	query	string	false	none

Example responses

200 Response

{
  "accessToken": "string",
  "refreshToken": "string",
  "expires": 0,
  "pubnubToken": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Instagram Redirect Token Response	TokenResponse

This operation does not require authentication

KeycloakLoginController

KeycloakLoginController.postLoginViaKeycloak

Code samples

const inputBody = '{
  "client_id": "string",
  "client_secret": "string"
}';
const headers = {
  'Content-Type':'application/x-www-form-urlencoded',
  'Accept':'application/json'
};

fetch('/auth/keycloak',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');
const inputBody = {
  "client_id": "string",
  "client_secret": "string"
};
const headers = {
  'Content-Type':'application/x-www-form-urlencoded',
  'Accept':'application/json'
};

fetch('/auth/keycloak',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /auth/keycloak

POST Call for keycloak based login

Body parameter

client_id: string
client_secret: string

Parameters

Name	In	Type	Required	Description
body	body	ClientAuthRequest	false	none

Example responses

200 Response

{
  "accessToken": "string",
  "refreshToken": "string",
  "expires": 0,
  "pubnubToken": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Keycloak Token Response	TokenResponse

This operation does not require authentication

KeycloakLoginController.loginViaKeycloak

Code samples

const headers = {
  'Accept':'application/json'
};

fetch('/auth/keycloak',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json'
};

fetch('/auth/keycloak',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /auth/keycloak

Parameters

Name	In	Type	Required	Description
client_id	query	string	false	none
client_secret	query	string	false	none

Example responses

200 Response

{
  "accessToken": "string",
  "refreshToken": "string",
  "expires": 0,
  "pubnubToken": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Keycloak Token Response (Deprecated: Possible security issue if secret is passed via query params, please use the post endpoint)	TokenResponse

This operation does not require authentication

KeycloakLoginController.keycloakCallback

Code samples

const headers = {
  'Accept':'application/json'
};

fetch('/auth/keycloak-auth-redirect',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json'
};

fetch('/auth/keycloak-auth-redirect',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /auth/keycloak-auth-redirect

Parameters

Name	In	Type	Required	Description
code	query	string	false	none
state	query	string	false	none

Example responses

200 Response

{
  "accessToken": "string",
  "refreshToken": "string",
  "expires": 0,
  "pubnubToken": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Keycloak Redirect Token Response	TokenResponse

This operation does not require authentication

SignupRequestController

SignupRequestController.requestSignup

Code samples

const inputBody = '{
  "email": "string",
  "data": {}
}';
const headers = {
  'Content-Type':'application/json'
};

fetch('/auth/sign-up/create-token',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');
const inputBody = {
  "email": "string",
  "data": {}
};
const headers = {
  'Content-Type':'application/json'
};

fetch('/auth/sign-up/create-token',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /auth/sign-up/create-token

Body parameter

{
  "email": "string",
  "data": {}
}

Parameters

Name	In	Type	Required	Description
body	body	SignupRequestDto	false	none

Responses

Status	Meaning	Description	Schema
204	No Content	Sucess Response.	None
400	Bad Request	The syntax of the request entity is incorrect.	None
401	Unauthorized	Invalid Credentials.	None
404	Not Found	The entity requested does not exist.	None
422	Unprocessable Entity	The syntax of the request entity is incorrect	None

This operation does not require authentication

SignupRequestController.signupWithToken

Code samples

const inputBody = '{
  "email": "string",
  "password": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/auth/sign-up/create-user',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');
const inputBody = {
  "email": "string",
  "password": "string"
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/auth/sign-up/create-user',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /auth/sign-up/create-user

Body parameter

{
  "email": "string",
  "password": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	LocalUserProfileDto	false	none

Example responses

200 Response

{
  "email": "string",
  "password": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Sucess Response.	LocalUserProfileDto
400	Bad Request	The syntax of the request entity is incorrect.	None
401	Unauthorized	Invalid Credentials.	None
404	Not Found	The entity requested does not exist.	None
422	Unprocessable Entity	The syntax of the request entity is incorrect	None

To perform this operation, you must be authenticated by means of one of the following methods: HTTPBearer

SignupRequestController.verifyInviteToken

Code samples

const headers = {
  'Authorization':'Bearer {access-token}'
};

fetch('/auth/sign-up/verify-token',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');

const headers = {
  'Authorization':'Bearer {access-token}'
};

fetch('/auth/sign-up/verify-token',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /auth/sign-up/verify-token

Responses

Status	Meaning	Description	Schema
200	OK	Sucess Response.	None
400	Bad Request	The syntax of the request entity is incorrect.	None
401	Unauthorized	Invalid Credentials.	None
404	Not Found	The entity requested does not exist.	None
422	Unprocessable Entity	The syntax of the request entity is incorrect	None

To perform this operation, you must be authenticated by means of one of the following methods: HTTPBearer

AuthClientController

AuthClientController.count

Code samples

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/auth-clients/count',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/auth-clients/count',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /auth-clients/count

Permissions
NotAllowed

Parameters

Name	In	Type	Required	Description
where	query	object	false	none

Example responses

200 Response

{
  "count": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	AuthClient model count	loopback.Count

To perform this operation, you must be authenticated by means of one of the following methods: HTTPBearer

AuthClientController.replaceById

Code samples

const inputBody = '{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "id": 0,
  "clientId": "string",
  "clientSecret": "string",
  "secret": "string",
  "redirectUrl": "string",
  "accessTokenExpiration": 0,
  "refreshTokenExpiration": 0,
  "authCodeExpiration": 0
}';
const headers = {
  'Content-Type':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/auth-clients/{id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');
const inputBody = {
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "id": 0,
  "clientId": "string",
  "clientSecret": "string",
  "secret": "string",
  "redirectUrl": "string",
  "accessTokenExpiration": 0,
  "refreshTokenExpiration": 0,
  "authCodeExpiration": 0
};
const headers = {
  'Content-Type':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/auth-clients/{id}',
{
  method: 'PUT',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PUT /auth-clients/{id}

Permissions
NotAllowed

Body parameter

{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "id": 0,
  "clientId": "string",
  "clientSecret": "string",
  "secret": "string",
  "redirectUrl": "string",
  "accessTokenExpiration": 0,
  "refreshTokenExpiration": 0,
  "authCodeExpiration": 0
}

Parameters

Name	In	Type	Required	Description
id	path	number	true	none
body	body	AuthClient	false	none

Responses

Status	Meaning	Description	Schema
204	No Content	AuthClient PUT success	None

To perform this operation, you must be authenticated by means of one of the following methods: HTTPBearer

AuthClientController.updateById

Code samples

const inputBody = '{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "id": 0,
  "clientId": "string",
  "clientSecret": "string",
  "secret": "string",
  "redirectUrl": "string",
  "accessTokenExpiration": 0,
  "refreshTokenExpiration": 0,
  "authCodeExpiration": 0
}';
const headers = {
  'Content-Type':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/auth-clients/{id}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');
const inputBody = {
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "id": 0,
  "clientId": "string",
  "clientSecret": "string",
  "secret": "string",
  "redirectUrl": "string",
  "accessTokenExpiration": 0,
  "refreshTokenExpiration": 0,
  "authCodeExpiration": 0
};
const headers = {
  'Content-Type':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/auth-clients/{id}',
{
  method: 'PATCH',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PATCH /auth-clients/{id}

Permissions
NotAllowed

Body parameter

{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "id": 0,
  "clientId": "string",
  "clientSecret": "string",
  "secret": "string",
  "redirectUrl": "string",
  "accessTokenExpiration": 0,
  "refreshTokenExpiration": 0,
  "authCodeExpiration": 0
}

Parameters

Name	In	Type	Required	Description
id	path	number	true	none
body	body	AuthClientPartial	false	none

Responses

Status	Meaning	Description	Schema
204	No Content	AuthClient PATCH success	None

To perform this operation, you must be authenticated by means of one of the following methods: HTTPBearer

AuthClientController.findById

Code samples

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/auth-clients/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/auth-clients/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /auth-clients/{id}

Permissions
NotAllowed

Parameters

Name	In	Type	Required	Description
id	path	number	true	none

Example responses

200 Response

{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "id": 0,
  "clientId": "string",
  "clientSecret": "string",
  "secret": "string",
  "redirectUrl": "string",
  "accessTokenExpiration": 0,
  "refreshTokenExpiration": 0,
  "authCodeExpiration": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	AuthClient model instance	AuthClient

To perform this operation, you must be authenticated by means of one of the following methods: HTTPBearer

AuthClientController.deleteById

Code samples

const headers = {
  'Authorization':'Bearer {access-token}'
};

fetch('/auth-clients/{id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');

const headers = {
  'Authorization':'Bearer {access-token}'
};

fetch('/auth-clients/{id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

DELETE /auth-clients/{id}

Permissions
NotAllowed

Parameters

Name	In	Type	Required	Description
id	path	number	true	none

Responses

Status	Meaning	Description	Schema
204	No Content	AuthClient DELETE success	None

To perform this operation, you must be authenticated by means of one of the following methods: HTTPBearer

AuthClientController.create

Code samples

const inputBody = '{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "clientSecret": "string",
  "secret": "string",
  "redirectUrl": "string",
  "accessTokenExpiration": 0,
  "refreshTokenExpiration": 0,
  "authCodeExpiration": 0
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/auth-clients',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');
const inputBody = {
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "clientSecret": "string",
  "secret": "string",
  "redirectUrl": "string",
  "accessTokenExpiration": 0,
  "refreshTokenExpiration": 0,
  "authCodeExpiration": 0
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/auth-clients',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /auth-clients

Permissions
NotAllowed

Body parameter

{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "clientSecret": "string",
  "secret": "string",
  "redirectUrl": "string",
  "accessTokenExpiration": 0,
  "refreshTokenExpiration": 0,
  "authCodeExpiration": 0
}

Parameters

Name	In	Type	Required	Description
body	body	AuthClientExcluding_id_	false	none

Example responses

200 Response

{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "id": 0,
  "clientId": "string",
  "clientSecret": "string",
  "secret": "string",
  "redirectUrl": "string",
  "accessTokenExpiration": 0,
  "refreshTokenExpiration": 0,
  "authCodeExpiration": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	AuthClient model instance	AuthClient

To perform this operation, you must be authenticated by means of one of the following methods: HTTPBearer

AuthClientController.updateAll

Code samples

const inputBody = '{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "id": 0,
  "clientId": "string",
  "clientSecret": "string",
  "secret": "string",
  "redirectUrl": "string",
  "accessTokenExpiration": 0,
  "refreshTokenExpiration": 0,
  "authCodeExpiration": 0
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/auth-clients',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');
const inputBody = {
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "id": 0,
  "clientId": "string",
  "clientSecret": "string",
  "secret": "string",
  "redirectUrl": "string",
  "accessTokenExpiration": 0,
  "refreshTokenExpiration": 0,
  "authCodeExpiration": 0
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/auth-clients',
{
  method: 'PATCH',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PATCH /auth-clients

Permissions
NotAllowed

Body parameter

{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "id": 0,
  "clientId": "string",
  "clientSecret": "string",
  "secret": "string",
  "redirectUrl": "string",
  "accessTokenExpiration": 0,
  "refreshTokenExpiration": 0,
  "authCodeExpiration": 0
}

Parameters

Name	In	Type	Required	Description
where	query	object	false	none
body	body	AuthClientPartial	false	none

Example responses

200 Response

{
  "count": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	AuthClient PATCH success count	loopback.Count

To perform this operation, you must be authenticated by means of one of the following methods: HTTPBearer

AuthClientController.find

Code samples

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/auth-clients',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/auth-clients',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /auth-clients

Permissions
NotAllowed

Parameters

Name	In	Type	Required	Description
filter	query	auth_clients.Filter	false	none

Example responses

200 Response

[
  {
    "deleted": true,
    "deletedOn": "2019-08-24T14:15:22Z",
    "deletedBy": "string",
    "createdOn": "2019-08-24T14:15:22Z",
    "modifiedOn": "2019-08-24T14:15:22Z",
    "id": 0,
    "clientId": "string",
    "clientSecret": "string",
    "secret": "string",
    "redirectUrl": "string",
    "accessTokenExpiration": 0,
    "refreshTokenExpiration": 0,
    "authCodeExpiration": 0
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	Array of AuthClient model instances	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[AuthClient]	false	none	none
» AuthClient	AuthClient	false	none	none
»» deleted	boolean	false	none	none
»» deletedOn	string(date-time)¦null	false	none	none
»» deletedBy	string¦null	false	none	none
»» createdOn	string(date-time)	false	none	none
»» modifiedOn	string(date-time)	false	none	none
»» id	number	false	none	none
»» clientId	string	true	none	none
»» clientSecret	string	true	none	none
»» secret	string	true	none	none
»» redirectUrl	string	false	none	none
»» accessTokenExpiration	number	true	none	none
»» refreshTokenExpiration	number	true	none	none
»» authCodeExpiration	number	true	none	none

To perform this operation, you must be authenticated by means of one of the following methods: HTTPBearer

LogoutController

LogoutController.keycloakLogout

Code samples

const inputBody = '{
  "refreshToken": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'string'
};

fetch('/keycloak/logout',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');
const inputBody = {
  "refreshToken": "string"
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'string'
};

fetch('/keycloak/logout',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /keycloak/logout

This API will log out the user from application as well as keycloak

Body parameter

{
  "refreshToken": "string"
}

Parameters

Name	In	Type	Required	Description
Authorization	header	string	false	This is the access token which is required to authenticate user.
body	body	RefreshTokenRequestPartial	false	none

Example responses

200 Response

{
  "success": true
}

Responses

Status	Meaning	Description	Schema
200	OK	Success Response	SuccessResponse
400	Bad Request	The syntax of the request entity is incorrect.	None
401	Unauthorized	Invalid Credentials.	None
404	Not Found	The entity requested does not exist.	None
422	Unprocessable Entity	The syntax of the request entity is incorrect	None

To perform this operation, you must be authenticated by means of one of the following methods: HTTPBearer

LogoutController.logout

Code samples

const inputBody = '{
  "refreshToken": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'string'
};

fetch('/logout',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');
const inputBody = {
  "refreshToken": "string"
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'string'
};

fetch('/logout',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /logout

To logout

Body parameter

{
  "refreshToken": "string"
}

Parameters

Name	In	Type	Required	Description
Authorization	header	string	false	This is the access token which is required to authenticate user.
body	body	RefreshTokenRequestPartial	false	none

Example responses

200 Response

{
  "success": true
}

Responses

Status	Meaning	Description	Schema
200	OK	Success Response	SuccessResponse
400	Bad Request	The syntax of the request entity is incorrect.	None
401	Unauthorized	Invalid Credentials.	None
404	Not Found	The entity requested does not exist.	None
422	Unprocessable Entity	The syntax of the request entity is incorrect	None

To perform this operation, you must be authenticated by means of one of the following methods: HTTPBearer

OtpController

OtpController.findById

Code samples

const headers = {
  'Accept':'application/json'
};

fetch('/otp-caches/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json'
};

fetch('/otp-caches/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /otp-caches/{id}

Parameters

Name	In	Type	Required	Description
id	path	string	true	none

Example responses

200 Response

{
  "otp": "string",
  "username": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Otp model instance	Otp

This operation does not require authentication

OtpController.deleteById

Code samples

fetch('/otp-caches/{id}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');

fetch('/otp-caches/{id}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

DELETE /otp-caches/{id}

Parameters

Name	In	Type	Required	Description
id	path	string	true	none

Responses

Status	Meaning	Description	Schema
204	No Content	Otp DELETE success	None

This operation does not require authentication

OtpController.create

Code samples

const inputBody = '{
  "otp": "string",
  "username": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/otp-caches',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');
const inputBody = {
  "otp": "string",
  "username": "string"
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/otp-caches',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /otp-caches

Body parameter

{
  "otp": "string",
  "username": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	Otp	false	none

Example responses

200 Response

{
  "otp": "string",
  "username": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Otp model instance	Otp

This operation does not require authentication

Schemas

LoginRequest

{
  "client_id": "string",
  "client_secret": "string",
  "username": "string",
  "password": "string"
}

LoginRequest

Properties

Name	Type	Required	Restrictions	Description
client_id	string	true	none	This property is supposed to be a string and is a required field
client_secret	string	true	none	This property is supposed to be a string and is a required field
username	string	true	none	This property is supposed to be a string and is a required field
password	string	true	none	This property is supposed to be a string and is a required field

TokenResponse

{
  "accessToken": "string",
  "refreshToken": "string",
  "expires": 0,
  "pubnubToken": "string"
}

TokenResponse

Properties

Name	Type	Required	Restrictions	Description
accessToken	string	true	none	This property is supposed to be a string and is a required field
refreshToken	string	true	none	This property is supposed to be a string and is a required field
expires	number	true	none	none
pubnubToken	string	false	none	none

AuthTokenRequest

{
  "code": "string",
  "clientId": "string"
}

AuthTokenRequest

Properties

Name	Type	Required	Restrictions	Description
code	string	true	none	none
clientId	string	true	none	none

Function

null

Properties

None

AuthRefreshTokenRequest

{
  "refreshToken": "string"
}

AuthRefreshTokenRequest

Properties

Name	Type	Required	Restrictions	Description
refreshToken	string	true	none	none

ResetPasswordPartial

{
  "refreshToken": "string",
  "username": "string",
  "password": "string",
  "oldPassword": "string"
}

ResetPasswordPartial

Properties

Name	Type	Required	Restrictions	Description
refreshToken	string	false	none	none
username	string	false	none	This property is supposed to be a string and is a required field
password	string	false	none	This property is supposed to be a string and is a required field
oldPassword	string	false	none	This property is supposed to be a string and is a required field

ResetPassword

{
  "refreshToken": "string",
  "username": "string",
  "password": "string",
  "oldPassword": "string"
}

ResetPassword

Properties

Name	Type	Required	Restrictions	Description
refreshToken	string	true	none	none
username	string	true	none	This property is supposed to be a string and is a required field
password	string	true	none	This property is supposed to be a string and is a required field
oldPassword	string	false	none	This property is supposed to be a string and is a required field

ClientAuthRequest

{
  "client_id": "string",
  "client_secret": "string"
}

ClientAuthRequest

Properties

Name	Type	Required	Restrictions	Description
client_id	string	true	none	This property is supposed to be a string and is a required field
client_secret	string	true	none	This property is supposed to be a string and is a required field

SuccessResponse

{
  "success": true
}

SuccessResponse

Properties

Name	Type	Required	Restrictions	Description
success	boolean	false	none	none

RefreshTokenRequestPartial

{
  "refreshToken": "string"
}

RefreshTokenRequestPartial

Properties

Name	Type	Required	Restrictions	Description
refreshToken	string	false	none	none

RefreshTokenRequest

{
  "refreshToken": "string"
}

RefreshTokenRequest

Properties

Name	Type	Required	Restrictions	Description
refreshToken	string	true	none	none

Otp

{
  "otp": "string",
  "username": "string"
}

Otp

Properties

Name	Type	Required	Restrictions	Description
otp	string	true	none	none
username	string	true	none	none

AuthClient

{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "id": 0,
  "clientId": "string",
  "clientSecret": "string",
  "secret": "string",
  "redirectUrl": "string",
  "accessTokenExpiration": 0,
  "refreshTokenExpiration": 0,
  "authCodeExpiration": 0
}

AuthClient

Properties

Name	Type	Required	Restrictions	Description
deleted	boolean	false	none	none
deletedOn	string(date-time)¦null	false	none	none
deletedBy	string¦null	false	none	none
createdOn	string(date-time)	false	none	none
modifiedOn	string(date-time)	false	none	none
id	number	false	none	none
clientId	string	true	none	none
clientSecret	string	true	none	none
secret	string	true	none	none
redirectUrl	string	false	none	none
accessTokenExpiration	number	true	none	none
refreshTokenExpiration	number	true	none	none
authCodeExpiration	number	true	none	none

AuthClientExcluding_id_

{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "clientSecret": "string",
  "secret": "string",
  "redirectUrl": "string",
  "accessTokenExpiration": 0,
  "refreshTokenExpiration": 0,
  "authCodeExpiration": 0
}

AuthClientExcluding_id_

Properties

Name	Type	Required	Restrictions	Description
deleted	boolean	false	none	none
deletedOn	string(date-time)¦null	false	none	none
deletedBy	string¦null	false	none	none
createdOn	string(date-time)	false	none	none
modifiedOn	string(date-time)	false	none	none
clientId	string	true	none	none
clientSecret	string	true	none	none
secret	string	true	none	none
redirectUrl	string	false	none	none
accessTokenExpiration	number	true	none	none
refreshTokenExpiration	number	true	none	none
authCodeExpiration	number	true	none	none

AuthClientPartial

{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "id": 0,
  "clientId": "string",
  "clientSecret": "string",
  "secret": "string",
  "redirectUrl": "string",
  "accessTokenExpiration": 0,
  "refreshTokenExpiration": 0,
  "authCodeExpiration": 0
}

AuthClientPartial

Properties

Name	Type	Required	Restrictions	Description
deleted	boolean	false	none	none
deletedOn	string(date-time)¦null	false	none	none
deletedBy	string¦null	false	none	none
createdOn	string(date-time)	false	none	none
modifiedOn	string(date-time)	false	none	none
id	number	false	none	none
clientId	string	false	none	none
clientSecret	string	false	none	none
secret	string	false	none	none
redirectUrl	string	false	none	none
accessTokenExpiration	number	false	none	none
refreshTokenExpiration	number	false	none	none
authCodeExpiration	number	false	none	none

ForgetPasswordDto

{
  "username": "string",
  "client_id": "string",
  "client_secret": "string"
}

ForgetPasswordDto

Properties

Name	Type	Required	Restrictions	Description
username	string	true	none	none
client_id	string	true	none	none
client_secret	string	true	none	none

ResetPasswordWithClient

{
  "token": "string",
  "password": "string",
  "client_id": "string",
  "client_secret": "string"
}

ResetPasswordWithClient

Properties

Name	Type	Required	Restrictions	Description
token	string	true	none	none
password	string	true	none	none
client_id	string	true	none	none
client_secret	string	true	none	none

SignupRequestDto

{
  "email": "string",
  "data": {}
}

SignupRequestDto

Properties

Name	Type	Required	Restrictions	Description
email	string	true	none	none
data	object	false	none	none

LocalUserProfileDto

{
  "email": "string",
  "password": "string"
}

LocalUserProfileDto

Properties

Name	Type	Required	Restrictions	Description
email	string	true	none	none
password	string	true	none	none

SignupRequest

{
  "email": "string",
  "expiry": "string"
}

SignupRequest

Properties

Name	Type	Required	Restrictions	Description
email	string	true	none	none
expiry	string	false	none	none

loopback.Count

{
  "count": 0
}

loopback.Count

Properties

Name	Type	Required	Restrictions	Description
count	number	false	none	none

auth_clients.Filter

{
  "offset": 0,
  "limit": 100,
  "skip": 0,
  "order": "string",
  "where": {},
  "fields": {
    "deleted": true,
    "deletedOn": true,
    "deletedBy": true,
    "createdOn": true,
    "modifiedOn": true,
    "id": true,
    "clientId": true,
    "clientSecret": true,
    "secret": true,
    "redirectUrl": true,
    "accessTokenExpiration": true,
    "refreshTokenExpiration": true,
    "authCodeExpiration": true
  }
}

auth_clients.Filter

Properties

Name	Type	Required	Restrictions	Description
offset	integer	false	none	none
limit	integer	false	none	none
skip	integer	false	none	none
order	any	false	none	none

oneOf

Name	Type	Required	Restrictions	Description
» anonymous	string	false	none	none

xor

Name	Type	Required	Restrictions	Description
» anonymous	[string]	false	none	none

continued

Name	Type	Required	Restrictions	Description
where	object	false	none	none
fields	any	false	none	none

oneOf

Name	Type	Required	Restrictions	Description
» anonymous	object	false	none	none
»» deleted	boolean	false	none	none
»» deletedOn	boolean	false	none	none
»» deletedBy	boolean	false	none	none
»» createdOn	boolean	false	none	none
»» modifiedOn	boolean	false	none	none
»» id	boolean	false	none	none
»» clientId	boolean	false	none	none
»» clientSecret	boolean	false	none	none
»» secret	boolean	false	none	none
»» redirectUrl	boolean	false	none	none
»» accessTokenExpiration	boolean	false	none	none
»» refreshTokenExpiration	boolean	false	none	none
»» authCodeExpiration	boolean	false	none	none

xor

Name	Type	Required	Restrictions	Description
» anonymous	[string]	false	none	none

Files

openapi.md

Latest commit

History

openapi.md

File metadata and controls

Authentication Service v1.0.0

Authentication

AppleLoginController

AppleLoginController.appleCallback

Parameters

Responses

AppleLoginController.postLoginViaApple

Parameters

Responses

Response Schema

LoginController

LoginController.resetPassword

Parameters

Responses

LoginController.login

Parameters

Responses

Response Schema

LoginController.loginWithClientUser

Parameters

Responses

LoginController.me

Responses

Response Schema

LoginController.getToken

Parameters

Responses

LoginController.exchangeToken

Parameters

Responses

FacebookLoginController

FacebookLoginController.postLoginViaFacebook

Parameters

Responses

FacebookLoginController.facebookCallback

Parameters

Responses

ForgetPasswordController

ForgetPasswordController.forgetPassword

Parameters

Responses

ForgetPasswordController.resetPassword

Parameters

Responses

ForgetPasswordController.verifyResetPasswordLink

Parameters

Responses

GoogleLoginController

GoogleLoginController.postLoginViaGoogle

Parameters

Responses

GoogleLoginController.loginViaGoogle

Parameters

Responses

GoogleLoginController.googleCallback

Parameters

Responses

InstagramLoginController

InstagramLoginController.postLoginViaInstagram

Parameters

Responses

InstagramLoginController.instagramCallback

Parameters

Responses

KeycloakLoginController

KeycloakLoginController.postLoginViaKeycloak

Parameters

Responses

KeycloakLoginController.loginViaKeycloak

Parameters

Responses

KeycloakLoginController.keycloakCallback

Parameters

Responses