travelling

Travelling

A blazing fast dynamic route level groups/permissions api gateway.

• REST Docs
• Install
  • Minimum New Setup
• Security
• Configuration
• SDK
• Changelog
• License

REST Docs

REST Docs

Install

Minimum New Setup

1. Download the latest release or run git clone https://github.com/phara0h/travelling.git

2. Inside the root Travelling folder run: npm install

3. Set the TRAVELLING_DATABASE_URL environment variable which needs to be pointing to a new PostgreSQL database to start. Do this by creating a .env file inside the root Travelling folder. For example:

   TRAVELLING_DATABASE_URL=postgres://postgres@localhost/travelling
   

4. Set the salts and secrets for the following:

   ## Cookie Session Settings
   TRAVELLING_COOKIE_SESSION_SECRET=Yzy)8EbJOUJf+~e^%#7-lo1)RJUs.UVPBu4d3qqd0ZDQ!A~ti%Sq<kPy)nfVSn0;TRBeD0_QeMxKzp]Yn{hQe4j#ZtQ{L$0O>+hBJl^-%TKX<S>u|~xz;hFS(DO32tw#
   
   ## Cookie Token Settings
   TRAVELLING_COOKIE_TOKEN_SECRET=qVsI_O|Y0VPz>xvW-Uu!&5lejE3M4w-l0KvCI!v4q|9|F0W+v9g-hb!*yX8*3O%Ty@4$~:@1!VX*?Sl&c}KW&a4..gceGHg)KoiVpc9-8bCnrmG&&}iI;7VY+-+&U(?:
   TRAVELLING_COOKIE_TOKEN_SALT=?)WJ.$!570)5[@bDNip!q.t1J#/B.fJ{cyC--Zd/IJwJ/~L+(&#XOz|FuIoc{k;@8wf#gOrn||Ng1+2bDxOuQ6$_6QK{aWUfc-PZ{L62(0JRKizR~Y*/K8YT]?gLHB+S
   
   ## Postgres Crypto Settings
   TRAVELLING_PG_CRYPTO_IMPLEMENTATION_SECRET=:Y@K$;nE8r~D]dR-#%<PyI]/]^v&#lIz7T(OHrI@sAA_Y/+C%bYVfoY5(r#3IN6tC_fn9vpy%CKXh?K0k:<M/[PXs*r2CO~:]!2qBmB,9}RW)8i$$P#uFt_>u,v_M9K}
   TRAVELLING_PG_CRYPTO_IMPLEMENTATION_SALT=Wdwrmww~NxDAFn2/@~1SfV6&Iq7/PR;]k2Me*gK*(|I!sxcr/V,_0Bbys25dIF!sm,}XG)%U!(9|3gS4Hy1Hjo}D.WsF{!6|+x,t{O6T^S):kuglmBokNNqQeHL^bWk%
   

   These are example secrets and salts DO NOT USE THESE VALUES generate your own. You can use the included script via ./scripts/generateRandom.sh to generate a 128 character random string to use for salts and secrets. See Security for more details on keeping Travelling secure.

See Configuration for all other configurable options.

Security

It is recommended to follow this security tips to help keep Travelling as secure as possible.

• Use HTTPS
• Use a key and cert signed by a known third party ssl vender. (Make sure chrome supports them)
• Don’t use Cors unless you really have to.
• Request logs are helpful for tracking down malicious requests
• Run Travelling behind DDOS protection. For example Cloudflare.
• Rotate cookie session/token secrets and salts often. (Once a month is a good recommendation)
• Set username passwords and username’s to OWSAP current recommendations.
• Keep OAuth2 Code Tokens short lived for maximum security.
• Use strong secret’s and salts for Postgres encryption. KEEP THESE SAFE.
• Email authentication helps prevent invalid users and makes it harder for bots to generate accounts.

Configuration

Configuration is done through environment variables. All variables have a default values except for what is stated in Minimum New Setup

• Basic
  • TRAVELLING_PORT
  • TRAVELLING_IP
  • TRAVELLING_KEY
  • TRAVELLING_CERT
  • TRAVELLING_HTTPS
  • TRAVELLING_SERVICE_NAME
• Misc
  • TRAVELLING_MISC_CLOUDFLAREIP
• Cors
  • TRAVELLING_CORS_ENABLE
  • TRAVELLING_CORS_HEADER_ORIGIN
  • TRAVELLING_CORS_HEADER_METHODS
  • TRAVELLING_CORS_HEADER_CREDENTIALS
  • TRAVELLING_CORS_HEADER_MAX_AGE
• Logging
  • TRAVELLING_LOG_ENABLE
  • TRAVELLING_LOG_LOGGER
  • TRAVELLING_LOG_COLORS
  • TRAVELLING_LOG_LEVEL
  • TRAVELLING_LOG_REQUESTS
  • TRAVELLING_LOG_UNAUTHORIZED_ACCESS
• Fastify Logger
  • TRAVELLING_LOG_FASTIFY_LOGGER
  • TRAVELLING_LOG_FASTIFY_LOGGER_REQUEST
  • TRAVELLING_LOG_FASTIFY_LOGGER_REQ_ID_HEADER
  • TRAVELLING_LOG_FASTIFY_LOGGER_REQ_ID_LOG_LABEL
• Portal
  • TRAVELLING_PORTAL_ENABLE
  • TRAVELLING_PORTAL_PATH
  • TRAVELLING_PORTAL_HOST
  • TRAVELLING_PORTAL_FILE_PATH
  • TRAVELLING_PORTAL_LOGO
  • TRAVELLING_PORTAL_STYLES
  • TRAVELLING_PORTAL_ICON
• Proxy
  • TRAVELLING_PROXY_TIMEOUT
  • TRAVELLING_PROXY_SEND_TRAVELLING_HEADERS
• Redis
  • TRAVELLING_REDIS_ENABLE
  • TRAVELLING_REDIS_URL
  • TRAVELLING_REDIS_EVENTS_URL
• Cookie
  • TRAVELLING_COOKIE_SESSION_SECRET
  • TRAVELLING_COOKIE_SESSION_EXPIRATION
  • TRAVELLING_COOKIE_TOKEN_SECRET
  • TRAVELLING_COOKIE_TOKEN_SALT
  • TRAVELLING_COOKIE_TOKEN_EXPIRATION
  • TRAVELLING_COOKIE_TOKEN_CHECKABLE
  • TRAVELLING_COOKIE_DOMAIN
  • TRAVELLING_COOKIE_SECURITY_IP_HIJACK_PROTECTION
• USER
  • TRAVELLING_USER_ISOLATE_BY_DOMAIN
  • TRAVELLING_USER_USERNAME_MINCHAR
  • TRAVELLING_USER_USERNAME_ENABLE
  • TRAVELLING_USER_LOCKED_MESSAGE
• Authentication
  • TRAVELLING_PASSWORD_CONSECUTIVE
  • TRAVELLING_PASSWORD_MINCHAR
  • TRAVELLING_PASSWORD_MAXCHAR
  • TRAVELLING_PASSWORD_SPECIAL
  • TRAVELLING_PASSWORD_NUMBER
  • TRAVELLING_PASSWORD_LOWERCASE
  • TRAVELLING_PASSWORD_UPPERCASE
  • TRAVELLING_LOGIN_MAX_LOGIN_ATTEMPTS
• OAUTH2
  • TRAVELLING_TOKEN_ACCESS_EXPIRATION
  • TRAVELLING_TOKEN_CODE_EXPIRATION
  • TRAVELLING_TOKEN_CODE_AUTHORIZE_FLOW
• Postgres
  • TRAVELLING_DATABASE_URL
  • TRAVELLING_DATABASE_USER
  • TRAVELLING_DATABASE_PASSWORD
  • TRAVELLING_DATABASE_PORT
  • TRAVELLING_DATABASE_NAME
  • TRAVELLING_DATABASE_HOST
  • TRAVELLING_PG_CRYPTO_IMPLEMENTATION
  • TRAVELLING_PG_CRYPTO_IMPLEMENTATION_SECRET
  • TRAVELLING_PG_CRYPTO_IMPLEMENTATION_SALT
  • TRAVELLING_PG_CRYPTO_ENCRYPT_USER_DATA
• Email
  • TRAVELLING_EMAIL_VALIDATION_EXTERNAL_ENABLE
  • TRAVELLING_EMAIL_VALIDATION_EXTERNAL_ENDPOINT
  • TRAVELLING_EMAIL_VALIDATION_EXTERNAL_EMAIL_IN_ENDPOINT
  • TRAVELLING_EMAIL_VALIDATION_EXTERNAL_EMAIL_IN_BODY
  • TRAVELLING_EMAIL_VALIDATION_EXTERNAL_METHOD
  • TRAVELLING_EMAIL_FROM
  • TRAVELLING_EMAIL_RECOVERY_EXPIRATION
  • TRAVELLING_EMAIL_ACTIVATION_EXPIRATION
  • TRAVELLING_EMAIL_TEST_ENABLE
  • TRAVELLING_EMAIL_SMTP_ENABLE
  • TRAVELLING_EMAIL_SMTP_HOST
  • TRAVELLING_EMAIL_SMTP_PORT
  • TRAVELLING_EMAIL_SMTP_SECURE
  • TRAVELLING_EMAIL_SMTP_AUTH_USER
  • TRAVELLING_EMAIL_SMTP_SECURE
  • TRAVELLING_EMAIL_SMTP_TLS_REJECT_UNAUTHORIZED
  • TRAVELLING_EMAIL_AWS_ENABLE
  • TRAVELLING_EMAIL_AWS_CONFIG
  • Templates
    • TRAVELLING_EMAIL_RESET_PASSWORD_TEMPLATE_BODY
    • TRAVELLING_EMAIL_RESET_PASSWORD_TEMPLATE_SUBJECT
    • TRAVELLING_EMAIL_ACTIVATION_TEMPLATE_BODY
    • TRAVELLING_EMAIL_ACTIVATION_TEMPLATE_SUBJECT
• Registration
  • TRAVELLING_REGISTRATION_REQUIRE_EMAIL_ACTIVATION
  • TRAVELLING_REGISTRATION_REQUIRE_MANUAL_ACTIVATION

Basic

TRAVELLING_PORT

Travelling’s serving port. </br>

Default: 443

TRAVELLING_IP

Travelling’s serving IP. </br>

Default: 0.0.0.0

TRAVELLING_KEY

The path to the SSL key that is used for https </br>

Default: travelling/localhost.key

TRAVELLING_CERT

The path to the SSL cert that is used for https </br>

Default: travelling/localhost.csr

TRAVELLING_HTTPS

Enables https serving. </br>

Default: travelling/localhost.csr

TRAVELLING_SERVICE_NAME

Changes the service’s urls and other functionality around it’s name. </br>

Default: travelling

---

Misc

TRAVELLING_MISC_CLOUDFLAREIP

If cloudflare sits infront of Travelling set this to true, so users have their real IP assigned to them. </br>

Default: false

---

Cors

Recommended to keep this disabled due to security reasons. Only enable this if you really need it and know the risks.

TRAVELLING_CORS_ENABLE

Allows external services to make api calls to Travelling. </br>

Default: false

TRAVELLING_CORS_HEADER_ORIGIN

_Full host path or wildstar _ host pathed subdomains to allow. This is returned back with all requests.* </br>

Default: Rewrites the origin to whatever external host is making the call. This allows all external calls allowed and is not recommended. </br> > Example: *.domain.com

TRAVELLING_CORS_HEADER_METHODS

access-control-allow-methods header that is returned back with all requests. </br>

Default: Rewrites it’s self to the access-control-request-method header request or sets to * if there is no request. </br> > Example: GET,DELETE

TRAVELLING_CORS_HEADER_CREDENTIALS

access-control-allow-credentials header that is returned back with all routes under /travelling/api/v1/auth/ </br>

Default: true </br>

TRAVELLING_CORS_HEADER_MAX_AGE

access-control-max-age header that is returned back with all CORS options request. </br>

Default: 3600 </br>

---

Logging

For maximum performance it is recommended to disable TRAVELLING_LOG_FASTIFY_LOGGER_REQUEST and TRAVELLING_LOG_FASTIFY_LOGGER

TRAVELLING_LOG_ENABLE

Enables TRAVELLING_LOG_LOGGER. </br>

Default: true

TRAVELLING_LOG_LOGGER

An absolute file path to a custom node.js logger. This must not be set for the settings TRAVELLING_LOG_LEVEL & TRAVELLING_LOG_COLORS to function. It also needs to support the same interface as Node’s built in console logger. </br>

Default: travelling/include/utils/logger.js

TRAVELLING_LOG_COLORS

Enables console colors to be used with TRAVELLING_LOG_LOGGER. </br>

Default: true

TRAVELLING_LOG_LEVEL

Sets the log level for TRAVELLING_LOG_LOGGER. The options are trace,debug,info,warn,error,fatal. </br>

Default: info

TRAVELLING_LOG_REQUESTS

Enables logging of every request of all requests with TRAVELLING_LOG_LOGGER. </br>

Default: true

TRAVELLING_LOG_UNAUTHORIZED_ACCESS

Enables logging of every unauthorized access requests made with TRAVELLING_LOG_LOGGER. </br>

Default: true

---

Fastify Logger

TRAVELLING_LOG_FASTIFY_LOGGER

Enables logging for fastify’s built-in pino logger. This can be set to a true/false value or a absolute path of a javascript file to set pino’s settings / implement a custom logger from the pino interface. </br>

Default: false </br> > Example: js file setting pino settings.

module.exports = {
  level: 'info'
};

TRAVELLING_LOG_FASTIFY_LOGGER_REQUEST

Enables logging of every request and response in pino’s format. Recommended not to have this and TRAVELLING_LOG_LOGGER enabled at once </br>

Default: true

TRAVELLING_LOG_FASTIFY_LOGGER_REQ_ID_HEADER

The name of the header that gets set by pino’s correlation id system. </br>

Default: travelling-req-id </br>

TRAVELLING_LOG_FASTIFY_LOGGER_REQ_ID_LOG_LABEL

The name of the property that gets set by pino’s correlation id system. </br>

Default: travellingReqID </br>

---

Portal

TRAVELLING_PORTAL_ENABLE

Enables the portal which has the client for login/logout/register/forgotPassword/oauth2Code functionality. This should always be enabled. </br>

Default: true

TRAVELLING_PORTAL_PATH

The route that travelling will serve the client at. </br>

Default: /travelling/portal/

TRAVELLING_PORTAL_HOST

This is used once on the first startup of Travelling during group initialization. This sets the remote host of a custom client to be served under the TRAVELLING_PORTAL_HOST path. </br>

Default: travelling/localhost.key

TRAVELLING_PORTAL_FILE_PATH

The absolute filepath to the root directory of the client files. Recommended not to be changed unless unless there is a need for a fully custom rewrite of Travelling’s client pages. </br>

Default: travelling/client/dist

TRAVELLING_PORTAL_LOGO

The absolute filepath to the logo to be displayed on the client side. </br>

Default: travelling/client/assets/logo.svg

TRAVELLING_PORTAL_STYLES

The absolute filepath to the css file to be displayed on the client side. </br>

Default: travelling/client/assets/styles.css

TRAVELLING_PORTAL_ICON

The absolute filepath to the faveicon to be displayed on the client side. </br>

Default: travelling/client/assets/favicon.ico

---

Proxy

TRAVELLING_PROXY_TIMEOUT

How long in seconds the proxy should wait on a request to finish. 0 is Infinity </br>

Default: 0

TRAVELLING_PROXY_SEND_TRAVELLING_HEADERS

Allows Travelling to send permission/user/group based headers along with the proxy route </br>

Default: false

Header	Description
un	User’s Username.
uid	User’s Id.
gn	User’s Group’s name that allowed the request.
gt	User’s Group’s type that allowed the request.
perm	Permission’s name that allowed the request.

---

Redis

TRAVELLING_REDIS_ENABLE

Enables redis to be used when multiple instances of travelling are running and being load balanced against. </br>

Default: false Uses in memory store which could be problematic depending on how many groups and routes there are.

TRAVELLING_REDIS_URL

The URL to a redis instance to be used by travelling as a data store. </br>

Default: redis://127.0.0.1:6379/

TRAVELLING_REDIS_EVENTS_URL

The URL to a redis instance to be used by travelling as a pub/sub event system. </br>

Default: redis://127.0.0.1:6379/

---

Cookie

Travelling uses a dual cookie system. One is a persistent token cookie for longterm login and the other is a short lived session cookie made to put less load on the system and speed things up making it not need to decrypt the token cookie every request.

TRAVELLING_COOKIE_SESSION_SECRET

The session secret used to generate the session cookie with. This needs to stay a secret and should be changed ever so often for security reasons </br>

Default: ` ` This needs to be set!

TRAVELLING_COOKIE_SESSION_EXPIRATION

How long the session cookie will last for in seconds. Recommended to set it to the average number of seconds a user tends to use your service for. </br>

Default: 300

TRAVELLING_COOKIE_TOKEN_SECRET

The token secret used to generate the persistent token cookie with. This needs to stay a secret and should be changed ever so often for security reasons </br>

Default: null This needs to be set!

TRAVELLING_COOKIE_TOKEN_SALT

The token salt used to generate the persistent token cookie with. This needs to stay a secret and should be changed ever so often for security reasons </br>

Default: null This needs to be set!

TRAVELLING_COOKIE_TOKEN_EXPIRATION

How long the persistent token cookie will last for in days. </br>

Default: 30

TRAVELLING_COOKIE_TOKEN_CHECKABLE

Adds JavaScript accessible cookie, called trav:ls, contianing the expiration of the trav:tok cookie. </br>

Default: true

TRAVELLING_COOKIE_DOMAIN

How long the persistent token cookie will last for in days. </br>

Default: null

TRAVELLING_COOKIE_SECURITY_IP_HIJACK_PROTECTION

Enables cookie linked to remote ip’s. Disabling this removes one more layer of protection against CRSF attacks, but might be needed depending on your Cors settings. </br>

Default: true

---

USER

TRAVELLING_USER_ISOLATE_BY_DOMAIN

This allows users that have same username/email to register and be isolated by the domain property. This is useful if you have multiple websites and you want to keep your users isolated from each other. </br>

Default: false

TRAVELLING_USER_USERNAME_MINCHAR

The minimum amount of characters a username has to have. </br>

Default: 4

TRAVELLING_USER_USERNAME_ENABLE

Require users to have usernames </br>

Default: true

TRAVELLING_USER_LOCKED_MESSAGE

Require users to have usernames </br>

Default: Failed login attempts exceeded the limit. Contact your admin to get your account unlocked.

---

Authentication

TRAVELLING_PASSWORD_CONSECUTIVE

Disables user’s passwords from having any consecutive characters. </br>

Default: false

TRAVELLING_PASSWORD_MINCHAR

The minimum amount of characters a user’s password has to have </br>

Default: 8

TRAVELLING_PASSWORD_MAXCHAR

The maximum amount of characters a user’s password is allowed to have. Leaving this unset makes it unlimited </br>

Default: ` `

TRAVELLING_PASSWORD_SPECIAL

The minimum amount of special characters a user’s password has to have. </br>

Default: 30

TRAVELLING_PASSWORD_NUMBER

The minimum amount of numbers characters a user’s password has to have. </br>

Default: 1

TRAVELLING_PASSWORD_LOWERCASE

The minimum amount of lowercase characters a user’s password has to have. </br>

Default: 1

TRAVELLING_PASSWORD_UPPERCASE

The minimum amount of uppercase characters a user’s password has to have. </br>

Default: 1

TRAVELLING_LOGIN_MAX_LOGIN_ATTEMPTS

The maximum amount of failed login attempts until a user is locked. </br>

Default: 10

---

OAUTH2

TRAVELLING_TOKEN_ACCESS_EXPIRATION

How long a OAUTH2 Access token will last for in minutes. </br>

Default: 1440

TRAVELLING_TOKEN_CODE_EXPIRATION

How long a OAUTH2 Code token will last for in minutes. </br>

Default: 5

TRAVELLING_TOKEN_CODE_AUTHORIZE_FLOW

Enforces the user to click a authorize button to allow a client to login for the user. </br>

Default: true

---

Postgres

TRAVELLING_DATABASE_URL

The Postgres connection url for Travelling to connect to. </br>

Default: null

TRAVELLING_DATABASE_USER

The Postgres user. </br>

Default: null

TRAVELLING_DATABASE_PASSWORD

The Postgres password. </br>

Default: null

TRAVELLING_DATABASE_PORT

The Postgres port. </br>

Default: null

TRAVELLING_DATABASE_NAME

The Postgres databases name. </br>

Default: null

TRAVELLING_DATABASE_HOST

The Postgres host. </br>

Default: null

TRAVELLING_PG_CRYPTO_IMPLEMENTATION

The absolute path to the encryption interface that is used for Travelling’s database encryption fields. If a custom implementation is wanted please check out travelling/include/utils/cryptointerface.js for methods needed to be functional. </br>

Default: travelling/include/utils/cryptointerface.js

TRAVELLING_PG_CRYPTO_IMPLEMENTATION_SECRET

The secret used inside TRAVELLING_PG_CRYPTO_IMPLEMENTATION. This needs to stay a secret and should be changed ever so often for security reasons. </br>

Default: null This needs to be set!

TRAVELLING_PG_CRYPTO_IMPLEMENTATION_SALT

The salt used inside TRAVELLING_PG_CRYPTO_IMPLEMENTATION. This needs to stay a secret and should be changed ever so often for security reasons. </br>

Default: null This needs to be set!

TRAVELLING_PG_CRYPTO_ENCRYPT_USER_DATA

Enables the user_data field inside the user object to be encrypted. If sensitive data is stored in within that field it is recommended to enable this. </br>

Default: false

---

Email

TRAVELLING_EMAIL_VALIDATION_EXTERNAL_ENABLE

Enable external email endpoint for email validation </br>

Default: false

TRAVELLING_EMAIL_VALIDATION_EXTERNAL_ENDPOINT

Full url for endpoint for email validation </br>

Default: null

TRAVELLING_EMAIL_VALIDATION_EXTERNAL_EMAIL_IN_ENDPOINT

Appends the users email to the end of the supplied endpoint. EX: http://test.com/email/test@test.com </br>

Default: true

TRAVELLING_EMAIL_VALIDATION_EXTERNAL_EMAIL_IN_BODY

Sends the users email as text as a body to the supplied endpoint </br>

Default: false

TRAVELLING_EMAIL_VALIDATION_EXTERNAL_METHOD

Supplied endpoint’s HTTP Method to use </br>

Default: GET

TRAVELLING_EMAIL_FROM

The email that will be used as the from address. Recommended to set it to a no-reply email address </br>

Default: null

TRAVELLING_EMAIL_RECOVERY_EXPIRATION

The number of seconds for the email recovery link to last for. Recommended to keep this somewhat short-lived for security reasons. </br>

Default: 900

TRAVELLING_EMAIL_ACTIVATION_EXPIRATION

The number of seconds for the email activation link to last for. </br>

Default: 86400

TRAVELLING_EMAIL_TEST_ENABLE

Enables the use of a test email service that will display the login credentials inside the log at start. This is used by our integration test. However, it is helpful to enable this if custom Templates are written. Only one type of email support should be used Test, SMTP or AWS. </br>

Default: false

TRAVELLING_EMAIL_SMTP_ENABLE

Enables the use of a SMTP email service. Only one type of email support should be used Test, SMTP or AWS. </br>

Default: false

TRAVELLING_EMAIL_SMTP_HOST

The host of the SMTP service. </br>

Default: 127.0.0.1

TRAVELLING_EMAIL_SMTP_PORT

The port of the SMTP service. </br>

Default: 465

TRAVELLING_EMAIL_SMTP_SECURE

Enables TLS for SMTP. </br>

Default: true

TRAVELLING_EMAIL_SMTP_AUTH_USER

Username for SMTP service. </br>

Default: null

TRAVELLING_EMAIL_SMTP_SECURE

Password for SMTP service. </br>

Default: null

TRAVELLING_EMAIL_SMTP_TLS_REJECT_UNAUTHORIZED

Enables rejection of TLS certs that are self served or invalid. Recommended to keep it enabled for security reasons. </br>

Default: true

TRAVELLING_EMAIL_AWS_ENABLE

Enables the use of the AWS SES email service. Only one type of email support should be used Test, SMTP or AWS. </br>

Default: false

TRAVELLING_EMAIL_AWS_CONFIG

The absolute path to the AWS json credentials config to use for accessing the SES service. See AWS’s configuration documentation on the format of this file. </br>

Default: null // This needs to be set to use AWS SES email service.

Templates

Templates all use html/handlebars. Check out the example default templates inside the travelling/templates/ folder for examples.

Reset Template Variables:

Variable	Description
` | This is the user object for the reset email. Use dot notation to access any of its properties for example:`.
| This is the config object for Travelling. Use dot notation to access any of its properties for example.
` `	The reset token that Travelling needs to reset the password. Recommended to just copy and paste the full a href from the TRAVELLING_EMAIL_RESET_PASSWORD_TEMPLATE_BODY.
``	This is the IP object from the user requesting the reset password. The following properties are valid. query,city, regionName, country.

Activation Template Variables:

Variable	Description
` | This is the user object for the activation email. Use dot notation to access any of its properties for example:`.
| This is the config object for Travelling. Use dot notation to access any of its properties for example.
` `	The reset token that Travelling needs to activate the user’s account. Recommended to just copy and paste the full a href from the TRAVELLING_EMAIL_ACTIVATION_TEMPLATE_BODY.

TRAVELLING_EMAIL_RESET_PASSWORD_TEMPLATE_BODY

The absolute path to the email reset password template body. This is used as the body inside all reset password emails. </br>

Default: travelling/templates/email-reset-password-body.html

TRAVELLING_EMAIL_RESET_PASSWORD_TEMPLATE_SUBJECT

The absolute path to the email reset password template subject. This is used as the subject line inside all reset password emails. </br>

Default: templates/email-reset-password-subject.html

TRAVELLING_EMAIL_ACTIVATION_TEMPLATE_BODY

The absolute path to the email activation template body. This is used as the body inside all activation emails. </br>

Default: templates/email-activation-body.html

TRAVELLING_EMAIL_ACTIVATION_TEMPLATE_SUBJECT

The absolute path to the email activation template subject.This is used as the subject line inside all activation emails. </br>

Default: templates/email-activation-subject.html

---

Registration

TRAVELLING_REGISTRATION_REQUIRE_EMAIL_ACTIVATION

Enables the requirement of each newly registered user to activate their account through the email link. </br>

Default: false

TRAVELLING_REGISTRATION_REQUIRE_MANUAL_ACTIVATION

Enables the requirement of each newly registered user to have a active user with permissions to unlock their account for them. </br>

Default: false

SDK

SDK

Classes

Travelling

Audit

AuditUser

Config

Groups

GroupsType

Group

GroupUsers

GroupUser

GroupType

GroupTypeUsers

Both requests are disabled. Dont use.

GroupTypeUser

GroupRequest

GroupRequestUser

Users

UsersDomain

User

UserDomain

UserCurrent

Auth

Auth endpoints

AuthToken

AuthDomain

AuthDomainToken

Functions

SDK(host, opts)

SDK - importing the SDK for use

Travelling

Kind: global class

• Travelling
  • .healthCheck(authorization_bearer)
  • .metrics(authorization_bearer)

Travelling.healthCheck(authorization_bearer)

healthCheck - server’s health check

Path: health

Kind: static method of Travelling

Param	Type	Description
authorization_bearer	string	The client_credentials generated OAUth2 access token.

Travelling.metrics(authorization_bearer)

metrics - servers metrics

Path: metrics

Kind: static method of Travelling

Param	Type	Description
authorization_bearer	string	The client_credentials generated OAUth2 access token.

Audit

Kind: global class

• Audit
  • .byActionAndSubaction(action, subaction, limit, skip, sort, sortdir, filter, resolve, authorization_bearer)
  • .bySubaction(subaction, limit, skip, sort, sortdir, filter, resolve, authorization_bearer)
  • .byAction(action, limit, skip, sort, sortdir, filter, resolve, authorization_bearer)

Audit.byActionAndSubaction(action, subaction, limit, skip, sort, sortdir, filter, resolve, authorization_bearer)

byActionAndSubaction - Gets audits by action and subaction type.

Filter Params

*Note: you can only use range operators (<,B >,B >=,B <=) on the following columns: created_on.

Param	Description
id	optional (example: id=415c87e9-eaad-4b8e-8ce8-655c911e20ae)
created_on	optional (example: created_on>=2021-06-09)
prop	optional (example: prop=email)
old_val	optional (example: old_val=swagger@email.69)
new_val	optional (example: new_val=leet@teel.com)

Path: api/v1/audit/action/:action/subaction/:subaction

Kind: static method of Audit

Param	Type	Description
action	any	Audti action type. (example: CREATE)
subaction	any	Audit subaction type. (example: GROUP)
limit	any	Number of maximum results. (example: 2) (example: 2)
skip	any	Number of db rows skipped. (example: 10) (example: 1)
sort	any	Sort by any user object key (examples: created_on, action, etc.) (example: created_on)
sortdir	any	Sort direction (example ascending order: ASC) (example: ASC)
filter	any	Filter parameters (example: action=created_on>2021-06-03,created_on<2021-06-06) (example: created_on>2021-06-03,created_on<2021-06-06)
resolve	any	Joins users table to obtain ‘by_user_firstname’ and ‘by_user’lastname’ fields (example: true)
authorization_bearer	string	The client_credentials generated OAUth2 access token.

Audit.bySubaction(subaction, limit, skip, sort, sortdir, filter, resolve, authorization_bearer)

bySubaction - Gets audits by subaction type.

Filter Params

*Note: you can only use range operators (<,B >,B >=,B <=) on the following columns: created_on.

Param	Description
id	optional (example: id=415c87e9-eaad-4b8e-8ce8-655c911e20ae)
created_on	optional (example: created_on>=2021-06-09)
prop	optional (example: prop=email)
old_val	optional (example: old_val=swagger@email.69)
new_val	optional (example: new_val=leet@teel.com)

Path: api/v1/audit/subaction/:subaction

Kind: static method of Audit

Param	Type	Description
subaction	any	Audit subaction type. (example: USER)
limit	any	Number of maximum results. (example: 2) (example: 2)
skip	any	Number of db rows skipped. (example: 10) (example: 1)
sort	any	Sort by any user object key (examples: created_on, action, etc.) (example: created_on)
sortdir	any	Sort direction (example ascending order: ASC) (example: ASC)
filter	any	Filter parameters (example: action=created_on>2021-06-03,created_on<2021-06-06) (example: created_on>2021-06-03,created_on<2021-06-06)
resolve	any	Joins users table to obtain ‘by_user_firstname’ and ‘by_user’lastname’ fields (example: true)
authorization_bearer	string	The client_credentials generated OAUth2 access token.

Audit.byAction(action, limit, skip, sort, sortdir, filter, resolve, authorization_bearer)

byAction - Gets audits by action type.

Filter Params

*Note: you can only use range operators (<,B >,B >=,B <=) on the following columns: created_on.

Param	Description
id	optional (example: id=415c87e9-eaad-4b8e-8ce8-655c911e20ae)
created_on	optional (example: created_on>=2021-06-09)
prop	optional (example: prop=email)
old_val	optional (example: old_val=swagger@email.69)
new_val	optional (example: new_val=leet@teel.com)

Path: api/v1/audit/action/:action

Kind: static method of Audit

Param	Type	Description
action	any	Audit action type. (example: CREATE)
limit	any	Number of maximum results. (example: 2) (example: 2)
skip	any	Number of db rows skipped. (example: 10) (example: 1)
sort	any	Sort by any user object key (examples: created_on, action, etc.) (example: created_on)
sortdir	any	Sort direction (example ascending order: ASC) (example: ASC)
filter	any	Filter parameters (example: action=created_on>2021-06-03,created_on<2021-06-06) (example: created_on>2021-06-03,created_on<2021-06-06)
resolve	any	Joins users table to obtain ‘by_user_firstname’ and ‘by_user’lastname’ fields (example: true)
authorization_bearer	string	The client_credentials generated OAUth2 access token.

AuditUser

Kind: global class

• AuditUser
  • .countByuserId(id, filter, limit, skip, sort, sortdir, selfexclusion, authorization_bearer)
  • .byuserId(id, filter, limit, skip, sort, sortdir, resolve, selfexclusion, authorization_bearer)
  • .countOfuserId(id, filter, limit, skip, sort, sortdir, selfexclusion, authorization_bearer)
  • .ofuserId(id, filter, limit, skip, sort, sortdir, resolve, selfexclusion, authorization_bearer)

AuditUser.countByuserId(id, filter, limit, skip, sort, sortdir, selfexclusion, authorization_bearer)

countByuserId - Gets audits by by_user id.

Filter Params

*Note: you can only use range operators (<,B >,B >=,B <=) on the following columns: created_on.

Param	Description
id	optional (example: id=415c87e9-eaad-4b8e-8ce8-655c911e20ae)
created_on	optional (example: created_on>=2021-06-09)
action	optional (example: action=CREATE)
subaction	optional (example: subaction=USER)
prop	optional (example: prop=email)
old_val	optional (example: old_val=swagger@email.69)
new_val	optional (example: new_val=leet@teel.com)

Path: api/v1/audit/count/user/byuser/:id

Kind: static method of AuditUser

Param	Type	Description
id	any	Id of user that committed the action. (example: bf1b1e49-a105-43dc-b9a2-32c69a17fb5f)
filter	any	Filter parameters (example: action=CREATE,subaction=USER,created_on>2021-06-03,created_on<2021-06-06) (example: created_on>2023-01-03,created_on<2023-06-06)
limit	any	Number of maximum results. (example: 2) (example: 2)
skip	any	Number of db rows skipped. (example: 10) (example: 1)
sort	any	Sort by any user object key (examples: created_on, action, etc.) (example: created_on)
sortdir	any	Sort direction (example ascending order: ASC) (example: ASC)
selfexclusion	any	Excludes audits with the same of_user_id. (example: true)
authorization_bearer	string	The client_credentials generated OAUth2 access token.

AuditUser.byuserId(id, filter, limit, skip, sort, sortdir, resolve, selfexclusion, authorization_bearer)

byuserId - Gets audits by by_user id.

Filter Params

*Note: you can only use range operators (<,B >,B >=,B <=) on the following columns: created_on.

Param	Description
id	optional (example: id=415c87e9-eaad-4b8e-8ce8-655c911e20ae)
created_on	optional (example: created_on>=2021-06-09)
action	optional (example: action=CREATE)
subaction	optional (example: subaction=USER)
prop	optional (example: prop=email)
old_val	optional (example: old_val=swagger@email.69)
new_val	optional (example: new_val=leet@teel.com)

Path: api/v1/audit/user/byuser/:id

Kind: static method of AuditUser

Param	Type	Description
id	any	Id of user that committed the action. (example: 44aa2ae6-22e9-43ef-a6d3-3d7d39e78064)
filter	any	Filter parameters (example: action=CREATE,subaction=USER,created_on>2021-06-03,created_on<2021-06-06) (example: created_on>2021-06-03,created_on<2021-06-06)
limit	any	Number of maximum results. (example: 2) (example: 2)
skip	any	Number of db rows skipped. (example: 10) (example: 1)
sort	any	Sort by any user object key (examples: created_on, action, etc.) (example: created_on)
sortdir	any	Sort direction (example ascending order: ASC) (example: ASC)
resolve	any	Joins users table to obtain ‘by_user_firstname’ and ‘by_user’lastname’ fields (example: true)
selfexclusion	any	Excludes audits with the same of_user_id. (example: true)
authorization_bearer	string	The client_credentials generated OAUth2 access token.

AuditUser.countOfuserId(id, filter, limit, skip, sort, sortdir, selfexclusion, authorization_bearer)

countOfuserId - Gets audits by of_user id.

Filter Params

*Note: you can only use range operators (<,B >,B >=,B <=) on the following columns: created_on.

Param	Description
id	optional (example: id=415c87e9-eaad-4b8e-8ce8-655c911e20ae)
created_on	optional (example: created_on>=2021-06-09)
action	optional (example: action=CREATE)
subaction	optional (example: subaction=USER)
prop	optional (example: prop=email)
old_val	optional (example: old_val=swagger@email.69)
new_val	optional (example: new_val=leet@teel.com)

Path: api/v1/audit/count/user/ofuser/:id

Kind: static method of AuditUser

Param	Type	Description
id	any	Id of user that committed the action. (example: bf1b1e49-a105-43dc-b9a2-32c69a17fb5f)
filter	any	Filter parameters (example: action=CREATE,subaction=USER,created_on>2021-06-03,created_on<2021-06-06) (example: created_on>2021-06-03,created_on<2021-06-06)
limit	any	Number of maximum results. (example: 2) (example: 2)
skip	any	Number of db rows skipped. (example: 10) (example: 10)
sort	any	Sort by any user object key (examples: created_on, action, etc.) (example: action)
sortdir	any	Sort direction (example ascending order: ASC) (example: DESC)
selfexclusion	any	Excludes audits with the same by_user_id. (example: true)
authorization_bearer	string	The client_credentials generated OAUth2 access token.

AuditUser.ofuserId(id, filter, limit, skip, sort, sortdir, resolve, selfexclusion, authorization_bearer)

ofuserId - Gets audits by of_user id.

Filter Params

*Note: you can only use range operators (<,B >,B >=,B <=) on the following columns: created_on.

Param	Description
id	optional (example: id=415c87e9-eaad-4b8e-8ce8-655c911e20ae)
created_on	optional (example: created_on>=2021-06-09)
action	optional (example: action=CREATE)
subaction	optional (example: subaction=USER)
prop	optional (example: prop=email)
old_val	optional (example: old_val=swagger@email.69)
new_val	optional (example: new_val=leet@teel.com)

Path: api/v1/audit/user/ofuser/:id

Kind: static method of AuditUser

Param	Type	Description
id	any	Id of user that committed the action. (example: 44aa2ae6-22e9-43ef-a6d3-3d7d39e78064)
filter	any	Filter parameters (example: action=CREATE,subaction=USER,created_on>2021-06-03,created_on<2021-06-06) (example: created_on>2021-06-03,created_on<2021-06-06)
limit	any	Number of maximum results. (example: 2) (example: 2)
skip	any	Number of db rows skipped. (example: 10) (example: 10)
sort	any	Sort by any user object key (examples: created_on, action, etc.) (example: action)
sortdir	any	Sort direction (example ascending order: ASC) (example: DESC)
resolve	any	Joins users table to obtain ‘by_user_firstname’ and ‘by_user’lastname’ fields (example: true)
selfexclusion	any	Excludes audits with the same by_user_id. (example: true)
authorization_bearer	string	The client_credentials generated OAUth2 access token.

Config

Kind: global class

Config.getProperty(property, authorization_bearer)

getProperty - Gets a property from travellings config.

Path: api/v1/config/:property

Kind: static method of Config

Param	Type	Description
property	any	(example: password)
authorization_bearer	string	The client_credentials generated OAUth2 access token.

Groups

Kind: global class

• Groups
  • .export(authorization_bearer)
  • .import(body, authorization_bearer)
  • .get(authorization_bearer)

Groups.export(authorization_bearer)

export - Exports all groups in the proper format to be imported.

Path: api/v1/groups/export

Kind: static method of Groups

Param	Type	Description
authorization_bearer	string	The client_credentials generated OAUth2 access token.

Groups.import(body, authorization_bearer)

import - Imports all groups from the exported format.

Path: api/v1/groups/import

Kind: static method of Groups

Param	Type	Description
body	Object
authorization_bearer	string	The client_credentials generated OAUth2 access token.

Example
body

{
  "group": {
    "anonymous": {
      "allowed": [
        {"method": "GET", "route": "/account/portal/*"},
        {"method": "GET", "route": "/account/assets/*"},
        {"method": "GET", "route": "/favicon.ico"},
        {"method": "GET", "route": "/account/api/v1/auth/logout"},
        {"method": "PUT", "route": "/account/api/v1/auth/password/forgot"},
        {"method": "PUT", "route": "/account/api/v1/auth/password/reset"},
        {"method": "GET", "route": "/account/api/v1/auth/activate"},
        {"method": "POST", "route": "/account/api/v1/auth/token"},
        {"method": "GET", "route": "/account/api/v1/auth/login/otp"},
        {"method": "POST","route":"/account/api/v1/auth/oauth/authorize"},
        {"method": "GET","route":"/account/api/v1/auth/oauth/authorize"},
        {"method": "GET", "route": "/account/api/v1/user/me/permission/allowed/*"},
        {"method": "GET", "route": "/account/api/v1/user/me/route/allowed"},
        {"method": "GET", "route": "/account/api/v1/config/password"},
        {"method": "GET", "route": "/account/api/v1/config/portal/webclient"},
        {"method": "GET", "route": "/account/metrics"},
        {"method": "GET", "route": "/account/health"}
      ]
    }
  }
}

Groups.get(authorization_bearer)

get - Get all the groups

Path: api/v1/groups

Kind: static method of Groups

Param	Type	Description
authorization_bearer	string	The client_credentials generated OAUth2 access token.

GroupsType

Kind: global class

• GroupsType
  • .all(type, authorization_bearer)
  • .getTypesList(authorization_bearer)

GroupsType.all(type, authorization_bearer)

all - Gets all groups of a particular type

Path: api/v1/groups/type/:type

Kind: static method of GroupsType

Param	Type	Description
type	any	The type of the group
authorization_bearer	string	The client_credentials generated OAUth2 access token.

GroupsType.getTypesList(authorization_bearer)

getTypesList - Gets all the types of groups currently made.

Path: api/v1/groups/types

Kind: static method of GroupsType

Param	Type	Description
authorization_bearer	string	The client_credentials generated OAUth2 access token.

Group

Kind: global class

• Group
  • .addPermission(id, permission, authorization_bearer)
  • .deletePermission(id, permission, authorization_bearer)
  • .addRoute(body, id, authorization_bearer)
  • .removeInheritance(id, inherited, grouptype, authorization_bearer)
  • .inheritFrom(id, inherited, grouptype, authorization_bearer)
  • .setDefault(id, authorization_bearer)
  • .delete(id, authorization_bearer)
  • .edit(body, id, authorization_bearer)
  • .get(id, authorization_bearer)
  • .createByName(id, authorization_bearer)
  • .create(body, authorization_bearer)

Group.addPermission(id, permission, authorization_bearer)

addPermission - Adds a permission to a group.

Path: api/v1/group/id/:id/insert/permission/:permission

Kind: static method of Group

Param	Type	Description
id	any	Name of the group (example: anonymous)
permission	any	Permission (example: test-one-two-*)
authorization_bearer	string	The client_credentials generated OAUth2 access token.

Group.deletePermission(id, permission, authorization_bearer)

deletePermission - Removes a permission/route from a group.

Path: api/v1/group/id/:id/permission/:permission

Kind: static method of Group

Param	Type	Description
id	any	Name of the group (example: anonymous)
permission	any	Name or Route (example: test-one-two-*)
authorization_bearer	string	The client_credentials generated OAUth2 access token.

Group.addRoute(body, id, authorization_bearer)

addRoute - Adds a route to a group.

{
    "route": "test/permissions/*", // optional
    "host": null, // optional, defaults to travelling host
    "method": "*", // optional, defaults to '*'
    "remove_from_path": 'test/', // optional 
    "name": "test-permissions-*"  // Required and needs to be unqiue, defaults to method + route seperated by '-' instead of `/`
}

Path: api/v1/group/id/:id/insert/route

Kind: static method of Group

Param	Type	Description
body	Object
id	any
authorization_bearer	string	The client_credentials generated OAUth2 access token.

Example
body

{
	"route": "test/permissions/*",
    "host": null, 
    "method": "*", 
    "name": "test-permissions-*"  
}

Group.removeInheritance(id, inherited, grouptype, authorization_bearer)

removeInheritance - Removes an inheritance from a group.

Path: api/v1/group/id/:id/remove/inheritance/:inherited/type/:grouptype

Kind: static method of Group

Param	Type	Description
id	any	Name of the group (example: test1234)
inherited	any	Name of the group to inherit from (example: group4)
grouptype	any	The type of the inherited group
authorization_bearer	string	The client_credentials generated OAUth2 access token.

Group.inheritFrom(id, inherited, grouptype, authorization_bearer)

inheritFrom - Adds an inheritance to a group.

Path: api/v1/group/id/:id/inherit/from/:inherited/type/:grouptype

Kind: static method of Group

Param	Type	Description
id	any	Name of the group (example: test1234)
inherited	any	Name of the group to inherit from (example: group4)
grouptype	any	The type of the inherited group
authorization_bearer	string	The client_credentials generated OAUth2 access token.

Group.setDefault(id, authorization_bearer)

setDefault - Sets the group to be the default group for new users.

Path: api/v1/group/id/:id/set/default

Kind: static method of Group

Param	Type	Description
id	any	id or name (example: group6)
authorization_bearer	string	The client_credentials generated OAUth2 access token.

Group.delete(id, authorization_bearer)

delete - delete group by its id or name

Path: api/v1/group/id/:id

Kind: static method of Group

Param	Type	Description
id	any	id or name (example: group1)
authorization_bearer	string	The client_credentials generated OAUth2 access token.

Group.edit(body, id, authorization_bearer)

edit - Edits a group

Path: api/v1/group/id/:id

Kind: static method of Group

Param	Type	Description
body	Object
id	any	(example: ab31efc8-40a5-4d38-a347-adb4e38d0075)
authorization_bearer	string	The client_credentials generated OAUth2 access token.

Example
body

{
    "allowed": [
        {
            "route": "/travelling/portal/*",
            "host": null,
            "remove_from_path": "/travelling/portal",
            "method": "*",
            "name": "*-travelling-portal-*"
        },
        {
            "route": "/travelling/api/v1/auth/*",
            "host": null,
            "method": "*",
            "name": "*-travelling-api-v1-auth-*"
        },
        {
            "route": "/travelling/api/v1/user/me/route/allowed",
            "host": null,
            "method": "GET",
            "name": "get-travelling-api-v1-user-me-route-allowed"
        },
        {
            "route": "/travelling/api/v1/user/me/permission/allowed/*",
            "host": null,
            "method": "GET",
            "name": "get-travelling-api-v1-user-me-permission-allowed-*"
        },
        {
            "route": "/travelling/assets/*",
            "host": null,
            "remove_from_path": "/travelling/assets/",
            "method": "*",
            "name": "*-travelling-assets-*"
        },
        {
            "route": "travelling/api/v1/config/password",
            "host": null,
            "method": "get"
        }
    ]
}

Group.get(id, authorization_bearer)

get - Get a group by it’s id or name.

Path: api/v1/group/id/:id

Kind: static method of Group

Param	Type	Description
id	any	id or name (example: group1)
authorization_bearer	string	The client_credentials generated OAUth2 access token.

Group.createByName(id, authorization_bearer)

createByName - Add a new blank group with the set name.

Path: api/v1/group/id/:id

Kind: static method of Group

Param	Type	Description
id	any	Name of the new group (example: test123)
authorization_bearer	string	The client_credentials generated OAUth2 access token.

Group.create(body, authorization_bearer)

create - Add a new group

Path: api/v1/group

Kind: static method of Group

Param	Type	Description
body	Object
authorization_bearer	string	The client_credentials generated OAUth2 access token.

Example
body

{
    "name": "group1",
    "type": "testgroup",
    "allowed": [
        {
            "route": "/test",
            "host": "http://127.0.0.1:1237/",
            "remove_from_path": "test",
            "method": "*",
            "name": "all-test"
        }
    ],
    "is_default": false
}

GroupUsers

Kind: global class

• GroupUsers
  • .inherited(id)
  • .count(id, filter, limit, skip, authorization_bearer)
  • .get(id, filter, limit, skip, sort, sortdir, authorization_bearer)

GroupUsers.inherited(id)

inherited - Gets all the users that belong to the group and all of its inherited groups.

Optional Query Params

Param	Description
id	optional (example: 26c6aeff-ab95-4bdd-8260-534cf92d1c23)
username	optional (example: user7)
locked	optional (example: true)
locked_reason	optional (example: Activation Required email your admin to get your account activated)
group_request	optional (example: superadmin)
failed_login_attempts	optional (example: 0)
change_username	optional (example: false)
change_password	optional (example: false)
reset_password	optional (example: false)
email_verify	optional (example: false)
group_id	optional (example: 7320292c-627e-4e5a-b059-583eabdd6264)
email	optional (example: test@test.ai)
created_on	optional (example: 1568419646794)
last_login	optional (example: null)

Path: api/v1/group/id/:id/users/inherited

Kind: static method of GroupUsers

Param	Type	Description
id	any	id or name (example: superadmin)

GroupUsers.count(id, filter, limit, skip, authorization_bearer)

count - Gets all the users that belong to the group.

Optional Query Params

*Note: you can only use range operators (<,B >,B >=,B <=) on the following columns: created_on, updated_on, dob.

Param	Description
id	optional (example: 26c6aeff-ab95-4bdd-8260-534cf92d1c23)
username	optional (example: user7)
locked	optional (example: true)
locked_reason	optional (example: Activation Required email your admin to get your account activated)
group_request	optional (example: superadmin)
failed_login_attempts	optional (example: 0)
change_username	optional (example: false)
change_password	optional (example: false)
reset_password	optional (example: false)
email_verify	optional (example: false)
group_id	optional (example: 7320292c-627e-4e5a-b059-583eabdd6264)
email	optional (example: test@test.ai)
created_on	optional (example: 1568419646794)
last_login	optional (example: null)

Path: api/v1/group/id/:id/users/count

Kind: static method of GroupUsers

Param	Type	Description
id	any	Group name or ID. (example: superadmin)
filter	any	Filter parameters (example: locked=false,created_on>2021-06-03,created_on<2021-06-06) (example: locked=false,created_on>2021-06-03,created_on<2021-06-06)
limit	any	Number of maximum results. (example: 10) (example: 10)
skip	any	Number of db rows skipped. (example: 2) (example: 2)
authorization_bearer	string	The client_credentials generated OAUth2 access token.

GroupUsers.get(id, filter, limit, skip, sort, sortdir, authorization_bearer)

get - Gets all the users that belong to the group.

Optional Query Params

*Note: you can only use range operators (<,B >,B >=,B <=) on the following columns: created_on, updated_on, dob.

Param	Description
id	optional (example: 26c6aeff-ab95-4bdd-8260-534cf92d1c23)
username	optional (example: user7)
locked	optional (example: true)
locked_reason	optional (example: Activation Required email your admin to get your account activated)
group_request	optional (example: superadmin)
failed_login_attempts	optional (example: 0)
change_username	optional (example: false)
change_password	optional (example: false)
reset_password	optional (example: false)
email_verify	optional (example: false)
group_id	optional (example: 7320292c-627e-4e5a-b059-583eabdd6264)
email	optional (example: test@test.ai)
created_on	optional (example: 1568419646794)
last_login	optional (example: null)

Path: api/v1/group/id/:id/users

Kind: static method of GroupUsers

Param	Type	Description
id	any	Group name or ID. (example: superadmin)
filter	any	Filter parameters (example: locked=false,created_on>2021-06-03,created_on<2021-06-06) (example: locked=false,created_on>2021-06-03,created_on<2021-06-06)
limit	any	Number of maximum results. (example: 10) (example: 10)
skip	any	Number of db rows skipped. (example: 2) (example: 2)
sort	any	Sort by any user object key (examples: id, domain, locked, etc.) (example: created_on)
sortdir	any	Sort direction (example ascending order: ASC) (example: ASC)
authorization_bearer	string	The client_credentials generated OAUth2 access token.

GroupUser

Kind: global class

• GroupUser
  • .delete(group, type, id, authorization_bearer)
  • .removeGroupInheritance(group, type, id, inheritgroupid, inheritgrouptype, authorization_bearer)
  • .addGroupInheritance(group, type, id, inheritgroupid, inheritgrouptype, authorization_bearer)
  • .editPropertyValue(group, type, id, property, value, authorization_bearer)
  • .editProperty(body, group, type, id, property, authorization_bearer)
  • .edit(body, group, type, id, authorization_bearer)
  • .getProperty(group, type, id, property, authorization_bearer)
  • .get(group, type, id, authorization_bearer)

GroupUser.delete(group, type, id, authorization_bearer)

delete - Delete a user by it’s id or username from group of a particular type.

Path: api/v1/group/id/:group/type/:type/user/:id

Kind: static method of GroupUser

Param	Type	Description
group	any	id or name of the group
type	any	The type of the group (example: accounts)
id	any	id or name (example: user7)
authorization_bearer	string	The client_credentials generated OAUth2 access token.

GroupUser.removeGroupInheritance(group, type, id, inheritgroupid, inheritgrouptype, authorization_bearer)

removeGroupInheritance - Remove a user to a group of a particular type of group.

Path: api/v1/group/id/:group/type/:type/user/:id/inheritance/group/:inheritgroupid/type/:inheritgrouptype

Kind: static method of GroupUser

Param	Type	Description
group	any	id or name of the group (example: group1)
type	any	type of group (example: group)
id	any	id or name of the user (example: user5)
inheritgroupid	any	id or name of the group to inherit (example: group2)
inheritgrouptype	any	type of the group to inherit (example: group)
authorization_bearer	string	The client_credentials generated OAUth2 access token.

GroupUser.addGroupInheritance(group, type, id, inheritgroupid, inheritgrouptype, authorization_bearer)

addGroupInheritance - Add a group for the current user from a group of a particular type.

Path: api/v1/group/id/:group/type/:type/user/:id/inheritance/group/:inheritgroupid/type/:inheritgrouptype

Kind: static method of GroupUser

Param	Type	Description
group	any	id or name of the group (example: group1)
type	any	type of group (example: group)
id	any	id or name of the user (example: user5)
inheritgroupid	any	id or name of the group to inherit (example: group2)
inheritgrouptype	any	type of the group to inherit (example: group)
authorization_bearer	string	The client_credentials generated OAUth2 access token.

GroupUser.editPropertyValue(group, type, id, property, value, authorization_bearer)

editPropertyValue - Edit a current user’s property data as a path param from a group of a particular type.

Path: api/v1/group/id/:group/type/:type/user/:id/property/:property/:value

Kind: static method of GroupUser

Param	Type	Description
group	any	id or name of the group
type	any	The type of the group (example: group)
id	any	id or name (example: user5)
property	any	(example: email)
value	any	(example: swag@yolo.com)
authorization_bearer	string	The client_credentials generated OAUth2 access token.

GroupUser.editProperty(body, group, type, id, property, authorization_bearer)

editProperty - Edit a user’s property by it’s id or username from a group of a particular type.

Path: api/v1/group/id/:group/type/:type/user/:id/property/:property

Kind: static method of GroupUser

Param	Type	Description
body	Object
group	any	id or name of the group
type	any	The type of the group (example: accounts)
id	any	id or name (example: user6)
property	any	(example: email)
authorization_bearer	string	The client_credentials generated OAUth2 access token.

Example
body

{
	"locked": false
}

GroupUser.edit(body, group, type, id, authorization_bearer)

edit - Edit a user by it’s id or username from group of a particular type.

Path: api/v1/group/id/:group/type/:type/user/:id

Kind: static method of GroupUser

Param	Type	Description
body	Object
group	any	id or name of the group
type	any	The type of the group (example: accounts)
id	any	id or name (example: user6)
authorization_bearer	string	The client_credentials generated OAUth2 access token.

Example
body

{
	"locked": false
}

GroupUser.getProperty(group, type, id, property, authorization_bearer)

getProperty - Get a user’s property by it’s id or username from group of a particular type.

Path: api/v1/group/id/:group/type/:type/user/:id/property/:property

Kind: static method of GroupUser

Param	Type	Description
group	any	id or name of the group
type	any	The type of the group (example: accounts)
id	any	id or name (example: user6)
property	any	(example: email)
authorization_bearer	string	The client_credentials generated OAUth2 access token.

GroupUser.get(group, type, id, authorization_bearer)

get - Get a user by it’s id or username from group of a particular type.

Path: api/v1/group/id/:group/type/:type/user/:id

Kind: static method of GroupUser

Param	Type	Description
group	any	id or name of the group
type	any	The type of the group (example: accounts)
id	any	id or name (example: user6)
authorization_bearer	string	The client_credentials generated OAUth2 access token.

GroupType

Kind: global class

• GroupType
  • .deletePermission(id, type, permission, authorization_bearer)
  • .addPermission(id, type, permission, authorization_bearer)
  • .addRoute(body, id, type, authorization_bearer)
  • .removeInheritance(id, type, inherited, grouptype, authorization_bearer)
  • .inheritFrom(id, type, inherited, grouptype, authorization_bearer)
  • .setDefault(id, type)
  • .delete(id, type, authorization_bearer)
  • .get(id, type, authorization_bearer)
  • .edit(body, id, type, authorization_bearer)
  • .createByName(id, type, authorization_bearer)
  • .create(body, type, authorization_bearer)

GroupType.deletePermission(id, type, permission, authorization_bearer)

deletePermission - Removes a permission/route from a group of a particular type.

Path: api/v1/group/id/:id/type/:type/permission/:permission

Kind: static method of GroupType

Param	Type	Description
id	any	Name of the group (example: anonymous)
type	any	Type of the group (example: group)
permission	any	Name or Route (example: test-one-three-*)
authorization_bearer	string	The client_credentials generated OAUth2 access token.

GroupType.addPermission(id, type, permission, authorization_bearer)

addPermission - Adds a permission to a group of a particular type.

Path: api/v1/group/id/:id/type/:type/insert/permission/:permission

Kind: static method of GroupType

Param	Type	Description
id	any	Name of the group (example: anonymous)
type	any	Type of the group (example: group)
permission	any	Permission (example: test-one-three-*)
authorization_bearer	string	The client_credentials generated OAUth2 access token.

GroupType.addRoute(body, id, type, authorization_bearer)

addRoute - Adds a route to a group of a particular type.

{
    "route": "test/permissions/*", // optional
    "host": null, // optional, defaults to travelling host
    "method": "*", // optional, defaults to '*'
    "remove_from_path": 'test/', // optional 
    "name": "test-permissions-*"  // Required and needs to be unqiue, defaults to method + route seperated by '-' instead of `/`
}

Path: api/v1/group/id/:id/type/:type/insert/route

Kind: static method of GroupType

Param	Type	Description
body	Object
id	any	Name of the group
type	any
authorization_bearer	string	The client_credentials generated OAUth2 access token.

Example
body

{
	"route": "test/permissions/*",
    "host": null, 
    "method": "*", 
    "name": "test-permissions-*"  
}

GroupType.removeInheritance(id, type, inherited, grouptype, authorization_bearer)

removeInheritance - Removes an inheritance from a group of a particular type.

Path: api/v1/group/id/:id/type/:type/remove/inheritance/:inherited/type/:grouptype

Kind: static method of GroupType

Param	Type	Description
id	any	Name of the group (example: test1234)
type	any	The type of the group (example: accounts)
inherited	any	Name of the group to inherit from (example: superadmin)
grouptype	any	The type of the inherited group
authorization_bearer	string	The client_credentials generated OAUth2 access token.

GroupType.inheritFrom(id, type, inherited, grouptype, authorization_bearer)

inheritFrom - Adds an inheritance to a group of a particular type.

Path: api/v1/group/id/:id/type/:type/inherit/from/:inherited/type/:grouptype

Kind: static method of GroupType

Param	Type	Description
id	any	Name of the group (example: group1)
type	any	The type of the group (example: testgroup)
inherited	any	Name of the group to inherit from (example: test123)
grouptype	any	The type of the inherited group
authorization_bearer	string	The client_credentials generated OAUth2 access token.

GroupType.setDefault(id, type)

setDefault - Sets the group of a particular type to be the default group for new users.

Path: api/v1/group/id/:id/type/:type/set/default

Kind: static method of GroupType

Param	Type	Description
id	any	id or name (example: group1)
type	any	The type of the group (example: account)

GroupType.delete(id, type, authorization_bearer)

delete - delete group of a particular type by its name or id

Path: api/v1/group/id/:id/type/:type

Kind: static method of GroupType

Param	Type	Description
id	any	id or name
type	any	The type of the group
authorization_bearer	string	The client_credentials generated OAUth2 access token.

GroupType.get(id, type, authorization_bearer)

get - Get a group by it’s id or name of a particular type.

Path: api/v1/group/id/:id/type/:type

Kind: static method of GroupType

Param	Type	Description
id	any	id or name (example: group1)
type	any	The type of the group (example: accounts)
authorization_bearer	string	The client_credentials generated OAUth2 access token.

GroupType.edit(body, id, type, authorization_bearer)

edit - Edits a group of a particular type

Path: api/v1/group/id/:id/type/:type

Kind: static method of GroupType

Param	Type	Description
body	Object
id	any	id or name
type	any	The type of the group
authorization_bearer	string	The client_credentials generated OAUth2 access token.

Example
body

{"inherited":["a717b880-b17b-4995-9610-cf451a06d015","7ec8c351-7b8a-4ea8-95cc-0d990b225768"]}

GroupType.createByName(id, type, authorization_bearer)

createByName - Add a new blank group with the set name and type

Path: api/v1/group/id/:id/type/:type

Kind: static method of GroupType

Param	Type	Description
id	any	Name of the new group (example: test1234)
type	any	Type of the new group (example: accounts)
authorization_bearer	string	The client_credentials generated OAUth2 access token.

GroupType.create(body, type, authorization_bearer)

create - Add a new group of a particular type

Path: api/v1/group/type/:type

Kind: static method of GroupType

Param	Type	Description
body	Object
type	any	The type of the group
authorization_bearer	string	The client_credentials generated OAUth2 access token.

Example
body

{
    "name": "group1",
    "type": "accounts",
    "allowed": [
        {
            "route": "/test",
            "host": "http://127.0.0.1:1237/",
            "remove_from_path": "test",
            "method": "*",
            "name": "all-test"
        }
    ],
    "is_default": false
}

GroupTypeUsers

Both requests are disabled. Dont use.

Kind: global class

• GroupTypeUsers
  • .inherited(id, type)
  • .count(id, type, filter, limit, skip, authorization_bearer)
  • .get(id, type, filter, limit, skip, sort, sortdir, authorization_bearer)

GroupTypeUsers.inherited(id, type)

inherited - Gets all the users that belong to the group of a particular type by its name or id and all of its inherited groups.

Optional Query Params

Param	Description
id	optional (example: 26c6aeff-ab95-4bdd-8260-534cf92d1c23)
username	optional (example: user7)
locked	optional (example: true)
locked_reason	optional (example: Activation Required email your admin to get your account activated)
group_request	optional (example: superadmin)
failed_login_attempts	optional (example: 0)
change_username	optional (example: false)
change_password	optional (example: false)
reset_password	optional (example: false)
email_verify	optional (example: false)
group_id	optional (example: 7320292c-627e-4e5a-b059-583eabdd6264)
email	optional (example: test@test.ai)
created_on	optional (example: 1568419646794)
last_login	optional (example: null)

Path: api/v1/group/id/:id/type/:type/users/inherited

Kind: static method of GroupTypeUsers

Param	Type	Description
id	any	(example: group4)
type	any	The type of the group (example: groups)

GroupTypeUsers.count(id, type, filter, limit, skip, authorization_bearer)

count - Gets all the users that belong to the group of a particular type by its name or id.

Optional Query Params

*Note: you can only use range operators (<,B >,B >=,B <=) on the following columns: created_on, updated_on, dob.

Param	Description
id	optional (example: 26c6aeff-ab95-4bdd-8260-534cf92d1c23)
username	optional (example: user7)
locked	optional (example: true)
locked_reason	optional (example: Activation Required email your admin to get your account activated)
group_request	optional (example: superadmin)
failed_login_attempts	optional (example: 0)
change_username	optional (example: false)
change_password	optional (example: false)
reset_password	optional (example: false)
email_verify	optional (example: false)
group_id	optional (example: 7320292c-627e-4e5a-b059-583eabdd6264)
email	optional (example: test@test.ai)
created_on	optional (example: 1568419646794)
last_login	optional (example: null)

Path: api/v1/group/id/:id/type/:type/users/count

Kind: static method of GroupTypeUsers

Param	Type	Description
id	any	Group name or ID. (example: superadmin)
type	any	Group type. (example: group)
filter	any	Filter parameters (example: locked=false,created_on>2021-06-03,created_on<2021-06-06) (example: locked=false,created_on>2021-06-03,created_on<2021-06-06)
limit	any	Number of maximum results. (example: 10) (example: 10)
skip	any	Number of db rows skipped. (example: 2) (example: 2)
authorization_bearer	string	The client_credentials generated OAUth2 access token.

GroupTypeUsers.get(id, type, filter, limit, skip, sort, sortdir, authorization_bearer)

get - Gets all the users that belong to the group of a particular type by its name or id.

Optional Query Params

*Note: you can only use range operators (<,B >,B >=,B <=) on the following columns: created_on, updated_on, dob.

Param	Description
id	optional (example: 26c6aeff-ab95-4bdd-8260-534cf92d1c23)
username	optional (example: user7)
locked	optional (example: true)
locked_reason	optional (example: Activation Required email your admin to get your account activated)
group_request	optional (example: superadmin)
failed_login_attempts	optional (example: 0)
change_username	optional (example: false)
change_password	optional (example: false)
reset_password	optional (example: false)
email_verify	optional (example: false)
group_id	optional (example: 7320292c-627e-4e5a-b059-583eabdd6264)
email	optional (example: test@test.ai)
created_on	optional (example: 1568419646794)
last_login	optional (example: null)

Path: api/v1/group/id/:id/type/:type/users

Kind: static method of GroupTypeUsers

Param	Type	Description
id	any	Group name or ID. (example: superadmin)
type	any	Group type. (example: group)
filter	any	Filter parameters (example: locked=false,created_on>2021-06-03,created_on<2021-06-06) (example: locked=false,created_on>2021-06-03,created_on<2021-06-06)
limit	any	Number of maximum results. (example: 10) (example: 10)
skip	any	Number of db rows skipped. (example: 2) (example: 2)
sort	any	Sort by any user object key (examples: id, domain, locked, etc.) (example: created_on)
sortdir	any	Sort direction (example ascending order: ASC) (example: ASC)
authorization_bearer	string	The client_credentials generated OAUth2 access token.

GroupTypeUser

Kind: global class

• GroupTypeUser
  • .delete(type, id, authorization_bearer)
  • .removeGroupInheritance(type, id, inheritgroupid, inheritgrouptype, authorization_bearer)
  • .addGroupInheritance(type, id, inheritgroupid, inheritgrouptype, authorization_bearer)
  • .editPropertyValue(type, id, property, value, authorization_bearer)
  • .editProperty(body, type, id, property, authorization_bearer)
  • .edit(body, type, id, authorization_bearer)
  • .getProperty(type, id, property, authorization_bearer)
  • .get(type, id, authorization_bearer)

GroupTypeUser.delete(type, id, authorization_bearer)

delete - Delete a user by it’s id or username from group of a particular type.

Path: api/v1/group/type/:type/user/:id

Kind: static method of GroupTypeUser

Param	Type	Description
type	any	The type of the group (example: accounts)
id	any	id or name (example: user7)
authorization_bearer	string	The client_credentials generated OAUth2 access token.

GroupTypeUser.removeGroupInheritance(type, id, inheritgroupid, inheritgrouptype, authorization_bearer)

removeGroupInheritance - Remove a user to a group of a particular type of group.

Path: api/v1/group/type/:type/user/:id/inheritance/group/:inheritgroupid/type/:inheritgrouptype

Kind: static method of GroupTypeUser

Param	Type	Description
type	any	type of group (example: group)
id	any	id or name of the user (example: user5)
inheritgroupid	any	id or name of the group to inherit (example: group2)
inheritgrouptype	any	type of the group to inherit (example: group)
authorization_bearer	string	The client_credentials generated OAUth2 access token.

GroupTypeUser.addGroupInheritance(type, id, inheritgroupid, inheritgrouptype, authorization_bearer)

addGroupInheritance - Add a user to a group of a particular type of group.

Path: api/v1/group/type/:type/user/:id/inheritance/group/:inheritgroupid/type/:inheritgrouptype

Kind: static method of GroupTypeUser

Param	Type	Description
type	any	type of group (example: group)
id	any	id or name of the user (example: user5)
inheritgroupid	any	id or name of the group to inherit (example: group2)
inheritgrouptype	any	type of the group to inherit (example: group)
authorization_bearer	string	The client_credentials generated OAUth2 access token.

GroupTypeUser.editPropertyValue(type, id, property, value, authorization_bearer)

editPropertyValue - Edit a current user’s property data as a path param from a group of a particular type.

Path: api/v1/group/type/:type/user/:id/property/:property/:value

Kind: static method of GroupTypeUser

Param	Type	Description
type	any	The type of the group (example: group)
id	any	id or name (example: user5)
property	any	(example: email)
value	any	(example: swag@yolo.com)
authorization_bearer	string	The client_credentials generated OAUth2 access token.

GroupTypeUser.editProperty(body, type, id, property, authorization_bearer)

editProperty - Edit a user’s property by it’s id or username from a group of a particular type.

Path: api/v1/group/type/:type/user/:id/property/:property

Kind: static method of GroupTypeUser

Param	Type	Description
body	Object
type	any	The type of the group (example: accounts)
id	any	id or name (example: user6)
property	any	(example: email)
authorization_bearer	string	The client_credentials generated OAUth2 access token.

Example
body

{
	"locked": false
}

GroupTypeUser.edit(body, type, id, authorization_bearer)

edit - Edit a user by it’s id or username from group of a particular type.

Path: api/v1/group/type/:type/user/:id

Kind: static method of GroupTypeUser

Param	Type	Description
body	Object
type	any	The type of the group (example: accounts)
id	any	id or name (example: user6)
authorization_bearer	string	The client_credentials generated OAUth2 access token.

Example
body

{
	"locked": false
}

GroupTypeUser.getProperty(type, id, property, authorization_bearer)

getProperty - Get a user’s property by it’s id or username from group of a particular type.

Path: api/v1/group/type/:type/user/:id/property/:property

Kind: static method of GroupTypeUser

Param	Type	Description
type	any	The type of the group (example: accounts)
id	any	id or name (example: user6)
property	any	(example: email)
authorization_bearer	string	The client_credentials generated OAUth2 access token.

GroupTypeUser.get(type, id, authorization_bearer)

get - Get a user by it’s id or username from group of a particular type.

Path: api/v1/group/type/:type/user/:id

Kind: static method of GroupTypeUser

Param	Type	Description
type	any	The type of the group (example: accounts)
id	any	id or name (example: user6)
authorization_bearer	string	The client_credentials generated OAUth2 access token.

GroupRequest

Kind: global class

GroupRequestUser

Kind: global class

• GroupRequestUser
  • .delete(body, type, id, authorization_bearer)
  • .addGroupInheritance(type, id, inheritgroupid, inheritgrouptype, authorization_bearer)
  • .editProperty(body, type, id, property, authorization_bearer)
  • .edit(body, type, id, authorization_bearer)

GroupRequestUser.delete(body, type, id, authorization_bearer)

delete - Delete a user by it’s id or username from the user’s group_request of a particular type.

Path: api/v1/group/request/type/:type/user/:id

Kind: static method of GroupRequestUser

Param	Type	Description
body	Object
type	any	(example: testgroup)
id	any	(example: user69)
authorization_bearer	string	The client_credentials generated OAUth2 access token.

Example
body

{
	"locked": false
}

GroupRequestUser.addGroupInheritance(type, id, inheritgroupid, inheritgrouptype, authorization_bearer)

addGroupInheritance - Add a user to a group from the user’s group_request of a particular type.

Path: api/v1/group/request/type/:type/user/:id/inheritance/group/:inheritgroupid/type/:inheritgrouptype

Kind: static method of GroupRequestUser

Param	Type	Description
type	any	type of group (example: group)
id	any	id or name of the user (example: user5)
inheritgroupid	any	id or name of the group to inherit (example: group2)
inheritgrouptype	any	type of the group to inherit (example: group)
authorization_bearer	string	The client_credentials generated OAUth2 access token.

GroupRequestUser.editProperty(body, type, id, property, authorization_bearer)

editProperty - Edit a user’s property by it’s id or username from the user’s group_request of a particular type.

Path: api/v1/group/request/type/:type/user/:id/property/:property

Kind: static method of GroupRequestUser

Param	Type	Description
body	Object
type	any	(example: accounts)
id	any	(example: user6)
property	any	(example: email)
authorization_bearer	string	The client_credentials generated OAUth2 access token.

Example
body

"chad@yolo.com"

GroupRequestUser.edit(body, type, id, authorization_bearer)

edit - Edit a user by it’s id or username from the user’s group_request of a particular type.

Path: api/v1/group/request/type/:type/user/:id

Kind: static method of GroupRequestUser

Param	Type	Description
body	Object
type	any	(example: accounts)
id	any	(example: user6)
authorization_bearer	string	The client_credentials generated OAUth2 access token.

Example
body

{
	"locked": false
}

Users

Kind: global class

• Users
  • .byGroupRequest(group_request, authorization_bearer)
  • .count(limit, skip, filter, ids, authorization_bearer)
  • .get(sort, limit, skip, filter, sortdir, ids, params, authorization_bearer)

Users.byGroupRequest(group_request, authorization_bearer)

byGroupRequest - Gets all the users that have the specified group request

Optional Query Params

Param	Description
id	optional (example: 26c6aeff-ab95-4bdd-8260-534cf92d1c23)
username	optional (example: user7)
locked	optional (example: true)
locked_reason	optional (example: Activation Required email your admin to get your account activated)
group_request	optional (example: superadmin)
failed_login_attempts	optional (example: 0)
change_username	optional (example: false)
change_password	optional (example: false)
reset_password	optional (example: false)
email_verify	optional (example: false)
group_id	optional (example: 7320292c-627e-4e5a-b059-583eabdd6264)
email	optional (example: test@test.ai)
created_on	optional (example: 1568419646794)
last_login	optional (example: null)

Path: api/v1/users/group/request/:group_request

Kind: static method of Users

Param	Type	Description
group_request	any	name of the group (example: superadmin)
authorization_bearer	string	The client_credentials generated OAUth2 access token.

Users.count(limit, skip, filter, ids, authorization_bearer)

count - Gets all the users

Optional Query Params

*Note: you can only use range operators (<,B >,B >=,B <=) on the following columns: created_on, updated_on, dob.

Param	Description
id	optional (example: 26c6aeff-ab95-4bdd-8260-534cf92d1c23)
username	optional (example: user7)
locked	optional (example: true)
locked_reason	optional (example: Activation Required email your admin to get your account activated)
group_request	optional (example: superadmin)
failed_login_attempts	optional (example: 0)
change_username	optional (example: false)
change_password	optional (example: false)
reset_password	optional (example: false)
email_verify	optional (example: false)
group_id	optional (example: 7320292c-627e-4e5a-b059-583eabdd6264)
email	optional (example: test@test.ai)
created_on	optional (example: 1568419646794)
last_login	optional (example: null)

Path: api/v1/users/count

Kind: static method of Users

Param	Type	Description
limit	any	Number of maximum results. (example: 2) (example: 2)
skip	any	Number of db rows skipped. (example: 10) (example: 10)
filter	any	Filter parameters (example: locked=false,created_on>2021-06-03,created_on<2021-06-06) (example: created_on>2021-06-06,created_on<2021-06-08)
ids	any	Comma seperated id values used in inclusion query (example: d0323874-9b24-4bc5-ae38-fb8808c4e453,08c4c17f-317b-4be8-bfbd-451a274a3f7f)
authorization_bearer	string	The client_credentials generated OAUth2 access token.

Users.get(sort, limit, skip, filter, sortdir, ids, params, authorization_bearer)

get - Gets all the users

Filter Params

*Note: you can only use range operators (<, >, >=, <=) on the following columns: created_on, updated_on, dob.

Param	Description
id	optional (example: 26c6aeff-ab95-4bdd-8260-534cf92d1c23)
username	optional (example: user7)
locked	optional (example: true)
locked_reason	optional (example: Activation Required email your admin to get your account activated)
group_request	optional (example: superadmin)
failed_login_attempts	optional (example: 0)
change_username	optional (example: false)
change_password	optional (example: false)
reset_password	optional (example: false)
email_verify	optional (example: false)
group_id	optional (example: 7320292c-627e-4e5a-b059-583eabdd6264)
email	optional (example: test@test.ai)
created_on	optional (example: 1568419646794)
last_login	optional (example: null)

Path: api/v1/users

Kind: static method of Users

Param	Type	Description
sort	any	Sort by any user object key (examples: id, domain, locked, etc.) (example: created_on)
limit	any	Number of maximum results. (example: 2) (example: 2)
skip	any	Number of db rows skipped. (example: 10) (example: 10)
filter	any	Filter parameters (example: locked=false,created_on>2021-06-03,created_on<2021-06-06) (example: locked=false,created_on>2021-06-03,created_on<2021-06-06)
sortdir	any	Sort direction (example ascending order: ASC) (example: ASC)
ids	any	Comma seperated id values used in inclusion query (example: d0323874-9b24-4bc5-ae38-fb8808c4e453,08c4c17f-317b-4be8-bfbd-451a274a3f7f)
params	any	(example: id)
authorization_bearer	string	The client_credentials generated OAUth2 access token.

UsersDomain

Kind: global class

• UsersDomain
  • .count(domain, limit, skip, filter, ids, authorization_bearer)
  • .get(domain, sort, limit, skip, filter, sortdir, ids, params, authorization_bearer)

UsersDomain.count(domain, limit, skip, filter, ids, authorization_bearer)

count - Gets all the users

Optional Query Params

*Note: you can only use range operators (<,B >,B >=,B <=) on the following columns: created_on, updated_on, dob.

Param	Description
id	optional (example: 26c6aeff-ab95-4bdd-8260-534cf92d1c23)
username	optional (example: user7)
locked	optional (example: true)
locked_reason	optional (example: Activation Required email your admin to get your account activated)
group_request	optional (example: superadmin)
failed_login_attempts	optional (example: 0)
change_username	optional (example: false)
change_password	optional (example: false)
reset_password	optional (example: false)
email_verify	optional (example: false)
group_id	optional (example: 7320292c-627e-4e5a-b059-583eabdd6264)
email	optional (example: test@test.ai)
created_on	optional (example: 1568419646794)
last_login	optional (example: null)

Path: api/v1/users/domain/:domain/count

Kind: static method of UsersDomain

Param	Type	Description
domain	any	(example: dragohm.com)
limit	any	Number of maximum results. (example: 2) (example: 5)
skip	any	Number of db rows skipped. (example: 10) (example: 10)
filter	any	Filter parameters (example: locked=false,created_on>2021-06-03,created_on<2021-06-06) (example: created_on>2022-06-01,created_on<2022-06-08)
ids	any	Comma seperated id values used in inclusion query (example: d0323874-9b24-4bc5-ae38-fb8808c4e453,08c4c17f-317b-4be8-bfbd-451a274a3f7f)
authorization_bearer	string	The client_credentials generated OAUth2 access token.

UsersDomain.get(domain, sort, limit, skip, filter, sortdir, ids, params, authorization_bearer)

get - Gets all the users

Filter Params

*Note: you can only use range operators (<,B >,B >=,B <=) on the following columns: created_on, updated_on, dob.

Param	Description
id	optional (example: 26c6aeff-ab95-4bdd-8260-534cf92d1c23)
username	optional (example: user7)
locked	optional (example: true)
locked_reason	optional (example: Activation Required email your admin to get your account activated)
group_request	optional (example: superadmin)
failed_login_attempts	optional (example: 0)
change_username	optional (example: false)
change_password	optional (example: false)
reset_password	optional (example: false)
email_verify	optional (example: false)
group_id	optional (example: 7320292c-627e-4e5a-b059-583eabdd6264)
email	optional (example: test@test.ai)
created_on	optional (example: 1568419646794)
last_login	optional (example: null)

Path: api/v1/users/domain/:domain

Kind: static method of UsersDomain

Param	Type	Description
domain	any	(example: dragohm.com)
sort	any	Sort by any user object key (examples: id, domain, locked, etc.) (example: created_on)
limit	any	Number of maximum results. (example: 2) (example: 1)
skip	any	Number of db rows skipped. (example: 10) (example: 10)
filter	any	Filter parameters (example: locked=false,created_on>2021-06-03,created_on<2021-06-06) (example: created_on>2021-06-01,created_on<2021-06-08)
sortdir	any	Sort direction (example ascending order: ASC) (example: ASC)
ids	any	Comma seperated id values used in inclusion query (example: d0323874-9b24-4bc5-ae38-fb8808c4e453,08c4c17f-317b-4be8-bfbd-451a274a3f7f)
params	any	(example: id,created_on)
authorization_bearer	string	The client_credentials generated OAUth2 access token.

User

Kind: global class

• User
  • .delete(id, authorization_bearer)
  • .removeGroupInheritance(id, inheritgroupid, inheritgrouptype, authorization_bearer)
  • .addGroupInheritance(id, inheritgroupid, inheritgrouptype, authorization_bearer)
  • .editUserDataPropertyValue(id, property, value, authorization_bearer)
  • .editPropertyValue(id, property, value, authorization_bearer)
  • .editUserDataProperty(body, id, property, authorization_bearer)
  • .editProperty(body, id, property, authorization_bearer)
  • .edit(body, id, authorization_bearer)
  • .getProperty(id, property, authorization_bearer)
  • .get(id, authorization_bearer)

User.delete(id, authorization_bearer)

delete - Delete a user by it’s Id.

Path: api/v1/user/id/:id

Kind: static method of User

Param	Type	Description
id	any	Id or Username (example: 39A2BC37-61AE-434C-B245-A731A27CF8DA)
authorization_bearer	string	The client_credentials generated OAUth2 access token.

User.removeGroupInheritance(id, inheritgroupid, inheritgrouptype, authorization_bearer)

removeGroupInheritance - Remove a user from a group.

Path: api/v1/user/id/:id/inheritance/group/:inheritgroupid/type/:inheritgrouptype

Kind: static method of User

Param	Type	Description
id	any	id or name of the user (example: 99a64193-b5a8-448d-8933-05d27f366094)
inheritgroupid	any	id or name of the group to inherit (example: group)
inheritgrouptype	any	type of the group to inherit (example: testgroup)
authorization_bearer	string	The client_credentials generated OAUth2 access token.

User.addGroupInheritance(id, inheritgroupid, inheritgrouptype, authorization_bearer)

addGroupInheritance - Add a user to a group.

Path: api/v1/user/id/:id/inheritance/group/:inheritgroupid/type/:inheritgrouptype

Kind: static method of User

Param	Type	Description
id	any	id or name of the user (example: 99a64193-b5a8-448d-8933-05d27f366094)
inheritgroupid	any	id or name of the group to inherit (example: group1)
inheritgrouptype	any	type of the group to inherit (example: testgroup)
authorization_bearer	string	The client_credentials generated OAUth2 access token.

User.editUserDataPropertyValue(id, property, value, authorization_bearer)

editUserDataPropertyValue - Edit a current user’s property data as a path param.

Path: api/v1/user/id/:id/property/userdata/:property/:value

Kind: static method of User

Param	Type	Description
id	any	Id or Username (example: 595d3f9a-5383-4da9-a465-b975d8a5e28e)
property	any	user_data object’s property to edit. (example: notes)
value	any	user_data object’s property value. (example: asdfa sdfa sdf)
authorization_bearer	string	The client_credentials generated OAUth2 access token.

User.editPropertyValue(id, property, value, authorization_bearer)

editPropertyValue - Edit a current user’s property data as a path param.

Path: api/v1/user/id/:id/property/:property/:value

Kind: static method of User

Param	Type	Description
id	any	Id or Username
property	any	(example: group_id)
value	any	(example: 595d3f9a-5383-4da9-a465-b975d8a5e28e)
authorization_bearer	string	The client_credentials generated OAUth2 access token.

User.editUserDataProperty(body, id, property, authorization_bearer)

editUserDataProperty - Edit a user’s property by id.

Path: api/v1/user/id/:id/property/userdata/:property

Kind: static method of User

Param	Type	Description
body	Object
id	any	Id or Username (example: 39A2BC37-61AE-434C-B245-A731A27CF8DA)
property	any	user_data object’s property to edit. (example: notes)
authorization_bearer	string	The client_credentials generated OAUth2 access token.

Example
body

asdfasdf

User.editProperty(body, id, property, authorization_bearer)

editProperty - Edit a user’s property by id.

Path: api/v1/user/id/:id/property/:property

Kind: static method of User

Param	Type	Description
body	Object
id	any	Id or Username (example: 39A2BC37-61AE-434C-B245-A731A27CF8DA)
property	any
authorization_bearer	string	The client_credentials generated OAUth2 access token.

Example
body

user6

User.edit(body, id, authorization_bearer)

edit - Edit a user’s by id.

Path: api/v1/user/id/:id

Kind: static method of User

Param	Type	Description
body	Object
id	any	Id or Username (example: 39A2BC37-61AE-434C-B245-A731A27CF8DA)
authorization_bearer	string	The client_credentials generated OAUth2 access token.

Example
body

{
	"username" : "user6",
	"password" : "Awickednewawesomepasword4242!@"
}

User.getProperty(id, property, authorization_bearer)

getProperty - Get a user’s property by it’s id.

Path: api/v1/user/id/:id/property/:property

Kind: static method of User

Param	Type	Description
id	any	Id or Username (example: 39A2BC37-61AE-434C-B245-A731A27CF8DA)
property	any
authorization_bearer	string	The client_credentials generated OAUth2 access token.

User.get(id, authorization_bearer)

get - Get a user by it’s id.

Path: api/v1/user/id/:id

Kind: static method of User

Param	Type	Description
id	any	(example: 39A2BC37-61AE-434C-B245-A731A27CF8DA)
authorization_bearer	string	The client_credentials generated OAUth2 access token.

UserDomain

Kind: global class

• UserDomain
  • .delete(domain, id, authorization_bearer)
  • .removeGroupInheritance(domain, id, inheritgroupid, inheritgrouptype, authorization_bearer)
  • .addGroupInheritance(domain, id, inheritgroupid, inheritgrouptype, authorization_bearer)
  • .editUserDataPropertyValue(domain, id, property, value, authorization_bearer)
  • .editPropertyValue(domain, id, property, value, authorization_bearer)
  • .editUserDataProperty(body, domain, id, property, authorization_bearer)
  • .editProperty(body, domain, id, property, authorization_bearer)
  • .edit(body, domain, id, authorization_bearer)
  • .getProperty(domain, id, property, authorization_bearer)
  • .get(domain, id, authorization_bearer)

UserDomain.delete(domain, id, authorization_bearer)

delete - Delete a user by it’s Id.

Path: api/v1/user/domain/:domain/id/:id

Kind: static method of UserDomain

Param	Type	Description
domain	any	Domain (example: test.com) (example: test.com)
id	any	id, username or email. (example: 75d2ed5e-bc5b-4129-a1ec-657cf27e6294)
authorization_bearer	string	The client_credentials generated OAUth2 access token.

UserDomain.removeGroupInheritance(domain, id, inheritgroupid, inheritgrouptype, authorization_bearer)

removeGroupInheritance - Remove a user from a group.

Path: api/v1/user/domain/:domain/id/:id/inheritance/group/:inheritgroupid/type/:inheritgrouptype

Kind: static method of UserDomain

Param	Type	Description
domain	any	Domain (example: test.com) (example: test.com)
id	any	id, username or email. (example: d1bf9986-9938-4d47-b8aa-79184b37cc16)
inheritgroupid	any	id or name of the group to inherit (example: group1)
inheritgrouptype	any	type of the group to inherit (example: testgroup)
authorization_bearer	string	The client_credentials generated OAUth2 access token.

UserDomain.addGroupInheritance(domain, id, inheritgroupid, inheritgrouptype, authorization_bearer)

addGroupInheritance - Add a user to a group.

Path: api/v1/user/domain/:domain/id/:id/inheritance/group/:inheritgroupid/type/:inheritgrouptype

Kind: static method of UserDomain

Param	Type	Description
domain	any	Domain (example: test.com) (example: test.com)
id	any	id, username or email. (example: user5)
inheritgroupid	any	id or name of the group to inherit (example: group2)
inheritgrouptype	any	type of the group to inherit (example: group)
authorization_bearer	string	The client_credentials generated OAUth2 access token.

UserDomain.editUserDataPropertyValue(domain, id, property, value, authorization_bearer)

editUserDataPropertyValue - Edit a current user’s property data as a path param.

Path: api/v1/user/domain/:domain/id/:id/property/userdata/:property/:value

Kind: static method of UserDomain

Param	Type	Description
domain	any	Domain (example: test.com) (example: test.com)
id	any	id, username or email. (example: 75d2ed5e-bc5b-4129-a1ec-657cf27e6294)
property	any	Property to modify (example: locked) (example: notes)
value	any	Value to change property to. (example: asdf asdfawsdf)
authorization_bearer	string	The client_credentials generated OAUth2 access token.

UserDomain.editPropertyValue(domain, id, property, value, authorization_bearer)

editPropertyValue - Edit a current user’s property data as a path param.

Path: api/v1/user/domain/:domain/id/:id/property/:property/:value

Kind: static method of UserDomain

Param	Type	Description
domain	any	Domain (example: test.com) (example: test.com)
id	any	id, username or email. (example: 75d2ed5e-bc5b-4129-a1ec-657cf27e6294)
property	any	Property to modify (example: locked) (example: locked)
value	any	Value to change property to. (example: true)
authorization_bearer	string	The client_credentials generated OAUth2 access token.

UserDomain.editUserDataProperty(body, domain, id, property, authorization_bearer)

editUserDataProperty - Edit a user’s property by id.

Path: api/v1/user/domain/:domain/id/:id/property/userdata/:property

Kind: static method of UserDomain

Param	Type	Description
body	Object
domain	any	Domain (example: test.com) (example: test.com)
id	any	id, username or email. (example: 75d2ed5e-bc5b-4129-a1ec-657cf27e6294)
property	any	Property to modify (example: locked) (example: notes)
authorization_bearer	string	The client_credentials generated OAUth2 access token.

Example
body

asdfasdf asdf

UserDomain.editProperty(body, domain, id, property, authorization_bearer)

editProperty - Edit a user’s property by id.

Path: api/v1/user/domain/:domain/id/:id/property/:property

Kind: static method of UserDomain

Param	Type	Description
body	Object
domain	any	Domain (example: test.com) (example: test.com)
id	any	id, username or email. (example: 75d2ed5e-bc5b-4129-a1ec-657cf27e6294)
property	any	Property to modify (example: locked) (example: locked)
authorization_bearer	string	The client_credentials generated OAUth2 access token.

Example
body

false

UserDomain.edit(body, domain, id, authorization_bearer)

edit - Edit a user’s by id.

Path: api/v1/user/domain/:domain/id/:id

Kind: static method of UserDomain

Param	Type	Description
body	Object
domain	any	Domain (example: test.com) (example: test.com)
id	any	id, username or email. (example: 75d2ed5e-bc5b-4129-a1ec-657cf27e6294)
authorization_bearer	string	The client_credentials generated OAUth2 access token.

Example
body

{
	"username" : "user6",
	"password" : "Awickednewawesomepasword4242!@"
}

UserDomain.getProperty(domain, id, property, authorization_bearer)

getProperty - Get a user’s property by it’s id.

Path: api/v1/user/domain/:domain/id/:id/property/:property

Kind: static method of UserDomain

Param	Type	Description
domain	any	Domain (example: test.com) (example: test.com)
id	any	id, username or email. (example: 75d2ed5e-bc5b-4129-a1ec-657cf27e6294)
property	any	Property to get (example: locked) (example: locked)
authorization_bearer	string	The client_credentials generated OAUth2 access token.

UserDomain.get(domain, id, authorization_bearer)

get - Get a user by it’s id.

Path: api/v1/user/domain/:domain/id/:id

Kind: static method of UserDomain

Param	Type	Description
domain	any	Domain (example: test.com) (example: test.com)
id	any	id, username or email. (example: d1bf9986-9938-4d47-b8aa-79184b37cc16)
authorization_bearer	string	The client_credentials generated OAUth2 access token.

UserCurrent

Kind: global class

• UserCurrent
  • .registerToken(body, authorization_bearer)
  • .removeGroupInheritance(inheritgroupid, inheritgrouptype, authorization_bearer)
  • .addGroupInheritance(inheritgroupid, inheritgrouptype, authorization_bearer)
  • .editUserDataPropertyValue(property, value, authorization_bearer)
  • .editPropertyValue(property, value, authorization_bearer)
  • .editUserDataProperty(body, property, authorization_bearer)
  • .editProperty(body, property, authorization_bearer)
  • .deleteToken(id, authorization_bearer)
  • .edit(body, authorization_bearer)
  • .getProperty(property, authorization_bearer)
  • .routesCheck(body, authorization_bearer)
  • .routeCheck(method, route, authorization_bearer)
  • .permissionCheck(permission, authorization_bearer)
  • .get(authorization_bearer)

UserCurrent.registerToken(body, authorization_bearer)

registerToken - Registers a new credentials service for client_credentials based access token auth.

Path: api/v1/user/me/token

Kind: static method of UserCurrent

Param	Type	Description
body	Object
authorization_bearer	string	The client_credentials generated OAUth2 access token.

Example
body

{
    "urls": [
        "http://127.0.0.1",
        "http://dragohm.com"
    ]
}

UserCurrent.removeGroupInheritance(inheritgroupid, inheritgrouptype, authorization_bearer)

removeGroupInheritance - Remove a user from a group.

Path: api/v1/user/me/inheritance/group/:inheritgroupid/type/:inheritgrouptype

Kind: static method of UserCurrent

Param	Type	Description
inheritgroupid	any	id or name of the group to inherit (example: group2)
inheritgrouptype	any	type of the group to inherit (example: group)
authorization_bearer	string	The client_credentials generated OAUth2 access token.

UserCurrent.addGroupInheritance(inheritgroupid, inheritgrouptype, authorization_bearer)

addGroupInheritance - Add a user to a group.

Path: api/v1/user/me/inheritance/group/:inheritgroupid/type/:inheritgrouptype

Kind: static method of UserCurrent

Param	Type	Description
inheritgroupid	any	id or name of the group to inherit (example: group2)
inheritgrouptype	any	type of the group to inherit (example: group)
authorization_bearer	string	The client_credentials generated OAUth2 access token.

UserCurrent.editUserDataPropertyValue(property, value, authorization_bearer)

editUserDataPropertyValue - Edit a current user’s property data as a path param.

Path: api/v1/user/me/property/userdata/:property/:value

Kind: static method of UserCurrent

Param	Type	Description
property	any	user_data object’s property to edit. (example: notes)
value	any	user_data object’s property value. (example: asdf asdfasdf asdf )
authorization_bearer	string	The client_credentials generated OAUth2 access token.

UserCurrent.editPropertyValue(property, value, authorization_bearer)

editPropertyValue - Edit a current user’s property data as a path param.

Path: api/v1/user/me/property/:property/:value

Kind: static method of UserCurrent

Param	Type	Description
property	any	(example: group_id)
value	any	(example: 595d3f9a-5383-4da9-a465-b975d8a5e28e)
authorization_bearer	string	The client_credentials generated OAUth2 access token.

UserCurrent.editUserDataProperty(body, property, authorization_bearer)

editUserDataProperty - Edit a current user’s property data.

Path: api/v1/user/me/property/userdata/:property

Kind: static method of UserCurrent

Param	Type	Description
body	Object
property	any	user_data object’s property to edit. (example: notes)
authorization_bearer	string	The client_credentials generated OAUth2 access token.

Example
body

asdfsasdfdsadf

UserCurrent.editProperty(body, property, authorization_bearer)

editProperty - Edit a current user’s property data.

Path: api/v1/user/me/property/:property

Kind: static method of UserCurrent

Param	Type	Description
body	Object
property	any	(example: password)
authorization_bearer	string	The client_credentials generated OAUth2 access token.

Example
body

newpasss

UserCurrent.deleteToken(id, authorization_bearer)

deleteToken - Deletes a client_credentials based access token auth.

Path: api/v1/user/me/token/:id

Kind: static method of UserCurrent

Param	Type	Description
id	any	id or name of the token (example: 74b3c2f2-3f94-4b5d-b3e2-4b3bd2c5d6fe)
authorization_bearer	string	The client_credentials generated OAUth2 access token.

UserCurrent.edit(body, authorization_bearer)

edit - Updates the current logged in user.

Path: api/v1/user/me

Kind: static method of UserCurrent

Param	Type	Description
body	Object
authorization_bearer	string	The client_credentials generated OAUth2 access token.

Example
body

{
    "username": "user6",
    "password": "Awickednewawesomepasword4242!@"
}

UserCurrent.getProperty(property, authorization_bearer)

getProperty - Gets the currently logged in user’s single property

Path: api/v1/user/me/property/:property

Kind: static method of UserCurrent

Param	Type	Description
property	any	(example: username)
authorization_bearer	string	The client_credentials generated OAUth2 access token.

UserCurrent.routesCheck(body, authorization_bearer)

routesCheck - Checks if current logged in user can access the routes specified within the body array.

Path: api/v1/user/me/routes/allowed

Kind: static method of UserCurrent

Param	Type	Description
body	Object
authorization_bearer	string	The client_credentials generated OAUth2 access token.

Example
body

[
    {
        "method": "GET",
        "route": "/account/api/user/me"
    },
    {
        "route": "/t/api/user/me/asdf"
    },
        {
        "method": "*",
        "route": "/account/api/user/me"
    }
]

UserCurrent.routeCheck(method, route, authorization_bearer)

routeCheck - Checks if current logged in user can access the route with method.

Path: api/v1/user/me/route/allowed

Kind: static method of UserCurrent

Param	Type	Description
method	any	(example: get)
route	any	(example: /travelling/api/v1/group/request/type/anonymous/user/)
authorization_bearer	string	The client_credentials generated OAUth2 access token.

UserCurrent.permissionCheck(permission, authorization_bearer)

permissionCheck - Checks to see if the current user can access content based on permission.

Path: api/v1/user/me/permission/allowed/:permission

Kind: static method of UserCurrent

Param	Type	Description
permission	any	name of the route/permission (example: get-travelling)
authorization_bearer	string	The client_credentials generated OAUth2 access token.

UserCurrent.get(authorization_bearer)

get - Gets the currently logged in user

Path: api/v1/user/me

Kind: static method of UserCurrent

Param	Type	Description
authorization_bearer	string	The client_credentials generated OAUth2 access token.

Auth

Auth endpoints

Kind: global class

• Auth
  • .accessToken()
  • .authorize(client_id, response_type, state, redirect_uri, group_request)
  • .activate(token, authorization_bearer)
  • .resetPasswordAutoLogin(body, token, authorization_bearer)
  • .resetPassword(body, token, authorization_bearer)
  • .forgotPassword(body, authorization_bearer)
  • .logout(authorization_bearer)
  • .loginOtp(token, authorization_bearer)
  • .login(body, authorization_bearer)
  • .register(body, randomPassword, authorization_bearer)

Auth.accessToken()

accessToken - Oauth2 client_credentials access token flow. Body must be application/x-www-form-urlencoded and must contain the grant_type. client_id & client_secret will be sent in a Basic Authorization header as base64(client_id:client_secret)

Path: api/v1/auth/token

Kind: static method of Auth

Auth.authorize(client_id, response_type, state, redirect_uri, group_request)

authorize - Authorization Code Grant

Path: api/v1/auth/oauth/authorize

Kind: static method of Auth

Param	Type
client_id	any
response_type	any
state	any
redirect_uri	any
group_request	any

Auth.activate(token, authorization_bearer)

activate - Activates and unlocks user

Path: api/v1/auth/activate

Kind: static method of Auth

Param	Type	Description
token	any	(example: activation_token)
authorization_bearer	string	The client_credentials generated OAUth2 access token.

Auth.resetPasswordAutoLogin(body, token, authorization_bearer)

resetPasswordAutoLogin - Resets the password if the recovery token is valid of the user, then authenticates the user and returns cookies.

Path: api/v1/auth/password/reset/login

Kind: static method of Auth

Param	Type	Description
body	Object
token	any	(example: [thegeneratedtoken])
authorization_bearer	string	The client_credentials generated OAUth2 access token.

Example
body

{
	"password":"asdf"
}

Auth.resetPassword(body, token, authorization_bearer)

resetPassword - Resets the password if the recovery token is valid of the user.

Path: api/v1/auth/password/reset

Kind: static method of Auth

Param	Type	Description
body	Object
token	any	(example: [thegeneratedtoken])
authorization_bearer	string	The client_credentials generated OAUth2 access token.

Example
body

{
	"password":"asdf"
}

Auth.forgotPassword(body, authorization_bearer)

forgotPassword - Generates a recovery token and sends a email to the attached user (if they exist)

Path: api/v1/auth/password/forgot

Kind: static method of Auth

Param	Type	Description
body	Object
authorization_bearer	string	The client_credentials generated OAUth2 access token.

Example
body

{
	"email": "test@test.com"
}

Auth.logout(authorization_bearer)

logout -

Path: api/v1/auth/logout

Kind: static method of Auth

Param	Type	Description
authorization_bearer	string	The client_credentials generated OAUth2 access token.

Auth.loginOtp(token, authorization_bearer)

loginOtp - Login via an OTP

Path: api/v1/auth/login/otp

Kind: static method of Auth

Param	Type	Description
token	any	(example: JQHGH9QuIIhpGuFBG920TdnWkSECFp-ONP0NadfPCclsX708wYaXKHFb5nUj1fmZFHcN1KpKqzkOkjfZGYdfsIt0KnWV69mmt5Uqpw3HiMYD1mBfr4SQap2cg8vH78bb	6Rzt6ubKWXJKY6Pg4GAePg==)
authorization_bearer	string	The client_credentials generated OAUth2 access token.

Auth.login(body, authorization_bearer)

login - Login a user

Body Properties

Prop	Description
email/username	required String (example: test@test.com)
password	required String (example: fakePassword123)
remember	optional Boolean if you would like to be logged in automatically (example: true)

Path: api/v1/auth/login

Kind: static method of Auth

Param	Type	Description
body	Object
authorization_bearer	string	The client_credentials generated OAUth2 access token.

Example
body

{
	"email": "test@test.com",
	"password": "Pas5w0r!d"
}

Auth.register(body, randomPassword, authorization_bearer)

register - Register a user

group_request is optional.

Path: api/v1/auth/register

Kind: static method of Auth

Param	Type	Description
body	Object
randomPassword	any	Generates a random password on the backend securely if set to true (example: true)
authorization_bearer	string	The client_credentials generated OAUth2 access token.

Example
body

{
	"username":"test",
	"email": "test34@test.com",
    "domain": "default",
    "password": "Pas5w0r!d"

}

AuthToken

Kind: global class

• AuthToken
  • .otp(id, authorization_bearer)
  • .forgotPassword(body)

AuthToken.otp(id, authorization_bearer)

otp - Generates a one time use password and returns the token to the attached user (if they exist) instead of sending an email. *CAUTION SECURITY RISK: Would not expose this URL publicly or have it be allowed by anyone who is not a superadmin type level**

Path: api/v1/auth/token/otp/id/:id

Kind: static method of AuthToken

Param	Type	Description
id	any	(example: test@test.com)
authorization_bearer	string	The client_credentials generated OAUth2 access token.

AuthToken.forgotPassword(body)

forgotPassword - Generates a recovery token and returns the token to the attached user (if they exist) instead of sending an email. *CAUTION SECURITY RISK: Would not expose this URL publicly or have it be allowed by anyone who is not a superadmin type level**

Path: api/v1/auth/token/password/forgot

Kind: static method of AuthToken

Param	Type
body	Object

Example
body

{
	"email": "test@test.com"
}

AuthDomain

Kind: global class

• AuthDomain
  • .forgotPassword(body, domain, authorization_bearer)
  • .login(body, domain, authorization_bearer)
  • .register(body, domain, randomPassword, authorization_bearer)

AuthDomain.forgotPassword(body, domain, authorization_bearer)

forgotPassword - Generates a recovery token and sends a email to the attached user (if they exist)

Path: api/v1/auth/password/forgot/domain/:domain

Kind: static method of AuthDomain

Param	Type	Description
body	Object
domain	any	Domain name (example: test.com) (example: dragohm.com)
authorization_bearer	string	The client_credentials generated OAUth2 access token.

Example
body

{
	"email": "kelvin@dragohm.com"
}

AuthDomain.login(body, domain, authorization_bearer)

login - Login a user

Body Properties

Prop	Description
email/username	required String (example: test@test.com)
password	required String (example: fakePassword123)
domain	required String (example: test.com)
remember	optional Boolean if you would like to be logged in automatically (example: true)

Path: api/v1/auth/login/domain/:domain

Kind: static method of AuthDomain

Param	Type	Description
body	Object
domain	any	Domain name (example: test.com) (example: dragohm.com)
authorization_bearer	string	The client_credentials generated OAUth2 access token.

Example
body

{
    "email": "test@test.com",
	"password": "Pas5w0r!d"
}

AuthDomain.register(body, domain, randomPassword, authorization_bearer)

register - Register a user

group_request is optional.

Path: api/v1/auth/register/domain/:domain

Kind: static method of AuthDomain

Param	Type	Description
body	Object
domain	any	Domain name (example: test.com) (example: contactsource.com)
randomPassword	any	Generates a random password on the backend securely if set to true (example: true)
authorization_bearer	string	The client_credentials generated OAUth2 access token.

Example
body

{
	"email": "mark+test@dragohm.com",
	"password": "dragohm123**"
}

AuthDomainToken

Kind: global class

• AuthDomainToken
  • .otp(domain, id, authorization_bearer)
  • .forgotPassword(body, domain, authorization_bearer)

AuthDomainToken.otp(domain, id, authorization_bearer)

otp - Generates a one time use password and returns the token to the attached user (if they exist) instead of sending an email. *CAUTION SECURITY RISK: Would not expose this URL publicly or have it be allowed by anyone who is not a superadmin type level**

Path: api/v1/auth/token/otp/domain/:domain/id/:id

Kind: static method of AuthDomainToken

Param	Type	Description
domain	any	(example: dragohm.com)
id	any	(example: test@test.com)
authorization_bearer	string	The client_credentials generated OAUth2 access token.

AuthDomainToken.forgotPassword(body, domain, authorization_bearer)

forgotPassword - Generates a recovery token and returns the token to the attached user (if they exist) instead of sending an email. *CAUTION SECURITY RISK: Would not expose this URL publicly or have it be allowed by anyone who is not a superadmin type level**

Path: api/v1/auth/token/password/forgot/domain/:domain

Kind: static method of AuthDomainToken

Param	Type	Description
body	Object
domain	any
authorization_bearer	string	The client_credentials generated OAUth2 access token.

Example
body

{
	"email": "test@test.com"
}

SDK(host, opts)

SDK - importing the SDK for use

Kind: global function

Param	Type	Description
host	string	the hostname to the service (example: http://127.0.0.1)
opts	object	options that will be appened to every request. Fasquest Lib Options (example: {headers: {‘API-KEY’:’34098hodf’}})

Example
init

const { Travelling } = require('./sdk.js')('http://127.0.0.1');

Changelog

v4.1.0

• Added param’s filtering on users endpoints 70414c7
• Updated sdk cd95404

v4.0.1

12 September 2023

• Update package.json aebd216
• Updated web sdk to remove double exports f7fd354

v4.0.0

21 August 2023

• Added ability to change default eprofile 1986203

v3.3.0

14 August 2023

• Feature #107 Add Gmail dedupe config #39
• Update users-get.js 9f457c2
• Move logic back to interfaces 7df3b29
• Remove conditional around create user test 67356da
• Remove unused var 0e74f03
• Change scope, and order of if cc008a6
• oop 5b3e508
• consolidate logic to checkUser 858e861
• Move into util func 65acf8a
• Update tests to use DeDupe 28afe82
• Move dedupe below valid user check 14ab80e
• Remove unnecesary lowercase 5f3bfb5
• Remove oop test db setup, default new config to false c62fc94
• Update config, add gmail dedupe check, add tests 6c644c3

v3.2.7

21 June 2023

• Feature #88 Add route redirects #38
• add tests f8548d2
• use other param 23d0206
• add route redirect logic fc3272a
• add route redirect logic 200bbc9
• Revert “redirects start” e2fd904
• Revert “redirects start” fa45685
• redirects start a3fd160
• redirects start d650bfe

v3.2.6

21 June 2023

v3.2.5

21 June 2023

• Update regex.js 77b9bcb
• Update package.json 4ffdf10

v3.2.4

19 May 2023

• Fix #102 Fix max login attempts account locking #37
• Merge pull request #37 from Dragohm/fix-#102-lock-accounts-on-max-attempts #102
• Fix max attempts lock user issue 8fc5c96

v3.2.3

12 May 2023

• Fix #101 password recovery email data #101

v3.2.2

12 May 2023

• Feature #101 Add data to password recovery email #36
• add data to password recovery email 3c4baeb
• Update Travelling.postman_collection.json 474eff0

v3.2.1

22 March 2023

• Update package.json e34774f

v3.2.0

22 March 2023

• Feature #83 Whitelist filter range operators #35
• Feature #85 User Data allow more special chars #34
• add docs e646bfb
• Whitelist db fields with op filters 39d90df
• update regex b2e176d

v3.1.5

1 March 2023

• Fixed routes endpoint and cookies on ip hijack cd03830

v3.1.4

24 February 2023

• Update cookietoken.js 948f326

v3.1.3

22 February 2023

• Fix #75 email lowercase bugs #33
• Merge pull request #33 from Dragohm/fix-#75-email-lowercase-bugs #75
• update email lowercase placement a9344ed

v3.1.2

22 February 2023

• Feature #82 reissue cookies on login #32
• fix #84 update conditional #84
• Fixes #80 and #84 #80
• opt 87eb041
• feature #82 reissue cookies on login 4106d8a
• Update package.json c6947ec

v3.1.1

16 February 2023

• Feature #48 Audits of and by user count endpoints #31
• typo fix f2e7493
• Add audits counts endpoints 1016a5d

v3.1.0

10 February 2023

• Added Routes check for bulk permission checking 05a6c27

v3.0.7

9 February 2023

• Added zcs and less restrict state/city req 21d6edc

v3.0.6

9 February 2023

• Update regex.js 68d33e4

v3.0.5

9 February 2023

• Feature #81 User Data allow arrays and objects #30
• Drop user_data char limit c2ead31
• allow user_data arrays and objects 5707cfa

v3.0.4

8 February 2023

• Fix #79 fix login crash #29
• Merge pull request #29 from Dragohm/fix-#79-login-crashed #79
• add span check e6897c8

v3.0.3

7 February 2023

• Update auth.js 3730494

v3.0.2

6 February 2023

• fix 49f9a97

v3.0.1

6 February 2023

• Update index.js c3018ab
• Make sure people can’t get locked out while logged in for password attempts 4903766

v3.0.0

1 February 2023

• Updated user object’s groups prop to only have id,name & type 31a8835

v2.23.1

1 February 2023

• made some fixes? cb37ee0

v2.23.0

31 January 2023

• Update cookietoken.js b188a27

v2.22.0

30 January 2023

• Update package.json f9b56b6
• Updated some spans for cookie checking 9dfbeab

v2.21.3

27 January 2023

• Update parse.js 2ae9d19

v2.21.2

26 January 2023

• Added x-forward for ip stuff f990a53

v2.21.1

18 January 2023

• Feature #77 Renew trav token on password change #28
• undo type b13c525
• Renew trav tok on password change 8548351

v2.21.0

16 December 2022

• Fix #76 audit log sensitive data leaks #27
• Add domains to audit logs #26
• Merge pull request #27 from Dragohm/fix-#76-audit-log-sensitive-data-leaks #76
• Updated adost and postgen 6652f2e
• rm domain regex 74a8231
• Add domain validation 757381e
• little fixes 8f7e0a6
• Add and update tests 072e8fb
• audits to save password and token hashes 9bc4100

v2.20.0

29 November 2022

• Fix #70 Remove hashes from responses #24
• Feature #71 user data special chars #25
• Merge pull request #24 from Dragohm/fix-#70-rm-hashes-from-res #70
• add user_data newlines and tabs db4cb12
• up regex limit 743ea2e
• allow special chats user_data 5286f14
• rm hashes and update tests 7099048

v2.19.0

14 November 2022

• Feature #66 - Add checkable cookie #23
• Add ls token tests c944378
• Update package.json 349372a
• update config.md 69ba80b
• update config.md d65c70c
• Add trav:ls cookie f0d9770

v2.18.1

8 November 2022

• Update auth.js 0f42d75

v2.18.0

22 August 2022

• Feature #60 edit user data with dot notation #22
• Add user data sec tests 6a1e809
• Add user data validation d3f6733
• Other mr comment fix 5a1a1ea
• MR comment update 2046af5
• fix stuff db48839
• Add endpoints cf27f51
• Add tests 3723929
• Add user prop object editing by value 1b7c46d

v2.17.3

26 July 2022

• Update user.js 8cf0cca

v2.17.2

11 July 2022

• fixes for node 16.15.1 and 18.4.0 #21
• Update cookietoken.js 8cd1323
• wrap in promise 9139fed

v2.17.1

11 July 2022

v2.17.0

11 July 2022

• Fix #55 get users by group #20
• Merge pull request #20 from Dragohm/fix-#55-get-users-by-group #55
• group type comparison ddae09c
• MR comment fixes 8eb1e8c
• Add tests. Update SDK d068a47
• Add filter, sort and pagination. Fix bugs 4cb65d9

v2.16.1

17 June 2022

• Feature #28 allowed domain is route allowed #19
• added bodylimit affcdb5
• Update audit test to use SDK with sort 275d5a6
• Update package.json a2dd981

v2.16.0

25 April 2022

• Updated eslint and fixed the problems a98498a
• Add domain to add group inheritance in test 395c73f
• Update user-get.js 23c183f
• Update tests 6ca40ed
• update tests fc535bc
• update router and add tests d1e560e
• allowed domain is route allowed 6ac5b5a

v2.15.0

11 April 2022

• Update audit queries #18
• Fix #49 - User - set user state and city #17
• Merge pull request #17 from bddowningjennings-dev/fix-#49-set-user-city-state #49
• fix setUser state & city; update tests 9385c6a

v2.14.1

4 April 2022

• Fix json and buffer data audit values #16

v2.14.0

30 March 2022

• Add user view audits #15
• Fix #36 Crash user edit dob #14
• Merge pull request #14 from Dragohm/fix-#36-crash-user-edit-dob #36
• Add session check e2f75c1
• bug fix fc063c1
• test fixes 67520ef
• update var 2320adc
• Add audit resolve. Update SDK 2b19d71
• Update user validation 12e44ee
• Update package.json 8c81584

v2.13.0

15 March 2022

• Feature - Users - get list by ids #12
• fixed domains inside urls 8fa304a

v2.12.0

15 March 2022

• update tests bbf5438
• update postman + tests de1879f
• fix testENV 91e9b34
• adding tests 9e38c35
• address PR feedback be26654
• update users list query to work with list of ids c03919d

v2.11.7

10 March 2022

• fixed domains inside urls 8fa304a

v2.11.6

10 March 2022

• Update auth.js e9ad8cd

v2.11.5

10 March 2022

• Update auth.js 62e2e9c

v2.11.4

8 March 2022

• Added extra layer of security on t header hijacking. 8db842c

v2.11.3

1 February 2022

• Update auth.js 88953eb

v2.11.2

25 January 2022

• sdk e45af3d

v2.11.1

25 January 2022

v2.11.0

18 January 2022

• Added optional generating random passwords for new user 0af759f

v2.10.0

11 January 2022

• Update Travelling.postman_collection.json 15c500a
• Added OTP routes and functionality and updated special chars password d718ae2

v2.9.2

5 November 2021

• Update package.json 315f8dc

v2.9.1

5 November 2021

• Update index.js aa91814

v2.9.0

5 November 2021

• Added “updated” prop to users, sped up user prop requests and fixed some bugs e7f51b1
• Update package.json fe550d3
• updated sdk 9a35a4e

v2.8.4

12 October 2021

• Update Travelling.postman_collection.json 911bd7a

v2.8.3

12 October 2021

• sdk update 8ef19a6

v2.8.2

29 September 2021

• Misc fixes and option to disable denied redirects to portal a47085b

v2.8.1

21 September 2021

• Fixed security bug regarding refreshed tokens while user has no username and dob bug 0d34961

v2.8.0

7 September 2021

• Added the ability to set user’s personal information on reg. 8018bec

v2.7.2

30 August 2021

v2.7.1

9 August 2021

• added prom stats for routes that are inside of groups. 18f9adf

v2.7.0

30 July 2021

• Feature #22 retrieve user change history #11
• Updated tests c281e92
• added config if statement 2bc7088
• Update audit.js 37e63d5
• Minor audit changes 6b3b850
• Added audit query validation 0d8dae1
• Audit validation functions. d18b9db
• Added filters to action and 55a3cc3
• Minor tweaks. 6a706c4
• Update index.js 0f772b4
• Fixed trace bug 082ae14
• Fixed group delete audit bug d7be225
• Added audit action type endpoints. 94d052d
• Added start to capture user count from sessions 3e764f0
• Update auth.js 99ee0b8
• fixed export bug d84b094
• removed unused class aa42d1a
• Audit changes. cc3d73d
• Test updates. ed48458
• Clean up on model function inheritance fa34f22
• Typo fix. 349600b
• Lint fixes. a5aef2f
• Moved query logic to util file. f427d43
• Created audit retrieval end points. 71f2078
• Added audit when default group set. 152c02b
• Updated token audit data. 52244cc
• Removed empty objects from audits 9434a1d
• Lint fixes. 8e5297f
• Updated audit info saved e02cde8
• Updated single audit logic to save objects. bb33066
• Typo fix. 4258544
• Added invalid audit tests. 487469e
• Added test for audit retrieval. 46c8bb4
• Updated SDK. 292a88a
• Created audit user by_id and of_id endpoints. e35fe02
• Added and updated tests for audits. d37d002
• Updated and added rest of audits. 985ae3e
• Updated audit creation logic. d8ff6fc
• Add support for audit environment variables. 540067c
• Updated audit schema. 095b106
• Added user edit with domain audit test. 5e38ff9
• Added audit test. 161c60a
• Update audit util. 8dcf997
• Fixed bug with user create audits. f3e2f2c
• Added user create and group inheritance audits. a1e2572
• DB inserts for audits. Added Delete audits. 33c8a69
• Added audit support for editing single props. 47a5279
• Created audit util sorting and ‘Edit’ audit. 2e57869
• Created structure for creating audits. 0df59c7
• Updated file name from changelog to audit. 5cc40d3

v2.6.5

20 July 2021

• Update router.js 3f6d413

v2.6.4

20 July 2021

• Update index.js fb0ac1a

v2.6.3

20 July 2021

• Fix for opentelemtry fd4a07e

v2.6.2

20 July 2021

• Update helpers.js acd28f5

v2.6.1

20 July 2021

• Fix for opentelemtry e41a671

v2.6.0

20 July 2021

• Audits table model and added to db init. #9
• Feature #21 clean up route functions #8
• Added welcome email ability. #7
• Feature #12 login disable auto remember me #6
• Feature #20 add user domain operations #5
• Feature #8 add skip param to users #4
• Feature #13 create users and domain count #3
• Feature #16 date range filter issues #2
• Moved user and group route functions. 4217059
• Created and moved auth route functions. 8c3437d
• Buf fix 0ac0da9
• Corrected register user response. cc93305
• Added support for REST email services. a84d7ee
• Added test for sending a welcome email on signup. ea6bb9f
• Fixed logging issue. bf302de
• Register route consitency tweaks. f44f573
• A litle reformatting. 455e38b
• Updated README.md 5c380b0
• Added checks to verify that tok is undefined. 30931eb
• Updated SDK. b8db4a8
• Updated non-remember login test. d529e54
• Modified remember param chacking. 4d1d133
• Fixed typo. Cleaned up tests. a222614
• Moved missing domain param error handling. a0cad10
• Combined get, edit and delete function parameters. 6fc399a
• Added tests for non-remember login. f8c30d2
• Updated SDK with new additions to docs. cdab2fb
• Added req prop to remember user or not. 48af76b
• Updated docs and sdk. baffa0e
• Added user get domain tests. 824e04f
• Added more user edit tests. c3614d3
• Added user-edit domain tests. 5c5e407
• Updated SDK. c2f5c82
• Reformatted function calls for getUsers. 9d1d3c9
• Added functionality to user domain routes. 3ec1421
• Fixed conditional statement for opts.limit. bf0bf2b
• Modified users count tests. e774a42
• Added limit and skip to users count endpoints. 31280ff
• Updated SDK. 7985e3e
• Added curlies for your protection. 5ea29cc
• Added tests for endpoints with skip param. 07e5d53
• Added tests for endpoints with skip param. 4902af2
• Updated SDK. 4984f7a
• Updated SDK. a87706d
• Added skip param to routes and db offset. 7bfe7f6
• Added skip param to routes and db offset. 6469009
• Used raw query for count. 88680f9
• Removed duplicate routes. 07e5517
• Count users / users by domain enpoints. f70270a
• Removed logs. 4070a44
• Regenerated SDK. Wrote tests for geting non-domain users. Added date validation. 372015a
• Removed console.logs. f1dd0fa
• Modified user model. 2b4f6af
• Modified user model. 9b85a90
• Modified user model. cef3c9b
• Modified user model. 3f06342
• Added more users by domain tests. 67d3a38
• Created base tests for users by domain. 7849a4f
• Fixed groupmanager bug. 32f9b2c
• Updated SDK a82c69c
• Fixed created_on <=/>= filter bug. 1940c87
• Created endpoint routes. 03ffe65
• Created endpoint routes. 7a84357
• Created endpoint routes. 8328430
• Created endpoint routes. bcf6311
• Created endpoint routes. 506d0f9
• Created endpoint routes. 6c033c4
• Created endpoint routes. 5dee46e
• Created endpoint routes. 1094848
• Update package.json 6e4fa0f
• Update package.json b117365
• Create LICENSE aa377de

v2.5.2

5 May 2021

• Updated to ignore /health and /metrics logs outs e530288
• Updated SDK d52feec
• Update Travelling.postman_collection.json 1435319

v2.5.1

3 May 2021

• Update index.js 12d527f

v2.5.0

3 May 2021

• Update Travelling.postman_collection.json 40e95d2
• Started work on add traces throughout code dfe93dd

v2.4.2

13 April 2021

• Added fix for when there is no default group it defaults to anonymous bd1abda

v2.4.1

7 April 2021

• Fixed some bugs, removed /metrics and /health from logs 7b98a92

v2.4.0

7 April 2021

• added more unique req headers coming from travelling. a77da6e

v2.3.1

31 March 2021

• Fixed a bug for cookie session expiration length ae6dd7c

v2.3.0

31 March 2021

v2.2.0

31 March 2021

• Update SDK and added Resetpassword with autologin endpoint and forgot password token endpoints. 9cb2d8e

v2.1.0

19 March 2021

• Added options to handle using external email validation service and updated docs b3279da

v2.0.0

19 March 2021

• Added a bunch of user related data to schemas, preparing for webauthn support, clean ups and some fixes c595104

v1.3.3

2 March 2021

• possible cloudflare headers fix 3aaeab2

v1.3.2

2 March 2021

• Fixed bug of proxying urls that start with the serviceName and have a host c6b70b4

v1.3.1

2 March 2021

• typo 3be0a65

v1.3.0

25 February 2021

• Added REST email provider as an option, option to change locked message, users will now be unlocked when they reset their password and their locked reason was from password fails and fixed a few bugs 958be20
• Added login by domain in postman / sdk 04ab374

v1.2.1

17 February 2021

• Fixed bug with auth when usernames disabled 00fe0bb

v1.2.1-0

17 February 2021

• Updated logo in readme 2079591

v1.2.0

17 February 2021

v1.1.1

17 February 2021

v1.1.1-1

17 February 2021

• Update npm-publish.yml b15cfbe
• Update .gitignore ddda22f
• Delete package-lock.json 2c7afb9
• Update npm-publish.yml 1d5ba20
• Update npm-publish.yml 30f57ef
• Update npm-publish.yml 8c1692f
• Create npm-publish.yml 7066bdf
• Removed console logs from dev d88d0b6

v1.1.0

17 February 2021

• Fixed some auto doc stuff 7bac291
• General cleanup, added posgres config settings, and doc reorg d84a3f8
• Update user-get.js 5e9ec0e

v1.0.0

12 February 2021

• Bump minimist from 1.2.0 to 1.2.5 in /client #4
• Bump acorn from 7.0.0 to 7.1.1 in /client #5
• Eng 1037 #3
• Merg #2
• a #1
• Updated to latest fastify, fixed some bugs and added domain field to users 74f9001
• Fixed npm package vulnerabilities 2ded3c7
• Removed node-utils depends and fixed tests e8c8f60
• [ENG-1037] - removed logging and fixed an error message 2717223
• [ENG-1037] - added redirect after logout 324dc9d
• [ENG-1037] - some email reg and reset fixes/cleanup 050f6af
• [ENG-1037] - fixed some tests and added wider ranges. 5a9e64c
• [ENG-1037] - Removed passwords from responses, added configs for web and misc fixes 775ed7f
• [ENG-1037] - misc fixes. fa9d8f4
• [ENG-1037] - regen 4e08024
• [ENG-1037] - added new function to sdk d705b97
• [ENG-1037] - console logs removed 84cc11e
• [ENG-1037] - Lots of cleanup on routes and bug fixes 474b788
• [ENG-1037] - Users can have multi groups, more test & misc fixes cec0448
• [ENG-1037] - Added edit property value for path params d4ce2d8
• [ENG-1037] - Added logs in catches, fixes for node-utils crypto and misc 2ff033c
• [ENG-1037] - Added in recho as our test server 87cccf8
• [ENG-1037] - cleanup 486d2ad
• [ENG-1037] - changed removeFromPath to remove_from_path for consistency 1f71307
• [ENG-1037] - more clean up on exports c53401f
• [ENG-1037] - added a few more routes, type scoped names, tests & clean ups 20c1673
• [ENG-1037] - Added * urls for tokens 191e709
• [ENG-1037] - added /group/type/:type/user/:id/:property f4ba5fe
• [ENG-1037] - cleanup d36cef2
• [ENG-1037] - Added more tests, fixed bugs test found and added 2 more routes. 681dbcd
• [ENG-1037] - Updated travelling sdk 195f971
• [ENG-1037] - Fixed bug with groups and other stuff 7ab46f9
• [ENG-1037] - Added import and export of groups. f6e18bc
• [ENG-1037] - More docs a5dbbc6
• [ENG-1037] - More docs 7a73d5c
• [ENG-1037] - fixes 468851a
• [ENG-1037] - More docs eb4806a
• [ENG-1037] - More docs 19d02a8
• [ENG-1037] - More docs 8489fad
• [ENG-1037] - style changes 83c2214
• [ENG-1037] - Start of readme docs cf5b28c
• [ENG-1037] - Secured oauth code token flow rfc6749#section-10.6 and some cleanup 8f96cec
• [ENG-1037] - Changed styling on the toasts 0e41b3a
• [ENG-1037] - Fixed auth code flow 567ac30
• [ENG-1037] - fixed memory token store ab100f0
• [ENG-1037] - added faicon in default anon group. efa3e13
• [ENG-1037] - Misc bug fixes and onboarding page is done. 47b7f2a
• [ENG-1037] - Massive cleanup and new login/reg page f1f0383
• [ENG-1037] - Improved Authorization Code Grant to be true SSO one-click ba84e61
• [ENG-1037] - Added crappy login/reg page for Authorization Code Grant f6cf3a3
• [ENG-1037] - Added redis support for multi service running. 899609d
• [ENG-1037] - Circular Group Inheritance protection and tests bcf6be0
• [ENG-1037] - Updated log in email 3e0a09d
• [ENG-1037] - fastify logging settings e68ed82
• [ENG-1037] - Fixed tests 75baa97
• [ENG-1037] - Added user methods by group type and name & cleaned up route paths da4ddd6
• [ENG-1037] - added get all users by group request endpoint b02b9d8
• [ENG-1037] - Added user query filtering to all routes dealing with users ec2e9a4
• [ENG-1037] - Added grouptype to dynamic route props c25b8a2
• [ENG-1037] - Added more group endpoints and cleaned up a bit 761d12b
• [ENG-1037] - Added group_request to registration and ‘users’ now has query search 8c229d0
• [ENG-1037] - removed console log 4e91cba
• [ENG-1037] - ip hijacking option cd26e30
• [ENG-1037] - Docs push for real this time a2b2306
• [ENG-1037] - Token tests added, sdk docs and misc 037e7ec
• [ENG-1037] - Token fixes and client_id with custom name 3188130
• [ENG-1037] - Added OAuth2 client_credentials flow & Other misc things 91a1e6b
• [ENG-1037] - misc things c93330d
• [ENG-1037] - Added more test and fixed bugs found with them. 415d2db
• [ENG-1037] - Start of tests, logging and misc bug crushing bc3363a
• [ENG-1037] - Email activation, user updates routes, and lots of misc fixes 1161b57
• [ENG-1037] - Forgot password emailing working with smtp, SES and test eef0724
• [ENG-1037] - Fixed bugs with reset and forget password 969aa85
• [ENG-1037] - Added forgot password logic f09403f
• [ENG-1037] - Added more user & group API endpoints 5cfc766
• [ENG-1037] - Got routing and auth up to being ready and added some user routes 83de3fd
• [ENG-1037] - added portal static file hosting 565eb2d
• [ENG-1037] - Added routing for reverse proxy, still WIP but seems to work. 47a254f
• Auth sessions and tokens login, logout and register are done 05eea6e
• Token work done b3592c6
• Start of code base 2e1b949
• Initial commit e2f3b07

License

                GNU GENERAL PUBLIC LICENSE
                   Version 3, 29 June 2007

Copyright (C) 2007 Free Software Foundation, Inc. https://fsf.org/ Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.

                        Preamble

The GNU General Public License is a free, copyleft license for software and other kinds of works.

The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change all versions of a program–to make sure it remains free software for all its users. We, the Free Software Foundation, use the GNU General Public License for most of our software; it applies also to any other work released this way by its authors. You can apply it to your programs, too.

When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for them if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs, and that you know you can do these things.

To protect your rights, we need to prevent others from denying you these rights or asking you to surrender the rights. Therefore, you have certain responsibilities if you distribute copies of the software, or if you modify it: responsibilities to respect the freedom of others.

For example, if you distribute copies of such a program, whether gratis or for a fee, you must pass on to the recipients the same freedoms that you received. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights.

Developers that use the GNU GPL protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License giving you legal permission to copy, distribute and/or modify it.

For the developers’ and authors’ protection, the GPL clearly explains that there is no warranty for this free software. For both users’ and authors’ sake, the GPL requires that modified versions be marked as changed, so that their problems will not be attributed erroneously to authors of previous versions.

Some devices are designed to deny users access to install or run modified versions of the software inside them, although the manufacturer can do so. This is fundamentally incompatible with the aim of protecting users’ freedom to change the software. The systematic pattern of such abuse occurs in the area of products for individuals to use, which is precisely where it is most unacceptable. Therefore, we have designed this version of the GPL to prohibit the practice for those products. If such problems arise substantially in other domains, we stand ready to extend this provision to those domains in future versions of the GPL, as needed to protect the freedom of users.

Finally, every program is threatened constantly by software patents. States should not allow patents to restrict development and use of software on general-purpose computers, but in those that do, we wish to avoid the special danger that patents applied to a free program could make it effectively proprietary. To prevent this, the GPL assures that patents cannot be used to render the program non-free.

The precise terms and conditions for copying, distribution and modification follow.

                   TERMS AND CONDITIONS

1. Definitions.

“This License” refers to version 3 of the GNU General Public License.

“Copyright” also means copyright-like laws that apply to other kinds of works, such as semiconductor masks.

“The Program” refers to any copyrightable work licensed under this License. Each licensee is addressed as “you”. “Licensees” and “recipients” may be individuals or organizations.

To “modify” a work means to copy from or adapt all or part of the work in a fashion requiring copyright permission, other than the making of an exact copy. The resulting work is called a “modified version” of the earlier work or a work “based on” the earlier work.

A “covered work” means either the unmodified Program or a work based on the Program.

To “propagate” a work means to do anything with it that, without permission, would make you directly or secondarily liable for infringement under applicable copyright law, except executing it on a computer or modifying a private copy. Propagation includes copying, distribution (with or without modification), making available to the public, and in some countries other activities as well.

To “convey” a work means any kind of propagation that enables other parties to make or receive copies. Mere interaction with a user through a computer network, with no transfer of a copy, is not conveying.

An interactive user interface displays “Appropriate Legal Notices” to the extent that it includes a convenient and prominently visible feature that (1) displays an appropriate copyright notice, and (2) tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion.

1. Source Code.

The “source code” for a work means the preferred form of the work for making modifications to it. “Object code” means any non-source form of a work.

A “Standard Interface” means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language.

The “System Libraries” of an executable work include anything, other than the work as a whole, that (a) is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A “Major Component”, in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it.

The “Corresponding Source” for a work in object code form means all the source code needed to generate, install, and (for an executable work) run the object code and to modify the work, including scripts to control those activities. However, it does not include the work’s System Libraries, or general-purpose tools or generally available free programs which are used unmodified in performing those activities but which are not part of the work. For example, Corresponding Source includes interface definition files associated with source files for the work, and the source code for shared libraries and dynamically linked subprograms that the work is specifically designed to require, such as by intimate data communication or control flow between those subprograms and other parts of the work.

The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source.

The Corresponding Source for a work in source code form is that same work.

1. Basic Permissions.

All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law.

You may make, run and propagate covered works that you do not convey, without conditions so long as your license otherwise remains in force. You may convey covered works to others for the sole purpose of having them make modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you.

Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary.

1. Protecting Users’ Legal Rights From Anti-Circumvention Law.

No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures.

When you convey a covered work, you waive any legal power to forbid circumvention of technological measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or modification of the work as a means of enforcing, against the work’s users, your or third parties’ legal rights to forbid circumvention of technological measures.

1. Conveying Verbatim Copies.

You may convey verbatim copies of the Program’s source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice; keep intact all notices stating that this License and any non-permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program.

You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee.

1. Conveying Modified Source Versions.

You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions:

a) The work must carry prominent notices stating that you modified
it, and giving a relevant date.

b) The work must carry prominent notices stating that it is
released under this License and any conditions added under section
7.  This requirement modifies the requirement in section 4 to
"keep intact all notices".

