[GT-184] Add support for renewing API credentials - #464

Merged

gregcorbett merged 7 commits into

Sae126V:GT-184-Extend-API-Credential-Management-to-handle-periodic-renewal

Aug 4, 2026

Sae126V commented Aug 4, 2023 •

edited

Loading

Contributor

Resolves

" #438 and #453 "

Sae126V force-pushed the GT-184-Extend-API-Credential-Management-to-handle-periodic-renewal branch 3 times, most recently from 5728cd9 to 6f26459 Compare

August 7, 2023 07:52

Sae126V marked this pull request as ready for review

August 7, 2023 07:55

Sae126V requested a review from a team as a code owner

August 7, 2023 07:55

gregcorbett reviewed

View reviewed changes

htdocs/web_portal/views/site/edit_api_auth.php Outdated

gregcorbett reviewed

View reviewed changes

htdocs/web_portal/views/site/edit_api_auth.php Outdated

gregcorbett reviewed

View reviewed changes

htdocs/web_portal/views/site/edit_api_auth.php Outdated

gregcorbett reviewed

View reviewed changes

htdocs/web_portal/views/site/edit_api_auth.php Outdated

gregcorbett reviewed

View reviewed changes

htdocs/web_portal/views/site/edited_api_auth.php Outdated

gregcorbett reviewed

View reviewed changes

htdocs/web_portal/views/site/view_site.php Outdated

gregcorbett reviewed

View reviewed changes

lib/Gocdb_Services/APIAuthenticationService.php Outdated

gregcorbett reviewed

View reviewed changes

htdocs/web_portal/views/site/view_site.php Outdated

gregcorbett reviewed

View reviewed changes

lib/Gocdb_Services/APIAuthenticationService.php

gregcorbett reviewed

View reviewed changes

lib/Gocdb_Services/Site.php Outdated

gregcorbett reviewed

View reviewed changes

resources/ManageAPICredentials/ManageUnusedAPICredentialsOptions.php Outdated

gregcorbett reviewed

View reviewed changes

resources/ManageAPICredentials/ManageAPICredentialsActions.php Outdated

Sae126V marked this pull request as draft

August 18, 2023 14:37

Sae126V force-pushed the GT-184-Extend-API-Credential-Management-to-handle-periodic-renewal branch from bc37f58 to 6259cc5 Compare

August 18, 2023 14:50

Sae126V marked this pull request as ready for review

August 18, 2023 14:51

gregcorbett reviewed

View reviewed changes

htdocs/web_portal/controllers/site/edit_api_auth.php Outdated

Sae126V marked this pull request as draft

September 11, 2023 08:32

Sae126V force-pushed the GT-184-Extend-API-Credential-Management-to-handle-periodic-renewal branch from 8afb986 to cd82c9e Compare

September 13, 2023 07:54

Sae126V commented Sep 13, 2023

Contributor Author

@gregcorbett , This is ready for the functionality review.

Sae126V marked this pull request as ready for review

September 13, 2023 07:55

gregcorbett reviewed

View reviewed changes

gregcorbett left a comment

Member

Functionality looks good. I noticed that when emails were generated for both unrenewed and inactive API credentitals, I got:

> php resources/ManageAPICredentials/ManageUnusedAPICredentials.php --warning_threshold 9 --deletion_threshold 15 --renewals
...
The API credential associated with the following identifier
registered at site X has not been renewed for
the last 0 months and will be deleted if it reaches 15 months.

Where 0 should have been closer to 12, which is why the warning email was generated. Could you look into that?

gregcorbett mentioned this pull request

Improvements to API Credential Management #480

Open

2 tasks

gregcorbett commented Sep 14, 2023

Member

Could you also add printing out the last renewed time to reportDryRun?

Sae126V commented Sep 14, 2023

Contributor Author

Could you also add printing out the last renewed time to reportDryRun?

Sure, Greg. Added the support for last renewed time in 0d1ec9a

Sae126V marked this pull request as draft

September 14, 2023 09:35

Sae126V commented Sep 14, 2023

Contributor Author

