![](\"https://raw.githubusercontent.com/Phara0h/travelling/master/client/assets/logo-invert.svg\"){kind=logo}
\n \n Travelling\n\n \n Travelling\nBoth requests are disabled. Dont use.
\nSDK - importing the SDK for use
\nTravelling](#Travelling) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| authorization_bearer | string | The client_credentials generated OAUth2 access token. |\n\n\n\n### Travelling.metrics(authorization_bearer)\nmetrics - servers metrics\n\nPath: metrics\n\n**Kind**: static method of [Travelling](#Travelling) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| authorization_bearer | string | The client_credentials generated OAUth2 access token. |\n\n\n\n## Config\n**Kind**: global class \n\n\n### Config.getProperty(property, authorization_bearer)\ngetProperty - Gets a property from travellings config.\n\nPath: api/v1/config/:property\n\n**Kind**: static method of [Config](#Config) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| property | any | (example: password) |\n| authorization_bearer | string | The client_credentials generated OAUth2 access token. |\n\n\n\n## Groups\n**Kind**: global class \n\n* [Groups](#Groups)\n * [.export(authorization_bearer)](#Groups.export)\n * [.import(body, authorization_bearer)](#Groups.import)\n * [.get(authorization_bearer)](#Groups.get)\n\n\n\n### Groups.export(authorization_bearer)\nexport - Exports all groups in the proper format to be imported.\n\nPath: api/v1/groups/export\n\n**Kind**: static method of [Groups](#Groups) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| authorization_bearer | string | The client_credentials generated OAUth2 access token. |\n\n\n\n### Groups.import(body, authorization_bearer)\nimport - Imports all groups from the exported format.\n\nPath: api/v1/groups/import\n\n**Kind**: static method of [Groups](#Groups) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| body | Object | |\n| authorization_bearer | string | The client_credentials generated OAUth2 access token. |\n\n**Example** \nbody\n```json\n{\n \"group\": {\n \"anonymous\": {\n \"type\": \"group\",\n \"allowed\": [\n {\n \"route\": \"/travelling/portal/*\",\n \"host\": null,\n \"name\": \"*-travelling-portal-*\"\n },\n {\n \"route\": \"/travelling/api/v1/auth/*\",\n \"host\": null,\n \"name\": \"*-travelling-api-v1-auth-*\"\n },\n {\n \"route\": \"/travelling/api/v1/user/me/route/allowed\",\n \"host\": null,\n \"method\": \"GET\",\n \"name\": \"get-travelling-api-v1-user-me-route-allowed\"\n },\n {\n \"route\": \"/travelling/api/v1/user/me/permission/allowed/*\",\n \"host\": null,\n \"method\": \"GET\",\n \"name\": \"get-travelling-api-v1-user-me-permission-allowed-*\"\n },\n {\n \"route\": \"/travelling/assets/*\",\n \"host\": null,\n \"removeFromPath\": \"/travelling/assets/\",\n \"method\": \"GET\",\n \"name\": \"get-travelling-assets-*\"\n },\n {\n \"route\": \"/travelling/api/v1/config/password\",\n \"host\": null,\n \"method\": \"GET\",\n \"name\": \"get-travelling-api-v1-config-password\"\n },\n {\n \"route\": \"/favicon.ico\",\n \"host\": null,\n \"method\": \"GET\",\n \"name\": \"get-favicon.ico\"\n }\n ],\n \"inherited\": null,\n \"is_default\": false\n },\n \"group3\": {\n \"type\": \"group\",\n \"allowed\": null,\n \"inherited\": [\n \"testgroup|group1\",\n \"group|group2\"\n ],\n \"is_default\": false\n },\n \"superadmin\": {\n \"type\": \"group\",\n \"allowed\": [\n {\n \"host\": null,\n \"route\": \"/travelling/*\",\n \"name\": \"*-travelling-*\"\n },\n {\n \"name\": \"test-one-*-three\"\n }\n ],\n \"inherited\": [\n \"group|anonymous\"\n ],\n \"is_default\": false\n },\n \"group4\": {\n \"type\": \"group\",\n \"allowed\": null,\n \"inherited\": [],\n \"is_default\": false\n },\n \"group2\": {\n \"type\": \"group\",\n \"allowed\": [\n {\n \"route\": \"/test/get\",\n \"host\": \"https://127.0.0.1:4268/:username/:group\",\n \"removeFromPath\": \"/test/get\",\n \"method\": \"GET\",\n \"name\": \"get-test-get\"\n },\n {\n \"route\": \"/test/post\",\n \"host\": \"http://127.0.0.1:4267/?id=:id&permission=:permission\",\n \"removeFromPath\": \"/test/post\",\n \"method\": \"POST\",\n \"name\": \"post-test-post\"\n }\n ],\n \"inherited\": [\n \"testgroup|group1\"\n ],\n \"is_default\": false\n },\n \"group5\": {\n \"type\": \"group\",\n \"allowed\": [\n {\n \"route\": \"/test/delete/:grouptype\",\n \"host\": \"https://127.0.0.1:4268\",\n \"removeFromPath\": \"/test/delete\",\n \"method\": \"DELETE\",\n \"name\": \"delete-test-delete-:grouptype\"\n }\n ],\n \"inherited\": [\n \"group|group4\",\n \"group|superadmin\"\n ],\n \"is_default\": true\n },\n \"group1\": {\n \"type\": \"group\",\n \"allowed\": null,\n \"inherited\": null,\n \"is_default\": false\n }\n },\n \"testgroup\": {\n \"group1\": {\n \"type\": \"testgroup\",\n \"allowed\": null,\n \"inherited\": [\n \"group|group4\"\n ],\n \"is_default\": false\n },\n \"superadmin\": {\n \"type\": \"testgroup\",\n \"allowed\": null,\n \"inherited\": null,\n \"is_default\": false\n }\n }\n}\n```\n\n\n### Groups.get(authorization_bearer)\nget - Get all the groups\n\nPath: api/v1/groups\n\n**Kind**: static method of [Groups](#Groups) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| authorization_bearer | string | The client_credentials generated OAUth2 access token. |\n\n\n\n## GroupsType\n**Kind**: global class \n\n* [GroupsType](#GroupsType)\n * [.all(type, authorization_bearer)](#GroupsType.all)\n * [.getTypesList(authorization_bearer)](#GroupsType.getTypesList)\n\n\n\n### GroupsType.all(type, authorization_bearer)\nall - Gets all groups of a particular type\n\nPath: api/v1/groups/type/:type\n\n**Kind**: static method of [GroupsType](#GroupsType) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| type | any | The type of the group |\n| authorization_bearer | string | The client_credentials generated OAUth2 access token. |\n\n\n\n### GroupsType.getTypesList(authorization_bearer)\ngetTypesList - Gets all the types of groups currently made.\n\nPath: api/v1/groups/types\n\n**Kind**: static method of [GroupsType](#GroupsType) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| authorization_bearer | string | The client_credentials generated OAUth2 access token. |\n\n\n\n## Group\n**Kind**: global class \n\n* [Group](#Group)\n * [.addPermission(id, permission, authorization_bearer)](#Group.addPermission)\n * [.deletePermission(id, permission, authorization_bearer)](#Group.deletePermission)\n * [.addRoute(body, id, authorization_bearer)](#Group.addRoute)\n * [.removeInheritance(id, inherited, grouptype, authorization_bearer)](#Group.removeInheritance)\n * [.inheritFrom(id, inherited, grouptype, authorization_bearer)](#Group.inheritFrom)\n * [.setDefault(id, authorization_bearer)](#Group.setDefault)\n * [.delete(id, authorization_bearer)](#Group.delete)\n * [.edit(body, id, authorization_bearer)](#Group.edit)\n * [.get(id, authorization_bearer)](#Group.get)\n * [.createByName(id, authorization_bearer)](#Group.createByName)\n * [.create(body, authorization_bearer)](#Group.create)\n\n\n\n### Group.addPermission(id, permission, authorization_bearer)\naddPermission - Adds a permission to a group.\n\nPath: api/v1/group/id/:id/insert/permission/:permission\n\n**Kind**: static method of [Group](#Group) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| id | any | Name of the group (example: anonymous) |\n| permission | any | Permission (example: test-one-two-*) |\n| authorization_bearer | string | The client_credentials generated OAUth2 access token. |\n\n\n\n### Group.deletePermission(id, permission, authorization_bearer)\ndeletePermission - Removes a permission/route from a group.\n\nPath: api/v1/group/id/:id/permission/:permission\n\n**Kind**: static method of [Group](#Group) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| id | any | Name of the group (example: anonymous) |\n| permission | any | Name or Route (example: test-one-two-*) |\n| authorization_bearer | string | The client_credentials generated OAUth2 access token. |\n\n\n\n### Group.addRoute(body, id, authorization_bearer)\naddRoute - Adds a route to a group.\n\n```javascript\n{\n \"route\": \"test/permissions/*\", // optional\n \"host\": null, // optional, defaults to travelling host\n \"method\": \"*\", // optional, defaults to '*'\n \"remove_from_path\": 'test/', // optional \n \"name\": \"test-permissions-*\" // Required and needs to be unqiue, defaults to method + route seperated by '-' instead of `/`\n}\n```\n\nPath: api/v1/group/id/:id/insert/route\n\n**Kind**: static method of [Group](#Group) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| body | Object | |\n| id | any | |\n| authorization_bearer | string | The client_credentials generated OAUth2 access token. |\n\n**Example** \nbody\n```json\n{\n\t\"route\": \"test/permissions/*\",\n \"host\": null, \n \"method\": \"*\", \n \"name\": \"test-permissions-*\" \n}\n```\n\n\n### Group.removeInheritance(id, inherited, grouptype, authorization_bearer)\nremoveInheritance - Removes an inheritance from a group.\n\nPath: api/v1/group/id/:id/remove/inheritance/:inherited/type/:grouptype\n\n**Kind**: static method of [Group](#Group) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| id | any | Name of the group (example: test1234) |\n| inherited | any | Name of the group to inherit from (example: group4) |\n| grouptype | any | The type of the inherited group |\n| authorization_bearer | string | The client_credentials generated OAUth2 access token. |\n\n\n\n### Group.inheritFrom(id, inherited, grouptype, authorization_bearer)\ninheritFrom - Adds an inheritance to a group.\n\nPath: api/v1/group/id/:id/inherit/from/:inherited/type/:grouptype\n\n**Kind**: static method of [Group](#Group) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| id | any | Name of the group (example: test1234) |\n| inherited | any | Name of the group to inherit from (example: group4) |\n| grouptype | any | The type of the inherited group |\n| authorization_bearer | string | The client_credentials generated OAUth2 access token. |\n\n\n\n### Group.setDefault(id, authorization_bearer)\nsetDefault - Sets the group to be the default group for new users.\n\nPath: api/v1/group/id/:id/set/default\n\n**Kind**: static method of [Group](#Group) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| id | any | id or name (example: group6) |\n| authorization_bearer | string | The client_credentials generated OAUth2 access token. |\n\n\n\n### Group.delete(id, authorization_bearer)\ndelete - delete group by its id or name\n\nPath: api/v1/group/id/:id\n\n**Kind**: static method of [Group](#Group) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| id | any | id or name |\n| authorization_bearer | string | The client_credentials generated OAUth2 access token. |\n\n\n\n### Group.edit(body, id, authorization_bearer)\nedit - Edits a group\n\nPath: api/v1/group/id/:id\n\n**Kind**: static method of [Group](#Group) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| body | Object | |\n| id | any | (example: ab31efc8-40a5-4d38-a347-adb4e38d0075) |\n| authorization_bearer | string | The client_credentials generated OAUth2 access token. |\n\n**Example** \nbody\n```json\n{\n \"allowed\": [\n {\n \"route\": \"/travelling/portal/*\",\n \"host\": null,\n \"remove_from_path\": \"/travelling/portal\",\n \"method\": \"*\",\n \"name\": \"*-travelling-portal-*\"\n },\n {\n \"route\": \"/travelling/api/v1/auth/*\",\n \"host\": null,\n \"method\": \"*\",\n \"name\": \"*-travelling-api-v1-auth-*\"\n },\n {\n \"route\": \"/travelling/api/v1/user/me/route/allowed\",\n \"host\": null,\n \"method\": \"GET\",\n \"name\": \"get-travelling-api-v1-user-me-route-allowed\"\n },\n {\n \"route\": \"/travelling/api/v1/user/me/permission/allowed/*\",\n \"host\": null,\n \"method\": \"GET\",\n \"name\": \"get-travelling-api-v1-user-me-permission-allowed-*\"\n },\n {\n \"route\": \"/travelling/assets/*\",\n \"host\": null,\n \"remove_from_path\": \"/travelling/assets/\",\n \"method\": \"*\",\n \"name\": \"*-travelling-assets-*\"\n },\n {\n \"route\": \"travelling/api/v1/config/password\",\n \"host\": null,\n \"method\": \"get\"\n }\n ]\n}\n```\n\n\n### Group.get(id, authorization_bearer)\nget - Get a group by it's id or name.\n\nPath: api/v1/group/id/:id\n\n**Kind**: static method of [Group](#Group) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| id | any | id or name (example: group1) |\n| authorization_bearer | string | The client_credentials generated OAUth2 access token. |\n\n\n\n### Group.createByName(id, authorization_bearer)\ncreateByName - Add a new blank group with the set name.\n\nPath: api/v1/group/id/:id\n\n**Kind**: static method of [Group](#Group) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| id | any | Name of the new group (example: test123) |\n| authorization_bearer | string | The client_credentials generated OAUth2 access token. |\n\n\n\n### Group.create(body, authorization_bearer)\ncreate - Add a new group\n\nPath: api/v1/group\n\n**Kind**: static method of [Group](#Group) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| body | Object | |\n| authorization_bearer | string | The client_credentials generated OAUth2 access token. |\n\n**Example** \nbody\n```json\n{\n \"name\": \"group1\",\n \"type\": \"accounts\",\n \"allowed\": [\n {\n \"route\": \"/test\",\n \"host\": \"http://127.0.0.1:1237/\",\n \"remove_from_path\": \"test\",\n \"method\": \"*\",\n \"name\": \"all-test\"\n }\n ],\n \"is_default\": false\n}\n```\n\n\n## GroupUsers\n**Kind**: global class \n\n* [GroupUsers](#GroupUsers)\n * [.inherited(id)](#GroupUsers.inherited)\n * [.get(id)](#GroupUsers.get)\n\n\n\n### GroupUsers.inherited(id)\ninherited - Gets all the users that belong to the group and all of its inherited groups.\n\n##### Optional Query Params\n\n| Param | Description |\n| --- | --- |\n| id | *optional* (example: 26c6aeff-ab95-4bdd-8260-534cf92d1c23) |\n| username | *optional* (example: user7) |\n| locked | *optional* (example: true) |\n| locked_reason | *optional* (example: Activation Required email your admin to get your account activated) |\n| group_request | *optional* (example: superadmin) |\n| failed_login_attempts | *optional* (example: 0) |\n| change_username | *optional* (example: false) |\n| change_password | *optional* (example: false) |\n| reset_password | *optional* (example: false) |\n| email_verify | *optional* (example: false) |\n| group_id | *optional* (example: 7320292c-627e-4e5a-b059-583eabdd6264) |\n| email | *optional* (example: test@test.ai) |\n| created_on | *optional* (example: 1568419646794) |\n| last_login | *optional* (example: null) |\n\nPath: api/v1/group/id/:id/users/inherited\n\n**Kind**: static method of [GroupUsers](#GroupUsers) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| id | any | id or name (example: superadmin) |\n\n\n\n### GroupUsers.get(id)\nget - Gets all the users that belong to the group.\n\n##### Optional Query Params\n\n| Param | Description |\n| --- | --- |\n| id | *optional* (example: 26c6aeff-ab95-4bdd-8260-534cf92d1c23) |\n| username | *optional* (example: user7) |\n| locked | *optional* (example: true) |\n| locked_reason | *optional* (example: Activation Required email your admin to get your account activated) |\n| group_request | *optional* (example: superadmin) |\n| failed_login_attempts | *optional* (example: 0) |\n| change_username | *optional* (example: false) |\n| change_password | *optional* (example: false) |\n| reset_password | *optional* (example: false) |\n| email_verify | *optional* (example: false) |\n| group_id | *optional* (example: 7320292c-627e-4e5a-b059-583eabdd6264) |\n| email | *optional* (example: test@test.ai) |\n| created_on | *optional* (example: 1568419646794) |\n| last_login | *optional* (example: null) |\n\nPath: api/v1/group/id/:id/users\n\n**Kind**: static method of [GroupUsers](#GroupUsers) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| id | any | id or name (example: superadmin) |\n\n\n\n## GroupUser\n**Kind**: global class \n\n* [GroupUser](#GroupUser)\n * [.delete(group, type, id, authorization_bearer)](#GroupUser.delete)\n * [.removeGroupInheritance(group, type, id, inheritgroupid, inheritgrouptype, authorization_bearer)](#GroupUser.removeGroupInheritance)\n * [.addGroupInheritance(group, type, id, inheritgroupid, inheritgrouptype, authorization_bearer)](#GroupUser.addGroupInheritance)\n * [.editPropertyValue(group, type, id, property, value, authorization_bearer)](#GroupUser.editPropertyValue)\n * [.editProperty(body, group, type, id, property, authorization_bearer)](#GroupUser.editProperty)\n * [.edit(body, group, type, id, authorization_bearer)](#GroupUser.edit)\n * [.getProperty(group, type, id, property, authorization_bearer)](#GroupUser.getProperty)\n * [.get(group, type, id, authorization_bearer)](#GroupUser.get)\n\n\n\n### GroupUser.delete(group, type, id, authorization_bearer)\ndelete - Delete a user by it's id or username from group of a particular type.\n\nPath: api/v1/group/id/:group/type/:type/user/:id\n\n**Kind**: static method of [GroupUser](#GroupUser) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| group | any | id or name of the group |\n| type | any | The type of the group (example: accounts) |\n| id | any | id or name (example: user7) |\n| authorization_bearer | string | The client_credentials generated OAUth2 access token. |\n\n\n\n### GroupUser.removeGroupInheritance(group, type, id, inheritgroupid, inheritgrouptype, authorization_bearer)\nremoveGroupInheritance - Remove a user to a group of a particular type of group.\n\nPath: api/v1/group/id/:group/type/:type/user/:id/inheritance/group/:inheritgroupid/type/:inheritgrouptype\n\n**Kind**: static method of [GroupUser](#GroupUser) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| group | any | id or name of the group (example: group1) |\n| type | any | type of group (example: group) |\n| id | any | id or name of the user (example: user5) |\n| inheritgroupid | any | id or name of the group to inherit (example: group2) |\n| inheritgrouptype | any | type of the group to inherit (example: group) |\n| authorization_bearer | string | The client_credentials generated OAUth2 access token. |\n\n\n\n### GroupUser.addGroupInheritance(group, type, id, inheritgroupid, inheritgrouptype, authorization_bearer)\naddGroupInheritance - Add a group for the current user from a group of a particular type.\n\nPath: api/v1/group/id/:group/type/:type/user/:id/inheritance/group/:inheritgroupid/type/:inheritgrouptype\n\n**Kind**: static method of [GroupUser](#GroupUser) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| group | any | id or name of the group (example: group1) |\n| type | any | type of group (example: group) |\n| id | any | id or name of the user (example: user5) |\n| inheritgroupid | any | id or name of the group to inherit (example: group2) |\n| inheritgrouptype | any | type of the group to inherit (example: group) |\n| authorization_bearer | string | The client_credentials generated OAUth2 access token. |\n\n\n\n### GroupUser.editPropertyValue(group, type, id, property, value, authorization_bearer)\neditPropertyValue - Edit a current user's property data as a path param from a group of a particular type.\n\nPath: api/v1/group/id/:group/type/:type/user/:id/property/:property/:value\n\n**Kind**: static method of [GroupUser](#GroupUser) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| group | any | id or name of the group |\n| type | any | The type of the group (example: group) |\n| id | any | id or name (example: user5) |\n| property | any | (example: email) |\n| value | any | (example: swag@yolo.com) |\n| authorization_bearer | string | The client_credentials generated OAUth2 access token. |\n\n\n\n### GroupUser.editProperty(body, group, type, id, property, authorization_bearer)\neditProperty - Edit a user's property by it's id or username from a group of a particular type.\n\nPath: api/v1/group/id/:group/type/:type/user/:id/property/:property\n\n**Kind**: static method of [GroupUser](#GroupUser) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| body | Object | |\n| group | any | id or name of the group |\n| type | any | The type of the group (example: accounts) |\n| id | any | id or name (example: user6) |\n| property | any | (example: email) |\n| authorization_bearer | string | The client_credentials generated OAUth2 access token. |\n\n**Example** \nbody\n```json\n{\n\t\"locked\": false\n}\n```\n\n\n### GroupUser.edit(body, group, type, id, authorization_bearer)\nedit - Edit a user by it's id or username from group of a particular type.\n\nPath: api/v1/group/id/:group/type/:type/user/:id\n\n**Kind**: static method of [GroupUser](#GroupUser) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| body | Object | |\n| group | any | id or name of the group |\n| type | any | The type of the group (example: accounts) |\n| id | any | id or name (example: user6) |\n| authorization_bearer | string | The client_credentials generated OAUth2 access token. |\n\n**Example** \nbody\n```json\n{\n\t\"locked\": false\n}\n```\n\n\n### GroupUser.getProperty(group, type, id, property, authorization_bearer)\ngetProperty - Get a user's property by it's id or username from group of a particular type.\n\nPath: api/v1/group/id/:group/type/:type/user/:id/property/:property\n\n**Kind**: static method of [GroupUser](#GroupUser) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| group | any | id or name of the group |\n| type | any | The type of the group (example: accounts) |\n| id | any | id or name (example: user6) |\n| property | any | (example: email) |\n| authorization_bearer | string | The client_credentials generated OAUth2 access token. |\n\n\n\n### GroupUser.get(group, type, id, authorization_bearer)\nget - Get a user by it's id or username from group of a particular type.\n\nPath: api/v1/group/id/:group/type/:type/user/:id\n\n**Kind**: static method of [GroupUser](#GroupUser) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| group | any | id or name of the group |\n| type | any | The type of the group (example: accounts) |\n| id | any | id or name (example: user6) |\n| authorization_bearer | string | The client_credentials generated OAUth2 access token. |\n\n\n\n## GroupType\n**Kind**: global class \n\n* [GroupType](#GroupType)\n * [.deletePermission(id, type, permission, authorization_bearer)](#GroupType.deletePermission)\n * [.addPermission(id, type, permission, authorization_bearer)](#GroupType.addPermission)\n * [.addRoute(body, id, type, authorization_bearer)](#GroupType.addRoute)\n * [.removeInheritance(id, type, inherited, grouptype, authorization_bearer)](#GroupType.removeInheritance)\n * [.inheritFrom(id, type, inherited, grouptype, authorization_bearer)](#GroupType.inheritFrom)\n * [.setDefault(id, type)](#GroupType.setDefault)\n * [.delete(id, type, authorization_bearer)](#GroupType.delete)\n * [.get(id, type, authorization_bearer)](#GroupType.get)\n * [.edit(body, id, type, authorization_bearer)](#GroupType.edit)\n * [.createByName(id, type, authorization_bearer)](#GroupType.createByName)\n * [.create(body, type, authorization_bearer)](#GroupType.create)\n\n\n\n### GroupType.deletePermission(id, type, permission, authorization_bearer)\ndeletePermission - Removes a permission/route from a group of a particular type.\n\nPath: api/v1/group/id/:id/type/:type/permission/:permission\n\n**Kind**: static method of [GroupType](#GroupType) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| id | any | Name of the group (example: anonymous) |\n| type | any | Type of the group (example: group) |\n| permission | any | Name or Route (example: test-one-three-*) |\n| authorization_bearer | string | The client_credentials generated OAUth2 access token. |\n\n\n\n### GroupType.addPermission(id, type, permission, authorization_bearer)\naddPermission - Adds a permission to a group of a particular type.\n\nPath: api/v1/group/id/:id/type/:type/insert/permission/:permission\n\n**Kind**: static method of [GroupType](#GroupType) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| id | any | Name of the group (example: anonymous) |\n| type | any | Type of the group (example: group) |\n| permission | any | Permission (example: test-one-three-*) |\n| authorization_bearer | string | The client_credentials generated OAUth2 access token. |\n\n\n\n### GroupType.addRoute(body, id, type, authorization_bearer)\naddRoute - Adds a route to a group of a particular type.\n\n```javascript\n{\n \"route\": \"test/permissions/*\", // optional\n \"host\": null, // optional, defaults to travelling host\n \"method\": \"*\", // optional, defaults to '*'\n \"remove_from_path\": 'test/', // optional \n \"name\": \"test-permissions-*\" // Required and needs to be unqiue, defaults to method + route seperated by '-' instead of `/`\n}\n```\n\nPath: api/v1/group/id/:id/type/:type/insert/route\n\n**Kind**: static method of [GroupType](#GroupType) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| body | Object | |\n| id | any | Name of the group |\n| type | any | |\n| authorization_bearer | string | The client_credentials generated OAUth2 access token. |\n\n**Example** \nbody\n```json\n{\n\t\"route\": \"test/permissions/*\",\n \"host\": null, \n \"method\": \"*\", \n \"name\": \"test-permissions-*\" \n}\n```\n\n\n### GroupType.removeInheritance(id, type, inherited, grouptype, authorization_bearer)\nremoveInheritance - Removes an inheritance from a group of a particular type.\n\nPath: api/v1/group/id/:id/type/:type/remove/inheritance/:inherited/type/:grouptype\n\n**Kind**: static method of [GroupType](#GroupType) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| id | any | Name of the group (example: test1234) |\n| type | any | The type of the group (example: accounts) |\n| inherited | any | Name of the group to inherit from (example: superadmin) |\n| grouptype | any | The type of the inherited group |\n| authorization_bearer | string | The client_credentials generated OAUth2 access token. |\n\n\n\n### GroupType.inheritFrom(id, type, inherited, grouptype, authorization_bearer)\ninheritFrom - Adds an inheritance to a group of a particular type.\n\nPath: api/v1/group/id/:id/type/:type/inherit/from/:inherited/type/:grouptype\n\n**Kind**: static method of [GroupType](#GroupType) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| id | any | Name of the group (example: group1) |\n| type | any | The type of the group (example: testgroup) |\n| inherited | any | Name of the group to inherit from (example: test123) |\n| grouptype | any | The type of the inherited group |\n| authorization_bearer | string | The client_credentials generated OAUth2 access token. |\n\n\n\n### GroupType.setDefault(id, type)\nsetDefault - Sets the group of a particular type to be the default group for new users.\n\nPath: api/v1/group/id/:id/type/:type/set/default\n\n**Kind**: static method of [GroupType](#GroupType) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| id | any | id or name (example: group1) |\n| type | any | The type of the group (example: account) |\n\n\n\n### GroupType.delete(id, type, authorization_bearer)\ndelete - delete group of a particular type by its name or id\n\nPath: api/v1/group/id/:id/type/:type\n\n**Kind**: static method of [GroupType](#GroupType) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| id | any | id or name |\n| type | any | The type of the group |\n| authorization_bearer | string | The client_credentials generated OAUth2 access token. |\n\n\n\n### GroupType.get(id, type, authorization_bearer)\nget - Get a group by it's id or name of a particular type.\n\nPath: api/v1/group/id/:id/type/:type\n\n**Kind**: static method of [GroupType](#GroupType) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| id | any | id or name (example: group1) |\n| type | any | The type of the group (example: accounts) |\n| authorization_bearer | string | The client_credentials generated OAUth2 access token. |\n\n\n\n### GroupType.edit(body, id, type, authorization_bearer)\nedit - Edits a group of a particular type\n\nPath: api/v1/group/id/:id/type/:type\n\n**Kind**: static method of [GroupType](#GroupType) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| body | Object