c) You must license the entire work, as a whole, under this
License to anyone who comes into possession of a copy.  This
License will therefore apply, along with any applicable section 7
additional terms, to the whole of the work, and all its parts,
regardless of how they are packaged.  This License gives no
permission to license the work in any other way, but it does not
invalidate such permission if you have separately received it.

d) If the work has interactive user interfaces, each must display
Appropriate Legal Notices; however, if the Program has interactive
interfaces that do not display Appropriate Legal Notices, your
work need not make them do so.

A compilation of a covered work with other separate and independent works, which are not by their nature extensions of the covered work, and which are not combined with it such as to form a larger program, in or on a volume of a storage or distribution medium, is called an “aggregate” if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation’s users beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate.

1. Conveying Non-Source Forms.

You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways:

a) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by the
Corresponding Source fixed on a durable physical medium
customarily used for software interchange.

b) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by a
written offer, valid for at least three years and valid for as
long as you offer spare parts or customer support for that product
model, to give anyone who possesses the object code either (1) a
copy of the Corresponding Source for all the software in the
product that is covered by this License, on a durable physical
medium customarily used for software interchange, for a price no
more than your reasonable cost of physically performing this
conveying of source, or (2) access to copy the
Corresponding Source from a network server at no charge.

c) Convey individual copies of the object code with a copy of the
written offer to provide the Corresponding Source.  This
alternative is allowed only occasionally and noncommercially, and
only if you received the object code with such an offer, in accord
with subsection 6b.