Ready for the functionality review with the fix and suggestions @gregcorbett.

Sae126V marked this pull request as ready for review

September 14, 2023 14:07

Sae126V added a commit to Sae126V/gocdb that referenced this pull request


          [GT-184] Apply styles for the PR GOCDB#464

b67ac49

Sae126V added a commit to Sae126V/gocdb that referenced this pull request


          [GT-184] Apply styles for the PR GOCDB#464

214063a

Sae126V mentioned this pull request

[GT-184] Apply styles for the PR #464 #484

Open

Sae126V added a commit to Sae126V/gocdb that referenced this pull request


          [GT-184] Apply styles for the PR GOCDB#464

3fc2eed

Sae126V added a commit to Sae126V/gocdb that referenced this pull request


          [GT-184] Apply styles for the PR (GOCDB#464)

86c7ee6

Sae126V force-pushed the GT-184-Extend-API-Credential-Management-to-handle-periodic-renewal branch from 61d1865 to 0577fbc Compare

July 14, 2026 12:12

Sae126V commented

View reviewed changes

lib/Gocdb_Services/APIAuthenticationService.php

gregcorbett commented Jul 16, 2026

Member

@Sae126V , can you remember why lib/Gocdb_Services/APIAuthenticationService.php is being touched?

Was it to support being able to renew (and hence take ownership of, if necessary) a credential without otherwise editing it (i.e. a renew button in the portal)? If so, I wonder if there is a version of this change that doesn't touch lib/Gocdb_Services/APIAuthenticationService.php... can you investigate?

Sae126V commented Jul 16, 2026

Contributor Author

@Sae126V , can you remember why lib/Gocdb_Services/APIAuthenticationService.php is being touched?

Yep, so, it was changed to support the renew button. The problem is that a renewal doesn't send any form fields (the point of "renew without otherwise editing it"), but the existing editAPIAuthentication() expects them.

I'll investigate whether there's a version that doesn't touch this file and get back to you by tomorrow

gregcorbett commented Jul 16, 2026

Member

The problem is that a renewal doesn't send any form fields

Presumably we could just send the current values into editAPIAuthentication()?

Sae126V and others added 4 commits

July 24, 2026 09:39


          [GT-184] Add support for renewing API credentials

ff7ad62


          [GT-184] Fix displaying months and dryrun issues

eee1705


          [GT-184] Fix issue with the tag and minor cosmotic improvement

87d8bf0


          Rework the renewal logic into a separate method

e123f64

Sae126V force-pushed the GT-184-Extend-API-Credential-Management-to-handle-periodic-renewal branch from a7d8e3d to e123f64 Compare

July 24, 2026 08:40


          Cosmetic fix

28b0527

Sae126V commented Jul 27, 2026

Contributor Author

I have changed the logic of renewal flow. This would be now separate from the editing user flow. Ready for the review now

gregcorbett reviewed

View reviewed changes

lib/Gocdb_Services/Site.php

tests/resourcesTests/ManageUnrenewedAPICredentialsTest.php

tests/resourcesTests/ManageUnusedAPICredentialsTest.php

Sae126V force-pushed the GT-184-Extend-API-Credential-Management-to-handle-periodic-renewal branch from e058dda to 00858bd Compare

July 29, 2026 10:00


          Improve code readability by adding comments

491abeb

Sae126V force-pushed the GT-184-Extend-API-Credential-Management-to-handle-periodic-renewal branch from 00858bd to 491abeb Compare

July 29, 2026 10:35


          Add comments to the existing code to improve readability

c5179f1

Sae126V force-pushed the GT-184-Extend-API-Credential-Management-to-handle-periodic-renewal branch from 7d74c41 to c5179f1 Compare

August 3, 2026 11:35

This was referenced Aug 3, 2026

Update API credential renewal time when credentials are edited #558

Open

Centralise OIDC Subject and X.509 validation in the validation layer #559

Open

gregcorbett self-requested a review

August 4, 2026 07:32

gregcorbett approved these changes

View reviewed changes

gregcorbett merged commit f81476d into GOCDB:dev

4 of 5 checks passed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet