travelling
Advanced tools
Travelling
A blazing fast dynamic route level groups/permissions api gateway.
Download the latest release or run git clone https://github.com/phara0h/travelling.git
Inside the root Travelling folder run: npm install
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
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.
It is recommended to follow this security tips to help keep Travelling as secure as possible.
Configuration is done through environment variables. All variables have a default values except for what is stated in Minimum New Setup
Travelling's serving port.
Default:
443
Travelling's serving IP.
Default:
0.0.0.0
The path to the SSL key that is used for https
Default:
travelling/localhost.key
The path to the SSL cert that is used for https
Default:
travelling/localhost.csr
Enables https serving.
Default:
travelling/localhost.csr
Changes the service's urls and other functionality around it's name.
Default:
travelling
If cloudflare sits infront of Travelling set this to true, so users have their real IP assigned to them.
Default:
false
Recommended to keep this disabled due to security reasons. Only enable this if you really need it and know the risks.
Allows external services to make api calls to Travelling.
Default:
false
_Full host path or wildstar _ host pathed subdomains to allow. This is returned back with all requests.*
Default: Rewrites the origin to whatever external host is making the call. This allows all external calls allowed and is not recommended.
> Example:*.domain.com
access-control-allow-methods header that is returned back with all requests.
Default: Rewrites it's self to the
access-control-request-methodheader request or sets to*if there is no request.
> Example:GET,DELETE
access-control-allow-credentials header that is returned back with all routes under /travelling/api/v1/auth/
Default:
true
access-control-max-age header that is returned back with all CORS options request.
Default:
3600
For maximum performance it is recommended to disable TRAVELLING_LOG_FASTIFY_LOGGER_REQUEST and TRAVELLING_LOG_FASTIFY_LOGGER
Enables TRAVELLING_LOG_LOGGER.
Default:
true
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.
Default:
travelling/include/utils/logger.js
Enables console colors to be used with TRAVELLING_LOG_LOGGER.
Default:
true
Sets the log level for TRAVELLING_LOG_LOGGER. The options are trace,debug,info,warn,error,fatal.
Default:
info
Enables logging of every request of all requests with TRAVELLING_LOG_LOGGER.
Default:
true
Enables logging of every unauthorized access requests made with TRAVELLING_LOG_LOGGER.
Default:
true
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.
Default:
false
> Example: js file setting pino settings.
module.exports = {
level: 'info'
};
Enables logging of every request and response in pino's format. Recommended not to have this and TRAVELLING_LOG_LOGGER enabled at once
Default:
true
The name of the header that gets set by pino's correlation id system.
Default:
travelling-req-id
The name of the property that gets set by pino's correlation id system.
Default:
travellingReqID
Enables the portal which has the client for login/logout/register/forgotPassword/oauth2Code functionality. This should always be enabled.
Default:
true
The route that travelling will serve the client at.
Default:
/travelling/portal/
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.
Default:
travelling/localhost.key
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.
Default:
travelling/client/dist
The absolute filepath to the logo to be displayed on the client side.
Default:
travelling/client/assets/logo.svg
The absolute filepath to the css file to be displayed on the client side.
Default:
travelling/client/assets/styles.css
The absolute filepath to the faveicon to be displayed on the client side.
Default:
travelling/client/assets/favicon.ico
How long in seconds the proxy should wait on a request to finish. 0 is Infinity
Default:
0
Allows Travelling to send permission/user/group based headers along with the proxy route
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. |
Enables redis to be used when multiple instances of travelling are running and being load balanced against.
Default:
falseUses in memory store which could be problematic depending on how many groups and routes there are.
The URL to a redis instance to be used by travelling as a data store.
Default:
redis://127.0.0.1:6379/
The URL to a redis instance to be used by travelling as a pub/sub event system.
Default:
redis://127.0.0.1:6379/
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.
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
Default:
This needs to be set!
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.
Default:
300
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
Default:
nullThis needs to be set!
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
Default:
nullThis needs to be set!
How long the persistent token cookie will last for in days.
Default:
30
How long the persistent token cookie will last for in days.
Default:
null
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.
Default:
true
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.
Default:
false
The minimum amount of characters a username has to have.
Default:
4
Require users to have usernames
Default:
true
Require users to have usernames
Default:
Failed login attempts exceeded the limit. Contact your admin to get your account unlocked.
Disables user's passwords from having any consecutive characters.
Default:
false
The minimum amount of characters a user's password has to have
Default:
8
The maximum amount of characters a user's password is allowed to have. Leaving this unset makes it unlimited
Default:
The minimum amount of special characters a user's password has to have.
Default:
30
The minimum amount of numbers characters a user's password has to have.
Default:
1
The minimum amount of lowercase characters a user's password has to have.
Default:
1
The minimum amount of uppercase characters a user's password has to have.
Default:
1
The maximum amount of failed login attempts until a user is locked.
Default:
10
How long a OAUTH2 Access token will last for in minutes.
Default:
1440
How long a OAUTH2 Code token will last for in minutes.
Default:
5
Enforces the user to click a authorize button to allow a client to login for the user.
Default:
true
The Postgres connection url for Travelling to connect to.
Default:
null
The Postgres user.
Default:
null
The Postgres password.
Default:
null
The Postgres port.
Default:
null
The Postgres databases name.
Default:
null
The Postgres host.
Default:
null
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.
Default:
travelling/include/utils/cryptointerface.js
The secret used inside TRAVELLING_PG_CRYPTO_IMPLEMENTATION. This needs to stay a secret and should be changed ever so often for security reasons.
Default:
nullThis needs to be set!
The salt used inside TRAVELLING_PG_CRYPTO_IMPLEMENTATION. This needs to stay a secret and should be changed ever so often for security reasons.
Default:
nullThis needs to be set!
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.
Default:
false
Enable external email endpoint for email validation
Default:
false
Full url for endpoint for email validation
Default:
null
Appends the users email to the end of the supplied endpoint. EX: http://test.com/email/test@test.com
Default:
true
Sends the users email as text as a body to the supplied endpoint
Default:
false
Supplied endpoint's HTTP Method to use
Default:
GET
The email that will be used as the from address. Recommended to set it to a no-reply email address
Default:
null
The number of seconds for the email recovery link to last for. Recommended to keep this somewhat short-lived for security reasons.
Default:
900
The number of seconds for the email activation link to last for.
Default:
86400
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.
Default:
false
Enables the use of a SMTP email service. Only one type of email support should be used Test, SMTP or AWS.
Default:
false
The host of the SMTP service.
Default:
127.0.0.1
The port of the SMTP service.
Default:
465
Enables TLS for SMTP.
Default:
true
Username for SMTP service.
Default:
null
Password for SMTP service.
Default:
null
Enables rejection of TLS certs that are self served or invalid. Recommended to keep it enabled for security reasons.
Default:
true
Enables the use of the AWS SES email service. Only one type of email support should be used Test, SMTP or AWS.
Default:
false
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.
Default:
null// This needs to be set to use AWS SES email service.
Templates all use html/handlebars. Check out the example default templates inside the travelling/templates/ folder for examples.
Reset Template Variables:
| Variable | Description |
|---|---|
{{user}} | This is the user object for the reset email. Use dot notation to access any of its properties for example: {{user.username}}. |
{{config}} | This is the config object for Travelling. Use dot notation to access any of its properties for example {{config.port}}. |
{{token}} | 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. |
{{ip}} | 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 |
|---|---|
{{user}} | This is the user object for the activation email. Use dot notation to access any of its properties for example: {{user.username}}. |
{{config}} | This is the config object for Travelling. Use dot notation to access any of its properties for example {{config.port}}. |
{{token}} | 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. |
The absolute path to the email reset password template body. This is used as the body inside all reset password emails.
Default:
travelling/templates/email-reset-password-body.html
The absolute path to the email reset password template subject. This is used as the subject line inside all reset password emails.
Default:
templates/email-reset-password-subject.html
The absolute path to the email activation template body. This is used as the body inside all activation emails.
Default:
templates/email-activation-body.html
The absolute path to the email activation template subject.This is used as the subject line inside all activation emails.
Default:
templates/email-activation-subject.html
Enables the requirement of each newly registered user to activate their account through the email link.
Default:
false
Enables the requirement of each newly registered user to have a active user with permissions to unlock their account for them.
Default:
false
Both requests are disabled. Dont use.
SDK - importing the SDK for use
Kind: global class
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. |
metrics - servers metrics
Path: metrics
Kind: static method of Travelling
| Param | Type | Description |
|---|---|---|
| authorization_bearer | string | The client_credentials generated OAUth2 access token. |
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. |
Kind: global class
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. |
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": {
"type": "group",
"allowed": [
{
"route": "/travelling/portal/*",
"host": null,
"name": "*-travelling-portal-*"
},
{
"route": "/travelling/api/v1/auth/*",
"host": null,
"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,
"removeFromPath": "/travelling/assets/",
"method": "GET",
"name": "get-travelling-assets-*"
},
{
"route": "/travelling/api/v1/config/password",
"host": null,
"method": "GET",
"name": "get-travelling-api-v1-config-password"
},
{
"route": "/favicon.ico",
"host": null,
"method": "GET",
"name": "get-favicon.ico"
}
],
"inherited": null,
"is_default": false
},
"group3": {
"type": "group",
"allowed": null,
"inherited": [
"testgroup|group1",
"group|group2"
],
"is_default": false
},
"superadmin": {
"type": "group",
"allowed": [
{
"host": null,
"route": "/travelling/*",
"name": "*-travelling-*"
},
{
"name": "test-one-*-three"
}
],
"inherited": [
"group|anonymous"
],
"is_default": false
},
"group4": {
"type": "group",
"allowed": null,
"inherited": [],
"is_default": false
},
"group2": {
"type": "group",
"allowed": [
{
"route": "/test/get",
"host": "https://127.0.0.1:4268/:username/:group",
"removeFromPath": "/test/get",
"method": "GET",
"name": "get-test-get"
},
{
"route": "/test/post",
"host": "http://127.0.0.1:4267/?id=:id&permission=:permission",
"removeFromPath": "/test/post",
"method": "POST",
"name": "post-test-post"
}
],
"inherited": [
"testgroup|group1"
],
"is_default": false
},
"group5": {
"type": "group",
"allowed": [
{
"route": "/test/delete/:grouptype",
"host": "https://127.0.0.1:4268",
"removeFromPath": "/test/delete",
"method": "DELETE",
"name": "delete-test-delete-:grouptype"
}
],
"inherited": [
"group|group4",
"group|superadmin"
],
"is_default": true
},
"group1": {
"type": "group",
"allowed": null,
"inherited": null,
"is_default": false
}
},
"testgroup": {
"group1": {
"type": "testgroup",
"allowed": null,
"inherited": [
"group|group4"
],
"is_default": false
},
"superadmin": {
"type": "testgroup",
"allowed": null,
"inherited": null,
"is_default": false
}
}
}
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. |
Kind: global class
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. |
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. |
Kind: global class
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. |
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. |
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-*"
}
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. |
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. |
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. |
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 |
| authorization_bearer | string | The client_credentials generated OAUth2 access token. |
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"
}
]
}
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. |
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. |
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": "accounts",
"allowed": [
{
"route": "/test",
"host": "http://127.0.0.1:1237/",
"remove_from_path": "test",
"method": "*",
"name": "all-test"
}
],
"is_default": false
}
Kind: global class
inherited - Gets all the users that belong to the group and all of its inherited groups.
| 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) |
| 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) |
get - Gets all the users that belong to the group.
| 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) |
| 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 | id or name (example: superadmin) |
Kind: global class
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. |
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. |
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. |
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. |
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
}
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
}
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. |
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. |
Kind: global class
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. |
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. |
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-*"
}
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. |
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. |
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) |
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. |
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. |
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"]}
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. |
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
}
Both requests are disabled. Dont use.
Kind: global class
get - Gets all the users that belong to the group of a particular type by its name or id.
| 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) |
| 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 |
|---|---|
| id | any |
| type | any |
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.
| 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) |
| 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) |
Kind: global class
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. |
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. |
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. |
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. |
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
}
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
}
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. |
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. |
Kind: global class
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
}
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. |
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"
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
}
Kind: global class
byGroupRequest - Gets all the users that have the specified group request
| 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) |
| 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. |
get - Gets all the users
| 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) |
| 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 |
|---|---|---|
| authorization_bearer | string | The client_credentials generated OAUth2 access token. |
get - Gets all the users
| 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) |
| optional (example: test@test.ai) | |
| created_on | optional (example: 1568419646794) |
| last_login | optional (example: null) |
Path: api/v1/users
Kind: static method of UsersDomain
| Param | Type | Description |
|---|---|---|
| authorization_bearer | string | The client_credentials generated OAUth2 access token. |
Kind: global class
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. |
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: 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. |
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: 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. |
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. |
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
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!@"
}
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. |
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. |
Kind: global class
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
{
"name": "conversate"
}
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. |
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. |
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. |
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: user_data) |
| authorization_bearer | string | The client_credentials generated OAUth2 access token. |
Example
body
{
"test": 123
}
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 |
| authorization_bearer | string | The client_credentials generated OAUth2 access token. |
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!@"
}
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. |
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. |
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. |
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. |
Kind: global class
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
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 |
activate - Activates and unlocks user
Path: api/v1/auth/activate
Kind: static method of Auth
| Param | Type | Description |
|---|---|---|
| token | any | (example: activation_token) |
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]) |
Example
body
{
"password":"asdf"
}
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]) |
Example
body
{
"password":"asdf"
}
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 |
|---|---|
| body | Object |
Example
body
{
"email": "test@test.com"
}
logout -
Path: api/v1/auth/logout
Kind: static method of Auth
login - Register a user
Path: api/v1/auth/login
Kind: static method of Auth
| Param | Type |
|---|---|
| body | Object |
Example
body
{
"username": "test",
"password": "Pas5w0r!d",
"domain": "default"
}
register - Register a user
group_request is optional.
Path: api/v1/auth/register
Kind: static method of Auth
| Param | Type |
|---|---|
| body | Object |
Example
body
{
"username":"test",
"password":"Pas5w0r!d",
"email": "test@test.com",
"domain": "default"
}
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/password/forgot
Kind: static method of AuthToken
| Param | Type |
|---|---|
| body | Object |
Example
body
{
"email": "test@test.com"
}
Kind: global class
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 | (example: test.com) |
Example
body
{
"email": "test@test.com"
}
login - Register a user
Path: api/v1/auth/login/domain/:domain
Kind: static method of AuthDomain
| Param | Type | Description |
|---|---|---|
| body | Object | |
| domain | any | (example: test.com) |
Example
body
{
"username": "test",
"password": "Pas5w0r!d",
"domain": "default"
}
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 | (example: test.com) |
Example
body
{
"username":"test",
"password":"Pas5w0r!d",
"email": "test@test.com"
}
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/password/forgot
Kind: static method of AuthDomainToken
| Param | Type |
|---|---|
| body | Object |
Example
body
{
"email": "test@test.com"
}
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');
bd1abda7 April 2021
7b98a927 April 2021
a77da6e31 March 2021
ae6dd7c31 March 2021
31 March 2021
9cb2d8e19 March 2021
b3279da19 March 2021
c5951042 March 2021
3aaeab22 March 2021
c6b70b42 March 2021
3be0a6525 February 2021
958be2004ab37417 February 2021
00fe0bb17 February 2021
207959117 February 2021
17 February 2021
17 February 2021
b15cfbeddda22f2c7afb91d5ba2030f57ef8c1692f7066bdfd88d0b617 February 2021
7bac291d84a3f85e9ec0e12 February 2021
#4#5#3#2#174f90012ded3c7e8c8f602717223324dc9d050f6af5a9e64c775ed7ffa9d8f44e08024d705b9784cc11e474b788cec0448d4ce2d82ff033c87cccf8486d2ad1f71307c53401f20c1673191e709f4ba5fed36cef2681dbcd195f9717ab46f9f6e18bca5dbbc67a73d5c468851aeb4806a19d02a88489fad83c2214cf5b28crfc6749#section-10.6 and some cleanup 8f96cec0e41b3a567ac30ab100f0efa3e1347b7f2af1f0383ba84e61f6cf3a3899609dbcf6be03e0a09de68ed8275baa97da4ddd6b02b9d8ec2e9a4c25b8a2761d12b8c229d04e91cbacd26e30a2b2306037e7ec318813091a1e6bc93330d415d2dbbc3363a1161b57eef0724969aa85f09403f5cfc76683de3fd565eb2d47a254f05eea6eb3592c62e1b949e2f3b07MIT License
Copyright (c) 2019 Jt Whissel
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
FAQs
A dynamic route level groups permissions middleman service
The npm package travelling receives a total of 0 weekly downloads. As such, travelling popularity was classified as not popular.
We found that travelling demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
Socket researchers have discovered malicious npm packages targeting crypto developers, stealing credentials and wallet data using spyware delivered through typosquats of popular cryptographic libraries.
Security News
Socket's package search now displays weekly downloads for npm packages, helping developers quickly assess popularity and make more informed decisions.
Security News
A Stanford study reveals 9.5% of engineers contribute almost nothing, costing tech $90B annually, with remote work fueling the rise of "ghost engineers."