d) Convey the object code by offering access from a designated
place (gratis or for a charge), and offer equivalent access to the
Corresponding Source in the same way through the same place at no
further charge.  You need not require recipients to copy the
Corresponding Source along with the object code.  If the place to
copy the object code is a network server, the Corresponding Source
may be on a different server (operated by you or a third party)
that supports equivalent copying facilities, provided you maintain
clear directions next to the object code saying where to find the
Corresponding Source.  Regardless of what server hosts the
Corresponding Source, you remain obligated to ensure that it is
available for as long as needed to satisfy these requirements.

e) Convey the object code using peer-to-peer transmission, provided
you inform other peers where the object code and Corresponding
Source of the work are being offered to the general public at no
charge under subsection 6d.

A separable portion of the object code, whose source code is excluded from the Corresponding Source as a System Library, need not be included in conveying the object code work.

A “User Product” is either (1) a “consumer product”, which means any tangible personal property which is normally used for personal, family, or household purposes, or (2) anything designed or sold for incorporation into a dwelling. In determining whether a product is a consumer product, doubtful cases shall be resolved in favor of coverage. For a particular product received by a particular user, “normally used” refers to a typical or common use of that class of product, regardless of the status of the particular user or of the way in which the particular user actually uses, or expects or is expected to use, the product. A product is a consumer product regardless of whether the product has substantial commercial, industrial or non-consumer uses, unless such uses represent the only significant mode of use of the product.

