Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

AdvancedVerify #93

Open
JayDwee opened this issue Apr 18, 2021 · 0 comments · May be fixed by #230
Open

AdvancedVerify #93

JayDwee opened this issue Apr 18, 2021 · 0 comments · May be fixed by #230
Labels
new koala extension A suggested/ requested koala extension/ cog

Comments

@JayDwee
Copy link
Member

JayDwee commented Apr 18, 2021

Is your feature request related to a problem? Please describe.

Societies want a way to give roles based on membership from another service. e.g. 'Community Membership' role when membership bought from Students Union website

Requirements

  1. Create an API to let admins give a role based on an email address
  2. Include rate limiting, authentication and other safety and privacy features
  3. Create a template client to interact with the API using a given CSV (SVGE can be used as an example)
  4. Create graphic for how data is transferred, and secured to provide to KoalaBot sponsors

Describe alternatives you've considered

Implement an API for requesting membership roles given

Example POST
curl POST 'https://api.koalabot.uk/joey/[email protected]&[email protected]'
--header 'client-id: <DiscordServerID>'
--header 'Authorization: Bearer <Koala API Token>'
--header 'role_id: <MembershipRole>'

joey used as the name of the API in case a rework is needed and therefore the endpoint can be changed (similar to twitch API approach)

Additional context

https://flask-restful.readthedocs.io/en/latest/quickstart.html#a-minimal-api
https://flask-limiter.readthedocs.io/en/stable/#:~:text=A%20default%20rate%20limit%20of,hour%20applied%20to%20all%20routes.

@JayDwee JayDwee added new koala extension A suggested/ requested koala extension/ cog high priority labels Apr 18, 2021
@JayDwee JayDwee added this to To do in KoalaBot Backend via automation Apr 18, 2021
@JayDwee JayDwee moved this from To do to In progress in KoalaBot Backend Apr 18, 2021
@slushiegoose slushiegoose linked a pull request Jul 26, 2021 that will close this issue
10 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
new koala extension A suggested/ requested koala extension/ cog
Projects
No open projects
KoalaBot Backend
  
In progress
Development

Successfully merging a pull request may close this issue.

4 participants