[{"_1":2,"_181":-5,"_182":-5},"loaderData",{"_3":4,"_17":18,"_25":26,"_160":161},"root",{"_5":-5,"_6":-7,"_7":8,"_9":-7,"_10":11,"_12":-7,"_13":14,"_15":16},"currentUser","primaryEmail","siteVerification","6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI","toast","enableDev",false,"incidentStatus","theme","system","contrast","normal","routes/_layout",{"_19":-5,"_20":21,"_22":21,"_23":11,"_24":21},"username","isAskGordonEnabled",true,"isUsingNewTemplate","showMinimalLanding","showHoneypotTrap","routes/_layout.r.$namespace.$reponame",{"_27":28,"_29":-5,"_30":11,"_31":11,"_32":33,"_34":35,"_36":-5,"_37":11,"_38":39,"_88":89,"_111":112,"_149":-5,"_150":11,"_151":21,"_152":11,"_153":-5,"_154":11,"_155":-5,"_156":157,"_158":113,"_159":-7},"canonicalUrl","https://hub.docker.com/r/budgetkey/auth/tags","mcpServer","canSeeDockerfile","canSeeAutobuilds","namespace","budgetkey","reponame","auth","cloudBuildSource","isAutobuildsAvailable","repo",{"_40":41,"_42":43,"_45":46,"_47":48,"_49":11,"_50":51,"_52":53,"_54":55,"_57":35,"_32":33,"_58":59,"_60":44,"_61":62,"_63":64,"_65":66,"_67":-5,"_68":62,"_69":70,"_71":11,"_72":33,"_73":74,"_79":11,"_80":81,"_85":33,"_86":87},"categories",[],"content_types",[44],"image","date_registered","2017-12-18T12:15:36.674331Z","description","","is_private","last_updated","2018-11-14T21:04:14.953833Z","last_modified","2024-10-16T13:48:34.145251Z","media_types",[56],"application/vnd.docker.container.image.v1+json","name","pull_count",303,"repository_type","star_count",0,"status",1,"status_description","active","source","collaborator_count","full_description","# DataHQ auth service\n\n[![Build Status](https://travis-ci.org/datahq/auth.svg?branch=master)](https://travis-ci.org/datahq/auth)\n\nA generic OAuth2 authentication service and user permission manager.\n\n## Quick start\n\n### Clone the repo and install\n\n`make install`\n\n### Run tests\n\n`make test`\n\n### Run server\n\n`python server.py`\n\n## Env Vars\n- `PRIVATE_KEY` & `PUBLIC_KEY` an RSA key-pair in PEM format.\n See `tools/generate_key_pair.sh` for more info.\n- `GOOGLE_KEY` & `GOOGLE_SECRET`: OAuth credentials for authenticating with Google\n- `GITHUB_KEY` & `GITHUB_SECRET`: OAuth credentials for authenticating with Github\n- `DATABASE_URL`: A SQLAlchemy compatible database connection string (where user data is stored)\n- `EXTERNAL_ADDRESS`: The hostname where this service is located on\n- `ALLOWED_SERVICES`:\n Which permissions providers are available. A `;` delimited list of provider identifiers.\n Each provider identifier takes the form of `[alias:]provider`, where `provider` is the name of a Python module\n which exports a `get_permissions(service, userid)` function.\n- `INSTALLED_EXTENSIONS`:\n List of installed extensions. A `;` delimited list of `extension` - the name of a Python modules which exports one or all of these functions\n - `on_new_user(user_info)`\n - `on_user_login(user_info)`\n - `on_user_logout(user_info)`\n\n\n## API\n\n### Check an authentication token's validity\n`/auth/check`\n\n**Method:** `GET`\n\n**Query Parameters:**\n\n - `jwt` - authentication token\n - `next` - URL to redirect to when finished authentication\n\n**Returns:**\n\nIf authenticated:\n\n```json\n{\n \"authenticated\": true,\n \"profile\": {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"avatar_url\": \"\",\n \"idhash\": \"\",\n \"username\": \"\" # If user has a username\n }\n}\n```\n\nIf not:\n\n```json\n{\n \"authenticated\": false,\n \"providers\": {\n \"google\": {\n \"url\": \"\"\n },\n \"github\": {\n \"url\": \"\"\n },\n }\n}\n```\n\nWhen the authentication flow is finished, the caller will be redirected to the `next` URL with an extra query parameter\n`jwt` which contains the authentication token. The caller should cache this token for further interactions with the API.\n\n### Get permission for a service\n`/auth/authorize`\n\n**Method:** `GET`\n\n**Query Parameters:**\n\n - `jwt` - user token (received from `/user/check`)\n - `service` - the relevant service (e.g. `storage-service`)\n\n**Returns:**\n\n```json\n{\n \"token\": \"\"\n \"userid\": \"\",\n \"permissions\": {\n \"permission-x\": true,\n \"permission-y\": false\n },\n \"service\": \"\"\n}\n```\n\n### Change the username\n`/auth/update`\n\n**Method:** `POST`\n\n**Query Parameters:**\n\n - `jwt` - authentication token (received from `/user/check`)\n - `username` - A new username for the user profile (this action is only allowed once)\n\n**Returns:**\n\n```json\n{\n \"success\": true,\n \"error\": \"\"\n}\n```\n\n__Note__: trying to update other user profile fields like `email` will fail silently and return\n\n```json\n{\n \"success\": true\n}\n```\n\n### Receive authorization public key\n`/auth/public-key`\n\n**Method:** `GET`\n\n**Returns:**\n\nThe service's public key in PEM format.\n\nCan be used by services to validate that the permission token is authentic.\n","has_starred","hub_user","immutable_tags_settings",{"_75":11,"_76":77},"enabled","rules",[78],".*","is_automated","permissions",{"_82":21,"_83":11,"_84":11},"read","write","admin","user","storage_size",431565268,"orgData",{"_90":91,"_92":93,"_94":95,"_96":33,"_97":48,"_98":99,"_100":101,"_102":103,"_104":105,"_106":107,"_108":48,"_109":48,"_110":21},"id","ed9a5caafb334a149e6480c6d0898528","uuid","ed9a5caa-fb33-4a14-9e64-80c6d0898528","type","organization","orgname","full_name","location","Israel","company","Hasadna","profile_url","http://obudget.org","date_joined","2016-11-19T16:27:44.545409Z","gravatar_url","https://www.gravatar.com/avatar/1b4d934bf6b61654e74b7df3018e1fba?s=80&r=g&d=mm","gravatar_email","badge","is_active","recentTags",[113],{"_114":44,"_115":116,"_117":118,"_90":119,"_120":121,"_50":138,"_139":116,"_140":33,"_141":56,"_57":142,"_143":144,"_145":129,"_146":138,"_147":66,"_148":21},"content_type","creator",1263800,"full_size",105590708,19559303,"images",[122],{"_123":124,"_125":126,"_127":48,"_128":129,"_130":131,"_132":133,"_134":48,"_135":-5,"_136":118,"_63":66,"_137":-5},"architecture","amd64","digest","sha256:954e702fffeec0dec2a81433a45cc023159bc866a9f9699c25cdc1ff262b5552","features","last_pulled","2026-09-29T11:28:52.013529062Z","last_pushed","2018-11-14T21:04:15Z","os","linux","os_features","os_version","size","variant","2018-11-14T21:04:14.462542Z","last_updater","last_updater_username","media_type","latest","repository",2507572,"tag_last_pulled","tag_last_pushed","tag_status","v2","sbxKitMetadata","isPotentialSpam","isHubSbxKitsEnabled","showSbxLogoOverride","sbxTrademarkText","displaySecurityMetadata","tagAttestations","tagsHaveAttestations",[],"selectedTag","attestationsUrl","routes/_layout.r.$namespace.$reponame.tags",{"_38":162,"_169":170,"_156":179,"_180":11},{"_40":163,"_42":164,"_45":46,"_47":48,"_49":11,"_50":51,"_52":53,"_54":165,"_57":35,"_32":33,"_58":59,"_60":44,"_61":62,"_63":64,"_65":66,"_67":-5,"_68":62,"_69":70,"_71":11,"_72":33,"_73":166,"_79":11,"_80":168,"_85":33,"_86":87},[],[44],[56],{"_75":11,"_76":167},[78],{"_82":21,"_83":11,"_84":11},"tags",{"_171":64,"_172":-5,"_173":-5,"_174":175},"count","next","previous","results",[176],{"_114":44,"_115":116,"_117":118,"_90":119,"_120":177,"_50":138,"_139":116,"_140":33,"_141":56,"_57":142,"_143":144,"_145":129,"_146":138,"_147":66,"_148":21},[178],{"_123":124,"_125":126,"_127":48,"_128":129,"_130":131,"_132":133,"_134":48,"_135":-5,"_136":118,"_63":66,"_137":-5},[],"canDeleteTags","actionData","errors"]

budgetkey/auth

Tags for budgetkey/auth