“Installation Information” for a User Product means any methods, procedures, authorization keys, or other information required to install and execute modified versions of a covered work in that User Product from a modified version of its Corresponding Source. The information must suffice to ensure that the continued functioning of the modified object code is in no case prevented or interfered with solely because modification has been made.

If you convey an object code work under this section in, or with, or specifically for use in, a User Product, and the conveying occurs as part of a transaction in which the right of possession and use of the User Product is transferred to the recipient in perpetuity or for a fixed term (regardless of how the transaction is characterized), the Corresponding Source conveyed under this section must be accompanied by the Installation Information. But this requirement does not apply if neither you nor any third party retains the ability to install modified object code on the User Product (for example, the work has been installed in ROM).

The requirement to provide Installation Information does not include a requirement to continue to provide support service, warranty, or updates for a work that has been modified or installed by the recipient, or for the User Product in which it has been modified or installed. Access to a network may be denied when the modification itself materially and adversely affects the operation of the network or violates the rules and protocols for communication across the network.

Corresponding Source conveyed, and Installation Information provided, in accord with this section must be in a format that is publicly documented (and with an implementation available to the public in source code form), and must require no special password or key for unpacking, reading or copying.

1. Additional Terms.

“Additional permissions” are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions.

When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission.

Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms:

a) Disclaiming warranty or limiting liability differently from the
terms of sections 15 and 16 of this License; or

