Travelling
Travelling
Both requests are disabled. Dont use.
SDK - importing the SDK for use
Travelling](#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](#Travelling)
| Param | Type | Description |
| --- | --- | --- |
| 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](#Config)
| Param | Type | Description |
| --- | --- | --- |
| property | any | (example: password) |
| authorization_bearer | string | The client_credentials generated OAUth2 access token. |
## Groups
**Kind**: global class
* [Groups](#Groups)
* [.export(authorization_bearer)](#Groups.export)
* [.import(body, authorization_bearer)](#Groups.import)
* [.get(authorization_bearer)](#Groups.get)
### 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](#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](#Groups)
| Param | Type | Description |
| --- | --- | --- |
| body | Object | |
| authorization_bearer | string | The client_credentials generated OAUth2 access token. |
**Example**
body
```json
{
"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
}
}
}
```
### Groups.get(authorization_bearer)
get - Get all the groups
Path: api/v1/groups
**Kind**: static method of [Groups](#Groups)
| Param | Type | Description |
| --- | --- | --- |
| authorization_bearer | string | The client_credentials generated OAUth2 access token. |
## GroupsType
**Kind**: global class
* [GroupsType](#GroupsType)
* [.all(type, authorization_bearer)](#GroupsType.all)
* [.getTypesList(authorization_bearer)](#GroupsType.getTypesList)
### GroupsType.all(type, authorization_bearer)
all - Gets all groups of a particular type
Path: api/v1/groups/type/:type
**Kind**: static method of [GroupsType](#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](#GroupsType)
| Param | Type | Description |
| --- | --- | --- |
| authorization_bearer | string | The client_credentials generated OAUth2 access token. |
## Group
**Kind**: global class
* [Group](#Group)
* [.addPermission(id, permission, authorization_bearer)](#Group.addPermission)
* [.deletePermission(id, permission, authorization_bearer)](#Group.deletePermission)
* [.addRoute(body, id, authorization_bearer)](#Group.addRoute)
* [.removeInheritance(id, inherited, grouptype, authorization_bearer)](#Group.removeInheritance)
* [.inheritFrom(id, inherited, grouptype, authorization_bearer)](#Group.inheritFrom)
* [.setDefault(id, authorization_bearer)](#Group.setDefault)
* [.delete(id, authorization_bearer)](#Group.delete)
* [.edit(body, id, authorization_bearer)](#Group.edit)
* [.get(id, authorization_bearer)](#Group.get)
* [.createByName(id, authorization_bearer)](#Group.createByName)
* [.create(body, authorization_bearer)](#Group.create)
### 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](#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](#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.
```javascript
{
"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](#Group)
| Param | Type | Description |
| --- | --- | --- |
| body | Object | |
| id | any | |
| authorization_bearer | string | The client_credentials generated OAUth2 access token. |
**Example**
body
```json
{
"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](#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](#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](#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](#Group)
| Param | Type | Description |
| --- | --- | --- |
| id | any | id or name |
| 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](#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
```json
{
"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](#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](#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](#Group)
| Param | Type | Description |
| --- | --- | --- |
| body | Object | |
| authorization_bearer | string | The client_credentials generated OAUth2 access token. |
**Example**
body
```json
{
"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
}
```
## GroupUsers
**Kind**: global class
* [GroupUsers](#GroupUsers)
* [.inherited(id)](#GroupUsers.inherited)
* [.get(id)](#GroupUsers.get)
### 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](#GroupUsers)
| Param | Type | Description |
| --- | --- | --- |
| id | any | id or name (example: superadmin) |
### GroupUsers.get(id)
get - Gets all the users that belong to the group.
##### 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
**Kind**: static method of [GroupUsers](#GroupUsers)
| Param | Type | Description |
| --- | --- | --- |
| id | any | id or name (example: superadmin) |
## GroupUser
**Kind**: global class
* [GroupUser](#GroupUser)
* [.delete(group, type, id, authorization_bearer)](#GroupUser.delete)
* [.removeGroupInheritance(group, type, id, inheritgroupid, inheritgrouptype, authorization_bearer)](#GroupUser.removeGroupInheritance)
* [.addGroupInheritance(group, type, id, inheritgroupid, inheritgrouptype, authorization_bearer)](#GroupUser.addGroupInheritance)
* [.editPropertyValue(group, type, id, property, value, authorization_bearer)](#GroupUser.editPropertyValue)
* [.editProperty(body, group, type, id, property, authorization_bearer)](#GroupUser.editProperty)
* [.edit(body, group, type, id, authorization_bearer)](#GroupUser.edit)
* [.getProperty(group, type, id, property, authorization_bearer)](#GroupUser.getProperty)
* [.get(group, type, id, authorization_bearer)](#GroupUser.get)
### 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](#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](#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](#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](#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](#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
```json
{
"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](#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
```json
{
"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](#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](#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](#GroupType)
* [.deletePermission(id, type, permission, authorization_bearer)](#GroupType.deletePermission)
* [.addPermission(id, type, permission, authorization_bearer)](#GroupType.addPermission)
* [.addRoute(body, id, type, authorization_bearer)](#GroupType.addRoute)
* [.removeInheritance(id, type, inherited, grouptype, authorization_bearer)](#GroupType.removeInheritance)
* [.inheritFrom(id, type, inherited, grouptype, authorization_bearer)](#GroupType.inheritFrom)
* [.setDefault(id, type)](#GroupType.setDefault)
* [.delete(id, type, authorization_bearer)](#GroupType.delete)
* [.get(id, type, authorization_bearer)](#GroupType.get)
* [.edit(body, id, type, authorization_bearer)](#GroupType.edit)
* [.createByName(id, type, authorization_bearer)](#GroupType.createByName)
* [.create(body, type, authorization_bearer)](#GroupType.create)
### 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](#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](#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.
```javascript
{
"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](#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
```json
{
"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](#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](#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](#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](#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](#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](#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
```json
{"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](#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](#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
```json
{
"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](#GroupTypeUsers)
* [.get(id, type)](#GroupTypeUsers.get)
* [.inherited(id, type)](#GroupTypeUsers.inherited)
### GroupTypeUsers.get(id, type)
get - Gets all the users that belong to the group of a particular type by its name or id.
##### 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
**Kind**: static method of [GroupTypeUsers](#GroupTypeUsers)
| Param | Type |
| --- | --- |
| id | any |
| type | any |
### 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](#GroupTypeUsers)
| Param | Type | Description |
| --- | --- | --- |
| id | any | (example: group4) |
| type | any | The type of the group (example: groups) |
## GroupTypeUser
**Kind**: global class
* [GroupTypeUser](#GroupTypeUser)
* [.delete(type, id, authorization_bearer)](#GroupTypeUser.delete)
* [.removeGroupInheritance(type, id, inheritgroupid, inheritgrouptype, authorization_bearer)](#GroupTypeUser.removeGroupInheritance)
* [.addGroupInheritance(type, id, inheritgroupid, inheritgrouptype, authorization_bearer)](#GroupTypeUser.addGroupInheritance)
* [.editPropertyValue(type, id, property, value, authorization_bearer)](#GroupTypeUser.editPropertyValue)
* [.editProperty(body, type, id, property, authorization_bearer)](#GroupTypeUser.editProperty)
* [.edit(body, type, id, authorization_bearer)](#GroupTypeUser.edit)
* [.getProperty(type, id, property, authorization_bearer)](#GroupTypeUser.getProperty)
* [.get(type, id, authorization_bearer)](#GroupTypeUser.get)
### 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](#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](#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](#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](#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](#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
```json
{
"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](#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
```json
{
"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](#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](#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](#GroupRequestUser)
* [.delete(body, type, id, authorization_bearer)](#GroupRequestUser.delete)
* [.addGroupInheritance(type, id, inheritgroupid, inheritgrouptype, authorization_bearer)](#GroupRequestUser.addGroupInheritance)
* [.editProperty(body, type, id, property, authorization_bearer)](#GroupRequestUser.editProperty)
* [.edit(body, type, id, authorization_bearer)](#GroupRequestUser.edit)
### 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](#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
```json
{
"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](#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](#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
```json
"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](#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
```json
{
"locked": false
}
```
## Users
**Kind**: global class
* [Users](#Users)
* [.byGroupRequest(group_request, authorization_bearer)](#Users.byGroupRequest)
* [.get(sort, limit, filter, sortdir, authorization_bearer)](#Users.get)
### 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](#Users)
| Param | Type | Description |
| --- | --- | --- |
| group_request | any | name of the group (example: superadmin) |
| authorization_bearer | string | The client_credentials generated OAUth2 access token. |
### Users.get(sort, limit, filter, sortdir, authorization_bearer)
get - Gets all the users
##### 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
**Kind**: static method of [Users](#Users)
| Param | Type | Description |
| --- | --- | --- |
| sort | any | (example: created_on) |
| limit | any | (example: 200) |
| filter | any | (example: locked=false) |
| sortdir | any | (example: ASC) |
| authorization_bearer | string | The client_credentials generated OAUth2 access token. |
## UsersDomain
**Kind**: global class
### UsersDomain.get(domain, sort, limit, filter, sortdir, authorization_bearer)
get - Gets all the users
##### 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/domain/:domain
**Kind**: static method of [UsersDomain](#UsersDomain)
| Param | Type | Description |
| --- | --- | --- |
| domain | any | (example: traziventures.com) |
| sort | any | (example: created_on) |
| limit | any | (example: 200) |
| filter | any | (example: locked=false) |
| sortdir | any | (example: ASC) |
| authorization_bearer | string | The client_credentials generated OAUth2 access token. |
## User
**Kind**: global class
* [User](#User)
* [.delete(id, authorization_bearer)](#User.delete)
* [.removeGroupInheritance(id, inheritgroupid, inheritgrouptype, authorization_bearer)](#User.removeGroupInheritance)
* [.addGroupInheritance(id, inheritgroupid, inheritgrouptype, authorization_bearer)](#User.addGroupInheritance)
* [.editPropertyValue(id, property, value, authorization_bearer)](#User.editPropertyValue)
* [.editProperty(body, id, property, authorization_bearer)](#User.editProperty)
* [.edit(body, id, authorization_bearer)](#User.edit)
* [.getProperty(id, property, authorization_bearer)](#User.getProperty)
* [.get(id, authorization_bearer)](#User.get)
### User.delete(id, authorization_bearer)
delete - Delete a user by it's Id.
Path: api/v1/user/id/:id
**Kind**: static method of [User](#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](#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. |
### 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](#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. |
### 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](#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.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](#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
```text
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](#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
```json
{
"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](#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](#User)
| Param | Type | Description |
| --- | --- | --- |
| id | any | (example: 39A2BC37-61AE-434C-B245-A731A27CF8DA) |
| authorization_bearer | string | The client_credentials generated OAUth2 access token. |
## UserCurrent
**Kind**: global class
* [UserCurrent](#UserCurrent)
* [.registerToken(body, authorization_bearer)](#UserCurrent.registerToken)
* [.removeGroupInheritance(inheritgroupid, inheritgrouptype, authorization_bearer)](#UserCurrent.removeGroupInheritance)
* [.addGroupInheritance(inheritgroupid, inheritgrouptype, authorization_bearer)](#UserCurrent.addGroupInheritance)
* [.editPropertyValue(property, value, authorization_bearer)](#UserCurrent.editPropertyValue)
* [.editProperty(body, property, authorization_bearer)](#UserCurrent.editProperty)
* [.deleteToken(id, authorization_bearer)](#UserCurrent.deleteToken)
* [.edit(body, authorization_bearer)](#UserCurrent.edit)
* [.getProperty(property, authorization_bearer)](#UserCurrent.getProperty)
* [.routeCheck(method, route, authorization_bearer)](#UserCurrent.routeCheck)
* [.permissionCheck(permission, authorization_bearer)](#UserCurrent.permissionCheck)
* [.get(authorization_bearer)](#UserCurrent.get)
### 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](#UserCurrent)
| Param | Type | Description |
| --- | --- | --- |
| body | Object | |
| authorization_bearer | string | The client_credentials generated OAUth2 access token. |
**Example**
body
```json
{
"name": "conversate"
}
```
### 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](#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](#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.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](#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.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](#UserCurrent)
| Param | Type | Description |
| --- | --- | --- |
| body | Object | |
| property | any | (example: user_data) |
| authorization_bearer | string | The client_credentials generated OAUth2 access token. |
**Example**
body
```json
{
"test": 123
}
```
### 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](#UserCurrent)
| Param | Type | Description |
| --- | --- | --- |
| id | any | id or name of the token |
| 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](#UserCurrent)
| Param | Type | Description |
| --- | --- | --- |
| body | Object | |
| authorization_bearer | string | The client_credentials generated OAUth2 access token. |
**Example**
body
```json
{
"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](#UserCurrent)
| Param | Type | Description |
| --- | --- | --- |
| property | any | (example: username) |
| authorization_bearer | string | The client_credentials generated OAUth2 access token. |
### 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](#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](#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](#UserCurrent)
| Param | Type | Description |
| --- | --- | --- |
| authorization_bearer | string | The client_credentials generated OAUth2 access token. |
## Auth
#### Auth endpoints
**Kind**: global class
* [Auth](#Auth)
* [.accessToken()](#Auth.accessToken)
* [.authorize(client_id, response_type, state, redirect_uri, group_request)](#Auth.authorize)
* [.activate(token)](#Auth.activate)
* [.resetPasswordAutoLogin(body, token)](#Auth.resetPasswordAutoLogin)
* [.resetPassword(body, token)](#Auth.resetPassword)
* [.forgotPassword(body)](#Auth.forgotPassword)
* [.logout()](#Auth.logout)
* [.login(body)](#Auth.login)
* [.register(body)](#Auth.register)
### 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)
### 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](#Auth)
| Param | Type |
| --- | --- |
| client_id | any |
| response_type | any |
| state | any |
| redirect_uri | any |
| group_request | any |
### Auth.activate(token)
activate - Activates and unlocks user
Path: api/v1/auth/activate
**Kind**: static method of [Auth](#Auth)
| Param | Type | Description |
| --- | --- | --- |
| token | any | (example: activation_token) |
### Auth.resetPasswordAutoLogin(body, 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](#Auth)
| Param | Type | Description |
| --- | --- | --- |
| body | Object | |
| token | any | (example: [thegeneratedtoken]) |
**Example**
body
```json
{
"password":"asdf"
}
```
### Auth.resetPassword(body, token)
resetPassword - Resets the password if the recovery token is valid of the user.
Path: api/v1/auth/password/reset
**Kind**: static method of [Auth](#Auth)
| Param | Type | Description |
| --- | --- | --- |
| body | Object | |
| token | any | (example: [thegeneratedtoken]) |
**Example**
body
```json
{
"password":"asdf"
}
```
### Auth.forgotPassword(body)
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](#Auth)
| Param | Type |
| --- | --- |
| body | Object |
**Example**
body
```json
{
"email": "test@test.com"
}
```
### Auth.logout()
logout -
Path: api/v1/auth/logout
**Kind**: static method of [Auth](#Auth)
### Auth.login(body)
login - Register a user
Path: api/v1/auth/login
**Kind**: static method of [Auth](#Auth)
| Param | Type |
| --- | --- |
| body | Object |
**Example**
body
```json
{
"username": "test",
"password": "Pas5w0r!d",
"domain": "default"
}
```
### Auth.register(body)
register - Register a user
`group_request` is optional.
Path: api/v1/auth/register
**Kind**: static method of [Auth](#Auth)
| Param | Type |
| --- | --- |
| body | Object |
**Example**
body
```json
{
"username":"test",
"password":"Pas5w0r!d",
"email": "test@test.com",
"domain": "default"
}
```
## AuthToken
**Kind**: global class
### 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/password/forgot
**Kind**: static method of [AuthToken](#AuthToken)
| Param | Type |
| --- | --- |
| body | Object |
**Example**
body
```json
{
"email": "test@test.com"
}
```
## AuthDomain
**Kind**: global class
* [AuthDomain](#AuthDomain)
* [.forgotPassword(body, domain)](#AuthDomain.forgotPassword)
* [.login(body, domain)](#AuthDomain.login)
* [.register(body, domain)](#AuthDomain.register)
### AuthDomain.forgotPassword(body, domain)
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](#AuthDomain)
| Param | Type | Description |
| --- | --- | --- |
| body | Object | |
| domain | any | (example: test.com) |
**Example**
body
```json
{
"email": "test@test.com"
}
```
### AuthDomain.login(body, domain)
login - Register a user
Path: api/v1/auth/login/domain/:domain
**Kind**: static method of [AuthDomain](#AuthDomain)
| Param | Type | Description |
| --- | --- | --- |
| body | Object | |
| domain | any | (example: test.com) |
**Example**
body
```json
{
"username": "test",
"password": "Pas5w0r!d",
"domain": "default"
}
```
### AuthDomain.register(body, domain)
register - Register a user
`group_request` is optional.
Path: api/v1/auth/register/domain/:domain
**Kind**: static method of [AuthDomain](#AuthDomain)
| Param | Type | Description |
| --- | --- | --- |
| body | Object | |
| domain | any | (example: test.com) |
**Example**
body
```json
{
"username":"test",
"password":"Pas5w0r!d",
"email": "test@test.com"
}
```
## AuthDomainToken
**Kind**: global class
### AuthDomainToken.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/password/forgot
**Kind**: static method of [AuthDomainToken](#AuthDomainToken)
| Param | Type |
| --- | --- |
| body | Object |
**Example**
body
```json
{
"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](https://github.com/Phara0h/Fasquest) (example: {headers: {'API-KEY':'34098hodf'}}) |
**Example**
init
```js
const { Travelling } = require('./sdk.js')('http://127.0.0.1');
```
## Changelog
#### [v2.5.2](https://github.com/Phara0h/travelling/compare/v2.5.1...v2.5.2)
- Updated to ignore /health and /metrics logs outs [`e530288`](https://github.com/Phara0h/travelling/commit/e5302887065b9c3c4aaa6bc6ac27f8e8a88b7420)
- Updated SDK [`d52feec`](https://github.com/Phara0h/travelling/commit/d52feec090bd96ccfdd16df1c8f318c7a66bd10f)
- Update Travelling.postman_collection.json [`1435319`](https://github.com/Phara0h/travelling/commit/1435319c14771389a15ed0d4b5939b9d9b7e7dea)
#### [v2.5.1](https://github.com/Phara0h/travelling/compare/v2.5.0...v2.5.1)
> 3 May 2021
- Update index.js [`12d527f`](https://github.com/Phara0h/travelling/commit/12d527f12609ea9cb90b7c526f0265c3e2fe84f1)
#### [v2.5.0](https://github.com/Phara0h/travelling/compare/v2.4.2...v2.5.0)
> 3 May 2021
- Update Travelling.postman_collection.json [`40e95d2`](https://github.com/Phara0h/travelling/commit/40e95d244ccaa3f66ce57aa0179f750833ea27b6)
- Started work on add traces throughout code [`dfe93dd`](https://github.com/Phara0h/travelling/commit/dfe93dd291233aa72989998d1053f05a03949295)
#### [v2.4.2](https://github.com/Phara0h/travelling/compare/v2.4.1...v2.4.2)
> 13 April 2021
- Added fix for when there is no default group it defaults to anonymous [`bd1abda`](https://github.com/Phara0h/travelling/commit/bd1abdae0763bef0a7d9b5d7e9c872498ef6ae27)
#### [v2.4.1](https://github.com/Phara0h/travelling/compare/v2.4.0...v2.4.1)
> 7 April 2021
- Fixed some bugs, removed /metrics and /health from logs [`7b98a92`](https://github.com/Phara0h/travelling/commit/7b98a92393b932ec0d062aa6a641cd2589f53a21)
#### [v2.4.0](https://github.com/Phara0h/travelling/compare/v2.3.1...v2.4.0)
> 7 April 2021
- added more unique req headers coming from travelling. [`a77da6e`](https://github.com/Phara0h/travelling/commit/a77da6e6cf21d86a037e29082c7701a8d966fde0)
#### [v2.3.1](https://github.com/Phara0h/travelling/compare/v2.3.0...v2.3.1)
> 31 March 2021
- Fixed a bug for cookie session expiration length [`ae6dd7c`](https://github.com/Phara0h/travelling/commit/ae6dd7c6e2c935d4976fcda944e0ce02b84d93de)
#### [v2.3.0](https://github.com/Phara0h/travelling/compare/v2.2.0...v2.3.0)
> 31 March 2021
#### [v2.2.0](https://github.com/Phara0h/travelling/compare/v2.1.0...v2.2.0)
> 31 March 2021
- Update SDK and added Resetpassword with autologin endpoint and forgot password token endpoints. [`9cb2d8e`](https://github.com/Phara0h/travelling/commit/9cb2d8e4cc2e4a2f14ee56dd04cbbd5ba32a39ab)
#### [v2.1.0](https://github.com/Phara0h/travelling/compare/v2.0.0...v2.1.0)
> 19 March 2021
- Added options to handle using external email validation service and updated docs [`b3279da`](https://github.com/Phara0h/travelling/commit/b3279dadab2d009356e36cd9f773d21a0140a0fd)
### [v2.0.0](https://github.com/Phara0h/travelling/compare/v1.3.3...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`](https://github.com/Phara0h/travelling/commit/c59510475bb6e792271a0ffae8f8bba7596a6728)
#### [v1.3.3](https://github.com/Phara0h/travelling/compare/v1.3.2...v1.3.3)
> 2 March 2021
- possible cloudflare headers fix [`3aaeab2`](https://github.com/Phara0h/travelling/commit/3aaeab24ca79d5fd12b852942b4097de8ff37abf)
#### [v1.3.2](https://github.com/Phara0h/travelling/compare/v1.3.1...v1.3.2)
> 2 March 2021
- Fixed bug of proxying urls that start with the serviceName and have a host [`c6b70b4`](https://github.com/Phara0h/travelling/commit/c6b70b41ed70fe3888a5643d583b9689c555ee68)
#### [v1.3.1](https://github.com/Phara0h/travelling/compare/v1.3.0...v1.3.1)
> 2 March 2021
- typo [`3be0a65`](https://github.com/Phara0h/travelling/commit/3be0a6540aeb8b927b0b26f05cb6cdde2d7e2343)
#### [v1.3.0](https://github.com/Phara0h/travelling/compare/v1.2.1...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`](https://github.com/Phara0h/travelling/commit/958be2067dd5d90b57495989fcbe27a843ecf162)
- Added login by domain in postman / sdk [`04ab374`](https://github.com/Phara0h/travelling/commit/04ab374b629d09248c8280163ce989234ba24530)
#### [v1.2.1](https://github.com/Phara0h/travelling/compare/v1.2.1-0...v1.2.1)
> 17 February 2021
- Fixed bug with auth when usernames disabled [`00fe0bb`](https://github.com/Phara0h/travelling/commit/00fe0bb973d384d7fe8becb18d95e3989e87baef)
#### [v1.2.1-0](https://github.com/Phara0h/travelling/compare/v1.2.0...v1.2.1-0)
> 17 February 2021
- Updated logo in readme [`2079591`](https://github.com/Phara0h/travelling/commit/20795916dbbe00bd9f656b2834241b19abcf5b86)
#### [v1.2.0](https://github.com/Phara0h/travelling/compare/v1.1.1...v1.2.0)
> 17 February 2021
#### [v1.1.1](https://github.com/Phara0h/travelling/compare/v1.1.1-1...v1.1.1)
> 17 February 2021
#### [v1.1.1-1](https://github.com/Phara0h/travelling/compare/v1.1.0...v1.1.1-1)
> 17 February 2021
- Update npm-publish.yml [`b15cfbe`](https://github.com/Phara0h/travelling/commit/b15cfbe04a532b20346f2bef18af48596551ff00)
- Update .gitignore [`ddda22f`](https://github.com/Phara0h/travelling/commit/ddda22fd1dbead54dc17c7eb2d442ce23a08951f)
- Delete package-lock.json [`2c7afb9`](https://github.com/Phara0h/travelling/commit/2c7afb921f3e2e36e97ce648e9be082ca7dda271)
- Update npm-publish.yml [`1d5ba20`](https://github.com/Phara0h/travelling/commit/1d5ba202d5d87fe47a08948dd1e2f2bd15a52d8e)
- Update npm-publish.yml [`30f57ef`](https://github.com/Phara0h/travelling/commit/30f57ef5fec492533ae725080eb6e830da5a0846)
- Update npm-publish.yml [`8c1692f`](https://github.com/Phara0h/travelling/commit/8c1692f321ddaa4f0e4fc45bbda1cd7c6fde660e)
- Create npm-publish.yml [`7066bdf`](https://github.com/Phara0h/travelling/commit/7066bdf0f9b939e65a15f2e4301f57fe0de6b02f)
- Removed console logs from dev [`d88d0b6`](https://github.com/Phara0h/travelling/commit/d88d0b6daff83706b81ca507c8a95edf4e58c01e)
#### [v1.1.0](https://github.com/Phara0h/travelling/compare/v1.0.0...v1.1.0)
> 17 February 2021
- Fixed some auto doc stuff [`7bac291`](https://github.com/Phara0h/travelling/commit/7bac29170b71b8d005f2733c4ee830da34b0ae69)
- General cleanup, added posgres config settings, and doc reorg [`d84a3f8`](https://github.com/Phara0h/travelling/commit/d84a3f8131099f294ebb4f4112fd98752635fed0)
- Update user-get.js [`5e9ec0e`](https://github.com/Phara0h/travelling/commit/5e9ec0eab0701035b997a39609ec9003e70f0e72)
#### v1.0.0
> 12 February 2021
- Bump minimist from 1.2.0 to 1.2.5 in /client [`#4`](https://github.com/Phara0h/travelling/pull/4)
- Bump acorn from 7.0.0 to 7.1.1 in /client [`#5`](https://github.com/Phara0h/travelling/pull/5)
- Eng 1037 [`#3`](https://github.com/Phara0h/travelling/pull/3)
- Merg [`#2`](https://github.com/Phara0h/travelling/pull/2)
- a [`#1`](https://github.com/Phara0h/travelling/pull/1)
- Updated to latest fastify, fixed some bugs and added domain field to users [`74f9001`](https://github.com/Phara0h/travelling/commit/74f900114425ea264dde8e0585e4ffac86c62849)
- Fixed npm package vulnerabilities [`2ded3c7`](https://github.com/Phara0h/travelling/commit/2ded3c76aa3dccb97783fd3ad1ebff57e05370c9)
- Removed node-utils depends and fixed tests [`e8c8f60`](https://github.com/Phara0h/travelling/commit/e8c8f60521ad5c3b6492a70b609d7b1e1ce7a737)
- [ENG-1037] - removed logging and fixed an error message [`2717223`](https://github.com/Phara0h/travelling/commit/27172233316b58c08f82e76dd09628f2d8178ec1)
- [ENG-1037] - added redirect after logout [`324dc9d`](https://github.com/Phara0h/travelling/commit/324dc9de1735c48e17fff38e7a620a2c87274864)
- [ENG-1037] - some email reg and reset fixes/cleanup [`050f6af`](https://github.com/Phara0h/travelling/commit/050f6af47b8888d999d55915c274d17859f73160)
- [ENG-1037] - fixed some tests and added wider ranges. [`5a9e64c`](https://github.com/Phara0h/travelling/commit/5a9e64cd88377082be4d164bb63fbf3a771d8c0b)
- [ENG-1037] - Removed passwords from responses, added configs for web and misc fixes [`775ed7f`](https://github.com/Phara0h/travelling/commit/775ed7f9f37e9e41ef4fadc3fa62f2cd616b3f8e)
- [ENG-1037] - misc fixes. [`fa9d8f4`](https://github.com/Phara0h/travelling/commit/fa9d8f49d59470e291940ee3d6c33dc725004747)
- [ENG-1037] - regen [`4e08024`](https://github.com/Phara0h/travelling/commit/4e080247652b6c279ba465b5044dfa1fd65706e8)
- [ENG-1037] - added new function to sdk [`d705b97`](https://github.com/Phara0h/travelling/commit/d705b97c91a9568b015d627e2de2529916e0177b)
- [ENG-1037] - console logs removed [`84cc11e`](https://github.com/Phara0h/travelling/commit/84cc11e2b8b3d59c666294eeafdbb80928be90b0)
- [ENG-1037] - Lots of cleanup on routes and bug fixes [`474b788`](https://github.com/Phara0h/travelling/commit/474b78895d1cd8cd3328f20ee7cc6b4d84186f4b)
- [ENG-1037] - Users can have multi groups, more test & misc fixes [`cec0448`](https://github.com/Phara0h/travelling/commit/cec0448948a5080d000331240bb40caa17c5eba5)
- [ENG-1037] - Added edit property value for path params [`d4ce2d8`](https://github.com/Phara0h/travelling/commit/d4ce2d86e90731c648322a959d7993d3eace5a2e)
- [ENG-1037] - Added logs in catches, fixes for node-utils crypto and misc [`2ff033c`](https://github.com/Phara0h/travelling/commit/2ff033cef57141cf46a30bfdce4ab395d1211505)
- [ENG-1037] - Added in recho as our test server [`87cccf8`](https://github.com/Phara0h/travelling/commit/87cccf88549f938fc8b129d8ffb9a8de643b0e24)
- [ENG-1037] - cleanup [`486d2ad`](https://github.com/Phara0h/travelling/commit/486d2ade896960f84fe408e10554ad44663bf33c)
- [ENG-1037] - changed removeFromPath to remove_from_path for consistency [`1f71307`](https://github.com/Phara0h/travelling/commit/1f71307716ac1d23f383b885236add27ddc317c0)
- [ENG-1037] - more clean up on exports [`c53401f`](https://github.com/Phara0h/travelling/commit/c53401f8459c216019b05f69cd841ba15ccf7b57)
- [ENG-1037] - added a few more routes, type scoped names, tests & clean ups [`20c1673`](https://github.com/Phara0h/travelling/commit/20c1673d81f1adb4503f3896d4dbf1ea581b2188)
- [ENG-1037] - Added * urls for tokens [`191e709`](https://github.com/Phara0h/travelling/commit/191e7096e9f400f130b6d8ff08722f06edb4adef)
- [ENG-1037] - added /group/type/:type/user/:id/:property [`f4ba5fe`](https://github.com/Phara0h/travelling/commit/f4ba5fe16bbdcd650c6f29d10ac0d7fbe103d3b5)
- [ENG-1037] - cleanup [`d36cef2`](https://github.com/Phara0h/travelling/commit/d36cef26865d69d282d382d749d6a351e5e5ddc5)
- [ENG-1037] - Added more tests, fixed bugs test found and added 2 more routes. [`681dbcd`](https://github.com/Phara0h/travelling/commit/681dbcdbe03350070a84491f1e7041582f943fe8)
- [ENG-1037] - Updated travelling sdk [`195f971`](https://github.com/Phara0h/travelling/commit/195f971552312e4fc403e65f1c237e8972df0b84)
- [ENG-1037] - Fixed bug with groups and other stuff [`7ab46f9`](https://github.com/Phara0h/travelling/commit/7ab46f99a1400c68c88b897f097234682aac37a6)
- [ENG-1037] - Added import and export of groups. [`f6e18bc`](https://github.com/Phara0h/travelling/commit/f6e18bcd34f4299ac22f5c0a7eaedc9aff279e85)
- [ENG-1037] - More docs [`a5dbbc6`](https://github.com/Phara0h/travelling/commit/a5dbbc612a246e47b552b7321d8e2ef5ef69ac50)
- [ENG-1037] - More docs [`7a73d5c`](https://github.com/Phara0h/travelling/commit/7a73d5ca120cf83f4001a404a7f7e6fd0a1dd4b3)
- [ENG-1037] - fixes [`468851a`](https://github.com/Phara0h/travelling/commit/468851a32eca92ec313138fe56f98122964f0a33)
- [ENG-1037] - More docs [`eb4806a`](https://github.com/Phara0h/travelling/commit/eb4806a0abc3a9c4c798cfb218219ec6e52a9579)
- [ENG-1037] - More docs [`19d02a8`](https://github.com/Phara0h/travelling/commit/19d02a8e9bb674c32b31416304ae6f17e80a9e94)
- [ENG-1037] - More docs [`8489fad`](https://github.com/Phara0h/travelling/commit/8489fad09b436abff26af796f7deaf8f35478b88)
- [ENG-1037] - style changes [`83c2214`](https://github.com/Phara0h/travelling/commit/83c2214a17d9a79af1189216ebf4f2be1ab4c567)
- [ENG-1037] - Start of readme docs [`cf5b28c`](https://github.com/Phara0h/travelling/commit/cf5b28c705e5f9aa7dc672d9006f329430f8ad21)
- [ENG-1037] - Secured oauth code token flow `rfc6749#section-10.6` and some cleanup [`8f96cec`](https://github.com/Phara0h/travelling/commit/8f96cec18ff26290b6290409a508a8e04b6f7438)
- [ENG-1037] - Changed styling on the toasts [`0e41b3a`](https://github.com/Phara0h/travelling/commit/0e41b3ad7cf317208d62f2ae92d584a8fa9d1622)
- [ENG-1037] - Fixed auth code flow [`567ac30`](https://github.com/Phara0h/travelling/commit/567ac30213d072179a6cc7437c10092e67e4c4fc)
- [ENG-1037] - fixed memory token store [`ab100f0`](https://github.com/Phara0h/travelling/commit/ab100f04b7041184366a98d7b3407e9aa848f2a7)
- [ENG-1037] - added faicon in default anon group. [`efa3e13`](https://github.com/Phara0h/travelling/commit/efa3e132820323c781206fb2b76a6bf79fac0e74)
- [ENG-1037] - Misc bug fixes and onboarding page is done. [`47b7f2a`](https://github.com/Phara0h/travelling/commit/47b7f2afcf680f818e0bd866bc4eacfb95aedff2)
- [ENG-1037] - Massive cleanup and new login/reg page [`f1f0383`](https://github.com/Phara0h/travelling/commit/f1f0383f07cdecb72e40c77325365f00cd9647fe)
- [ENG-1037] - Improved Authorization Code Grant to be true SSO one-click [`ba84e61`](https://github.com/Phara0h/travelling/commit/ba84e6186d8c4789b1b02b8973717ff4d5a57332)
- [ENG-1037] - Added crappy login/reg page for Authorization Code Grant [`f6cf3a3`](https://github.com/Phara0h/travelling/commit/f6cf3a33899e4d4ef9e219a16d2f42beb63c4ef0)
- [ENG-1037] - Added redis support for multi service running. [`899609d`](https://github.com/Phara0h/travelling/commit/899609dd2092649caf5f98d2a8e6b57df16207c7)
- [ENG-1037] - Circular Group Inheritance protection and tests [`bcf6be0`](https://github.com/Phara0h/travelling/commit/bcf6be09d15da3e47fc6080802c0e839468d0fe9)
- [ENG-1037] - Updated log in email [`3e0a09d`](https://github.com/Phara0h/travelling/commit/3e0a09d23e10e477d5e781392faf168bef43aa60)
- [ENG-1037] - fastify logging settings [`e68ed82`](https://github.com/Phara0h/travelling/commit/e68ed828680a5a69fd125a3b7c759956b6180b78)
- [ENG-1037] - Fixed tests [`75baa97`](https://github.com/Phara0h/travelling/commit/75baa9766a09c0525d15ba5854dd89a1cd8cb766)
- [ENG-1037] - Added user methods by group type and name & cleaned up route paths [`da4ddd6`](https://github.com/Phara0h/travelling/commit/da4ddd6f23bacc7b1db5b4990c2c3547225ed450)
- [ENG-1037] - added get all users by group request endpoint [`b02b9d8`](https://github.com/Phara0h/travelling/commit/b02b9d8d1b744fcd7dfb544ebc0ef73447871a1a)
- [ENG-1037] - Added user query filtering to all routes dealing with users [`ec2e9a4`](https://github.com/Phara0h/travelling/commit/ec2e9a47b812ada3509aa1104d5a3c99108b8c55)
- [ENG-1037] - Added grouptype to dynamic route props [`c25b8a2`](https://github.com/Phara0h/travelling/commit/c25b8a2e44a5c33d8a2004b3d97306292be0ab46)
- [ENG-1037] - Added more group endpoints and cleaned up a bit [`761d12b`](https://github.com/Phara0h/travelling/commit/761d12b9f33a17079723a12d182ae2c5b8ffbaec)
- [ENG-1037] - Added group_request to registration and 'users' now has query search [`8c229d0`](https://github.com/Phara0h/travelling/commit/8c229d03b2228769e6c81a2f5870c5639ff37244)
- [ENG-1037] - removed console log [`4e91cba`](https://github.com/Phara0h/travelling/commit/4e91cba40b029650a97a80ddf6c2ad58bfc6adab)
- [ENG-1037] - ip hijacking option [`cd26e30`](https://github.com/Phara0h/travelling/commit/cd26e30a317dc9c7518d619f9447b9039f985774)
- [ENG-1037] - Docs push for real this time [`a2b2306`](https://github.com/Phara0h/travelling/commit/a2b23065a25426400fd7842dc6df4e13639a74e1)
- [ENG-1037] - Token tests added, sdk docs and misc [`037e7ec`](https://github.com/Phara0h/travelling/commit/037e7ece1f8c25a3da82a1927fbbfcc3183066f6)
- [ENG-1037] - Token fixes and client_id with custom name [`3188130`](https://github.com/Phara0h/travelling/commit/31881304941c9f0b64e2fd5b20652c4216efdfe1)
- [ENG-1037] - Added OAuth2 client_credentials flow & Other misc things [`91a1e6b`](https://github.com/Phara0h/travelling/commit/91a1e6bac5b0d04b167e9a74f21dfb5cbf70e0d8)
- [ENG-1037] - misc things [`c93330d`](https://github.com/Phara0h/travelling/commit/c93330d37f04f136c51ee326d05eb55de3cce085)
- [ENG-1037] - Added more test and fixed bugs found with them. [`415d2db`](https://github.com/Phara0h/travelling/commit/415d2dbcb85f6c17fbaa8621b925c1e1181b08c9)
- [ENG-1037] - Start of tests, logging and misc bug crushing [`bc3363a`](https://github.com/Phara0h/travelling/commit/bc3363a799ea0f848a1de89051d84f9e2df4f246)
- [ENG-1037] - Email activation, user updates routes, and lots of misc fixes [`1161b57`](https://github.com/Phara0h/travelling/commit/1161b57a1d4ee5444ce15626af2a87eb79d6f9c2)
- [ENG-1037] - Forgot password emailing working with smtp, SES and test [`eef0724`](https://github.com/Phara0h/travelling/commit/eef0724d919b93b34ea08ff195a6fd3546535511)
- [ENG-1037] - Fixed bugs with reset and forget password [`969aa85`](https://github.com/Phara0h/travelling/commit/969aa8507e405d7fb6486359a330da3c4dd94095)
- [ENG-1037] - Added forgot password logic [`f09403f`](https://github.com/Phara0h/travelling/commit/f09403faadb3a882f23681ed6019c330b846606f)
- [ENG-1037] - Added more user & group API endpoints [`5cfc766`](https://github.com/Phara0h/travelling/commit/5cfc7660ac620d5b15cd9217caf68cb00d6fa8ac)
- [ENG-1037] - Got routing and auth up to being ready and added some user routes [`83de3fd`](https://github.com/Phara0h/travelling/commit/83de3fd46bfe217dd0d46a468fa26c3bd93042e5)
- [ENG-1037] - added portal static file hosting [`565eb2d`](https://github.com/Phara0h/travelling/commit/565eb2d96f73eaf416ef73cfe4c7638b18c17699)
- [ENG-1037] - Added routing for reverse proxy, still WIP but seems to work. [`47a254f`](https://github.com/Phara0h/travelling/commit/47a254f0f139c34dc68c311845315de184540538)
- Auth sessions and tokens login, logout and register are done [`05eea6e`](https://github.com/Phara0h/travelling/commit/05eea6eb2b34bdceb6996998a89bd4e6e88bbd83)
- Token work done [`b3592c6`](https://github.com/Phara0h/travelling/commit/b3592c60cb11f4d77d3435077b0103169f1c3dd1)
- Start of code base [`2e1b949`](https://github.com/Phara0h/travelling/commit/2e1b9498199f39d3fa94d9b4952d5bc9e9b671a0)
- Initial commit [`e2f3b07`](https://github.com/Phara0h/travelling/commit/e2f3b07853066c9a825a01caa98f3dc5859db38a)
## License
MIT 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.