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

Handle tribal API access expiration #4509

Open
danswick opened this issue Dec 4, 2024 · 2 comments
Open

Handle tribal API access expiration #4509

danswick opened this issue Dec 4, 2024 · 2 comments

Comments

@danswick
Copy link
Contributor

danswick commented Dec 4, 2024

System API keys expire after 6 months. This isn't fully documented anywhere (as far as I can tell) and we haven't really nailed down a process for renewing keys when they expire. I made a rough update to our internal docs for handling helpdesk requests, but there are still some rough edges:

  • Public docs need to describe the expiration process and how to renew.
  • Expiry specifics should be in the attestation form (maybe a suggestion to set a calendar reminder?)
  • Internal docs should do a better job describing how to renew or update API access. For example, the user's email is managed via the admin API, but the access key IDs (and associated email) are part of the dissemination schema and managed via Djano admin (I think?). It's not clear what happens if these two email fields get out of sync.
  • Renewing an existing key should probably be a single action instead of remove-then-add-again. Maybe it is, but I can't find it.
  • Maybe we need to alert existing API key holders that their key has expired or will soon expire?

Possibly related: #4407

@github-project-automation github-project-automation bot moved this to Triage in FAC Dec 4, 2024
@rnovak338 rnovak338 self-assigned this Dec 5, 2024
@rnovak338 rnovak338 moved this from Triage to In Progress in FAC Dec 5, 2024
@rnovak338
Copy link
Contributor

For bullet # 3, I added some context to the internal documentation on how we would manage tribal access and tribal API access through Django Admin, removing specification of the admin API. I will do some testing on what happens when the email for UserPermission and TribalApiAccessKeyId is out of sync, but I assume what would happen is the API would no longer work for the user.

For bullet # 4, this should be handled through Django Admin as well. You and I had a sync last week where you were getting a 500 error in Django Admin re-saving keys unless you actually changed a value in the table. This is unintended behavior and should be fixed once this PR goes out.

@rnovak338 rnovak338 moved this from In Progress to Backlog in FAC Jan 14, 2025
@rnovak338 rnovak338 moved this from Backlog to Triage in FAC Jan 14, 2025
@rnovak338 rnovak338 removed their assignment Jan 14, 2025
@rnovak338
Copy link
Contributor

rnovak338 commented Jan 14, 2025

@danswick some of these bullets have been addressed on my part, but I believe the remaining items can be split up into smaller issues.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Triage
Development

No branches or pull requests

2 participants