b) Requiring preservation of specified reasonable legal notices or
author attributions in that material or in the Appropriate Legal
Notices displayed by works containing it; or

c) Prohibiting misrepresentation of the origin of that material, or
requiring that modified versions of such material be marked in
reasonable ways as different from the original version; or

d) Limiting the use for publicity purposes of names of licensors or
authors of the material; or

e) Declining to grant rights under trademark law for use of some
trade names, trademarks, or service marks; or

f) Requiring indemnification of licensors and authors of that
material by anyone who conveys the material (or modified versions of
it) with contractual assumptions of liability to the recipient, for
any liability that these contractual assumptions directly impose on
those licensors and authors.

All other non-permissive additional terms are considered “further restrictions” within the meaning of section 10. If the Program as you received it, or any part of it, contains a notice stating that it is governed by this License along with a term that is a further restriction, you may remove that term. If a license document contains a further restriction but permits relicensing or conveying under this License, you may add to a covered work material governed by the terms of that license document, provided that the further restriction does not survive such relicensing or conveying.

If you add terms to a covered work in accord with this section, you must place, in the relevant source files, a statement of the additional terms that apply to those files, or a notice indicating where to find the applicable terms.

Additional terms, permissive or non-permissive, may be stated in the form of a separately written license, or stated as exceptions; the above requirements apply either way.

