{"id":20789746,"url":"https://github.com/s4kibs4mi/emq-am","last_synced_at":"2025-05-05T19:45:25.268Z","repository":{"id":73919146,"uuid":"111122497","full_name":"s4kibs4mi/emq-am","owner":"s4kibs4mi","description":"Go based RESTful service to mange EMQ MQTT Broker's Authentication \u0026 Authorization (ACL).","archived":false,"fork":false,"pushed_at":"2017-11-22T18:52:11.000Z","size":33,"stargazers_count":4,"open_issues_count":3,"forks_count":3,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-30T23:11:20.623Z","etag":null,"topics":["authentication","authorization","emq","emqtt","emqttd","mqtt","mqtt-broker"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/s4kibs4mi.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-11-17T15:59:12.000Z","updated_at":"2018-07-06T03:54:05.000Z","dependencies_parsed_at":null,"dependency_job_id":"2f0c656d-0e13-4f86-9900-d6c7b8adfdb6","html_url":"https://github.com/s4kibs4mi/emq-am","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/s4kibs4mi%2Femq-am","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/s4kibs4mi%2Femq-am/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/s4kibs4mi%2Femq-am/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/s4kibs4mi%2Femq-am/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/s4kibs4mi","download_url":"https://codeload.github.com/s4kibs4mi/emq-am/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252564317,"owners_count":21768635,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["authentication","authorization","emq","emqtt","emqttd","mqtt","mqtt-broker"],"created_at":"2024-11-17T15:26:41.002Z","updated_at":"2025-05-05T19:45:25.262Z","avatar_url":"https://github.com/s4kibs4mi.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"## EMQ-AM\nEMQ-AM let you control Authentication \u0026 ACL of EMQ's MQTT Broker using simplified rest API\n.\n\n* #### User Registration\n\n###### [ POST {{host}}/users ]\n```json\n{\n\t\"user_name\": \"user1\",\n\t\"email\": \"user1@domain.com\",\n\t\"password\": \"123456789\"\n}\n```\n###### Response\n```\n{\n    \"code\": 200,\n    \"details\": \"User successfully created\",\n    \"data\": {\n        \"id\": \"5a1316b92315e6823a298390\",\n        \"user_name\": \"s4kibs4mi12\",\n        \"email\": \"root12@sakib.ninja\",\n        \"type\": \"default\",\n        \"created_at\": \"2017-11-20T23:54:01.967+06:00\",\n        \"updated_at\": \"2017-11-20T23:54:01.967+06:00\"\n    }\n}\n```\nNote : First user will be registered as Admin and then are as default.\n\n* #### User Login\n\n###### [ POST {{host}}/session ]\n```json\n{\n\t\"user_name\": \"s4kibs4mi\",\n\t\"password\": \"123456789\"\n}\n```\n###### Response\n```\n{\n    \"code\": 200,\n    \"data\": {\n        \"user_id\": \"5a11edeb2315e67eaef32f9b\",\n        \"access_token\": \"502bfb33-94a9-40c0-9ebd-a99bdc6ae308\",\n        \"refresh_token\": \"c0906a75-4df1-488c-ab80-fc392e14471c\",\n        \"created_at\": \"2017-11-20T02:48:25.977248+06:00\",\n        \"expire_at\": \"2017-11-21T02:48:25.977248+06:00\"\n    }\n}\n```\n\n* #### Append Publish Topic\n\n###### [ POST {{host}}/publish ]\n- Header\n    - user_id: \"123123123123\"\n    - access_token: \"adsfjnajslkJLKDJASLDKN\"\n```json\n{\n\t\"user_id\": \"5a15b8212315e690dfce5889\",\n\t\"topic\": \"hello3\"\n}\n```\n###### Response\n```json\n{\n    \"code\": 200,\n    \"details\": \"Publish topic updated\",\n    \"data\": {\n        \"id\": \"5a15b8212315e690dfce5889\",\n        \"user_name\": \"s4kibs4mi1\",\n        \"email\": \"root1@sakib.ninja\",\n        \"publish_topics\": [\n            \"hello3\"\n        ],\n        \"subscribe_topics\": [\n            \"hello3\"\n        ],\n        \"type\": \"default\",\n        \"status\": \"unbanned\",\n        \"created_at\": \"2017-11-22T23:47:13.85+06:00\",\n        \"updated_at\": \"2017-11-22T23:47:13.85+06:00\"\n    }\n}\n```\n\n* #### Remove Publish Topic\n\n###### [ DELETE {{host}}/publish ]\n- Header\n    - user_id: \"123123123123\"\n    - access_token: \"adsfjnajslkJLKDJASLDKN\"\n```json\n{\n\t\"user_id\": \"5a15b8212315e690dfce5889\",\n\t\"topic\": \"hello3\"\n}\n```\n###### Response\n```json\n{\n    \"code\": 200,\n    \"details\": \"Publish topic removed\",\n    \"data\": {\n        \"id\": \"5a15b8212315e690dfce5889\",\n        \"user_name\": \"s4kibs4mi1\",\n        \"email\": \"root1@sakib.ninja\",\n        \"subscribe_topics\": [\n            \"hello3\"\n        ],\n        \"type\": \"default\",\n        \"status\": \"unbanned\",\n        \"created_at\": \"2017-11-22T23:47:13.85+06:00\",\n        \"updated_at\": \"2017-11-22T23:47:13.85+06:00\"\n    }\n}\n```\n\n* #### Append Subscribe Topic\n\n###### [ POST {{host}}/subscribe ]\n- Header\n    - user_id: \"123123123123\"\n    - access_token: \"adsfjnajslkJLKDJASLDKN\"\n```json\n{\n\t\"user_id\": \"5a15b8212315e690dfce5889\",\n\t\"topic\": \"hello3\"\n}\n```\n###### Response\n```json\n{\n    \"code\": 200,\n    \"details\": \"Subscribe topic updated\",\n    \"data\": {\n        \"id\": \"5a15b8212315e690dfce5889\",\n        \"user_name\": \"s4kibs4mi1\",\n        \"email\": \"root1@sakib.ninja\",\n        \"publish_topics\": [\n            \"hello3\"\n        ],\n        \"subscribe_topics\": [\n            \"hello3\"\n        ],\n        \"type\": \"default\",\n        \"status\": \"unbanned\",\n        \"created_at\": \"2017-11-22T23:47:13.85+06:00\",\n        \"updated_at\": \"2017-11-22T23:47:13.85+06:00\"\n    }\n}\n```\n\n* #### Remove Subscribe Topic\n\n###### [ DELETE {{host}}/subscribe ]\n- Header\n    - user_id: \"123123123123\"\n    - access_token: \"adsfjnajslkJLKDJASLDKN\"\n```json\n{\n\t\"user_id\": \"5a15b8212315e690dfce5889\",\n\t\"topic\": \"hello3\"\n}\n```\n###### Response\n```json\n{\n    \"code\": 200,\n    \"details\": \"Subscribe topic removed\",\n    \"data\": {\n        \"id\": \"5a15b8212315e690dfce5889\",\n        \"user_name\": \"s4kibs4mi1\",\n        \"email\": \"root1@sakib.ninja\",\n        \"subscribe_topics\": [\n            \"hello3\"\n        ],\n        \"type\": \"default\",\n        \"status\": \"unbanned\",\n        \"created_at\": \"2017-11-22T23:47:13.85+06:00\",\n        \"updated_at\": \"2017-11-22T23:47:13.85+06:00\"\n    }\n}\n```\n\n* #### EMQ Authentication\n\n###### [ POST {{host}}/auth ]\n```text\nusername=${User_Id}\u0026password=${Access_Token}\n```\n###### Response\n- Http Status : 200 if authenticated\n\n* #### EMQ Authorization\n\n###### [ POST {{host}}/acl ]\n```text\nusername=${User_Id}\u0026topic=hello\u0026access=2\n```\n###### Response\n- Http Status : 200 if authenticated\n\n\n### Configuration\nChange configuration in etc/config.json\n\n```json\n{\n  \"app\": {\n    \"address\": \":8090\"\n  },\n  \"databases\": {\n    \"mongodb\": {\n      \"uri\": \"mongodb://localhost:27017\",\n      \"name\": \"emqam\",\n      \"auth_collection\": \"emqauth\",\n      \"acl_collection\": \"emqacl\",\n      \"session_collection\": \"sessions\"\n    }\n  },\n  \"security\": {\n    \"registration_enabled\": true,\n    \"key\": \"hello\",\n    \"secret\": \"12345\"\n  },\n  \"pagination\": {\n    \"per_page\": 20\n  }\n}\n```\n\n### Docker Deployment\n```\ndocker pull sakibsami/emq-am:latest\ndocker run -p 8090:8090 sakibsami/emq-am:latest\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fs4kibs4mi%2Femq-am","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fs4kibs4mi%2Femq-am","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fs4kibs4mi%2Femq-am/lists"}