1. Termination.

You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to propagate or modify it is void, and will automatically terminate your rights under this License (including any patent licenses granted under the third paragraph of section 11).

However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation.

Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice.

Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10.

1. Acceptance Not Required for Having Copies.

You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so.

1. Automatic Licensing of Downstream Recipients.

Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License.

An “entity transaction” is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party’s predecessor in interest had or could give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable efforts.

You may not impose any further restrictions on the exercise of the rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it.

1. Patents.

A “contributor” is a copyright holder who authorizes use under this License of the Program or a work on which the Program is based. The work thus licensed is called the contributor’s “contributor version”.

A contributor’s “essential patent claims” are all patent claims owned or controlled by the contributor, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling its contributor version, but do not include claims that would be infringed only as a consequence of further modification of the contributor version. For purposes of this definition, “control” includes the right to grant patent sublicenses in a manner consistent with the requirements of this License.

Each contributor grants you a non-exclusive, worldwide, royalty-free patent license under the contributor’s essential patent claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor version.

In the following three paragraphs, a “patent license” is any express agreement or commitment, however denominated, not to enforce a patent (such as an express permission to practice a patent or covenant not to sue for patent infringement). To “grant” such a patent license to a party means to make such an agreement or commitment not to enforce a patent against the party.

If you convey a covered work, knowingly relying on a patent license, and the Corresponding Source of the work is not available for anyone to copy, free of charge and under the terms of this License, through a publicly available network server or other readily accessible means, then you must either (1) cause the Corresponding Source to be so available, or (2) arrange to deprive yourself of the benefit of the patent license for this particular work, or (3) arrange, in a manner consistent with the requirements of this License, to extend the patent license to downstream recipients. “Knowingly relying” means you have actual knowledge that, but for the patent license, your conveying the covered work in a country, or your recipient’s use of the covered work in a country, would infringe one or more identifiable patents in that country that you have reason to believe are valid.

If, pursuant to or in connection with a single transaction or arrangement, you convey, or propagate by procuring conveyance of, a covered work, and grant a patent license to some of the parties receiving the covered work authorizing them to use, propagate, modify or convey a specific copy of the covered work, then the patent license you grant is automatically extended to all recipients of the covered work and works based on it.

A patent license is “discriminatory” if it does not include within the scope of its coverage, prohibits the exercise of, or is conditioned on the non-exercise of one or more of the rights that are specifically granted under this License. You may not convey a covered work if you are a party to an arrangement with a third party that is in the business of distributing software, under which you make payment to the third party based on the extent of your activity of conveying the work, and under which the third party grants, to any of the parties who would receive the covered work from you, a discriminatory patent license (a) in connection with copies of the covered work conveyed by you (or copies made from those copies), or (b) primarily for and in connection with specific products or compilations that contain the covered work, unless you entered into that arrangement, or that patent license was granted, prior to 28 March 2007.

Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law.

1. No Surrender of Others’ Freedom.

If conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot convey a covered work so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program.

1. Use with the GNU Affero General Public License.

Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed under version 3 of the GNU Affero General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the special requirements of the GNU Affero General Public License, section 13, concerning interaction through a network will apply to the combination as such.

1. Revised Versions of this License.

The Free Software Foundation may publish revised and/or new versions of the GNU General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns.

Each version is given a distinguishing version number. If the Program specifies that a certain numbered version of the GNU General Public License “or any later version” applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU General Public License, you may choose any version ever published by the Free Software Foundation.

If the Program specifies that a proxy can decide which future versions of the GNU General Public License can be used, that proxy’s public statement of acceptance of a version permanently authorizes you to choose that version for the Program.

Later license versions may give you additional or different permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version.

1. Disclaimer of Warranty.

THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.

1. Limitation of Liability.

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

1. Interpretation of Sections 15 and 16.

If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee.

                 END OF TERMS AND CONDITIONS

        How to Apply These Terms to Your New Programs

If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms.

To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively state the exclusion of warranty; and each file should have at least the “copyright” line and a pointer to where the full notice is found.

<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year>  <name of author>

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <https://www.gnu.org/licenses/>.

Also add information on how to contact you by electronic and paper mail.

If the program does terminal interaction, make it output a short notice like this when it starts in an interactive mode:

<program>  Copyright (C) <year>  <name of author>
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.

The hypothetical commands show w' and show c’ should show the appropriate parts of the General Public License. Of course, your program’s commands might be different; for a GUI interface, you would use an “about box”.

You should also get your employer (if you work as a programmer) or school, if any, to sign a “copyright disclaimer” for the program, if necessary. For more information on this, and how to apply and follow the GNU GPL, see https://www.gnu.org/licenses/.

The GNU General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Lesser General Public License instead of this License. But first, please read https://www.gnu.org/licenses/why-not-lgpl.html.

This site is open source. Improve this page.