docs: DOC-1362 #3929

karl-cardenas-coding · 2024-09-16T15:44:40Z

Describe the Change

This PR adds steps to delete an API key programmatically. Additional guidance in the API Key index page has also been added.

Changed Pages

💻 API Key Index Page Updates

💻 Delete API Key

Jira Tickets

🎫 DOC-1362

Backports

Can this PR be backported?

Yes. Remember to add the relevant backport labels to your PR.
No. Please leave a short comment below about why this PR cannot be backported.

netlify · 2024-09-16T15:44:55Z

✅ Deploy Preview for docs-spectrocloud ready!

Name	Link
🔨 Latest commit	`71d05d7`
🔍 Latest deploy log	https://app.netlify.com/sites/docs-spectrocloud/deploys/66e9f1bc8eb91f0008a9432b
😎 Deploy Preview	https://deploy-preview-3929--docs-spectrocloud.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

docs/docs-content/user-management/authentication/api-key/api-key.md

docs/docs-content/user-management/authentication/api-key/delete-api-key.md

caroldelwing

Great guide! Just tiny suggestions :)

docs/docs-content/user-management/authentication/api-key/api-key.md

docs/docs-content/user-management/authentication/api-key/delete-api-key.md

addetz

Just couple of suggestions :)

addetz · 2024-09-17T12:47:59Z

docs/docs-content/user-management/authentication/api-key/api-key.md

+
+## Limitations
+
+- API keys that belong to Palette users removed from the organization through OIDC/SAML are not automatically removed.


Perhaps provide a reference to where users can find all issued API keys?

docs/docs-content/user-management/authentication/api-key/delete-api-key.md

Co-authored-by: caroldelwing <[email protected]>

docs/docs-content/user-management/saml-sso/saml-sso.md

github-actions · 2024-09-17T21:09:12Z

docs/docs-content/user-management/authentication/api-key/api-key.md

+## Limitations
+
+Palette API keys that belong to Palette users removed from the organization through OIDC/SAML are not automatically
+removed. We recommend that you remove these keys to ensure that they are no longer used. You can programmatically remove


🚫 [vale] _{reported by reviewdog 🐶}
[Vale.Terms] Use 'we' instead of 'We'.

github-actions · 2024-09-17T21:09:12Z

docs/docs-content/user-management/saml-sso/saml-sso.md

+## Limitations
+
+Palette [API keys](../authentication/api-key/api-key.md) that belong to Palette users removed from the organization
+through OIDC/SAML are not automatically removed. We recommend that you remove these keys to ensure that they are no


🚫 [vale] _{reported by reviewdog 🐶}
[Vale.Terms] Use 'we' instead of 'We'.

* docs: DOC-1362 * docs: more updates * docs: vale fix * docs: feedback apply suggestions from code review Co-authored-by: caroldelwing <[email protected]> * ci: auto-formatting prettier issues * docs: feedback * docs: feedback changes --------- Co-authored-by: caroldelwing <[email protected]> Co-authored-by: karl-cardenas-coding <[email protected]> (cherry picked from commit 8c9cbab)

vault-token-factory-spectrocloud · 2024-09-17T21:37:33Z

💔 Some backports could not be created

Status	Branch	Result
❌	version-4-0	Backport failed because of merge conflicts You might need to backport the following PRs to version-4-0: - docs: add new vsphere known issue (#3896) - docs: confirm cert renewal by looking at expiry date (#3886) - docs: DOC-1372 (#3840)
❌	version-4-1	Backport failed because of merge conflicts You might need to backport the following PRs to version-4-1: - docs: add new vsphere known issue (#3896) - docs: confirm cert renewal by looking at expiry date (#3886) - docs: DOC-1372 (#3840) - chore: bump @argos-ci/cli from 2.3.1 to 2.4.2 (#3798)
❌	version-4-2	Backport failed because of merge conflicts You might need to backport the following PRs to version-4-2: - docs: add new vsphere known issue (#3896) - docs: confirm cert renewal by looking at expiry date (#3886) - docs: PE-4831 (#3809)
❌	version-4-3	Backport failed because of merge conflicts You might need to backport the following PRs to version-4-3: - docs: confirm cert renewal by looking at expiry date (#3886) - docs: PE-4831 (#3809)
✅	version-4-4

Note: Successful backport PRs will be merged automatically after passing CI.

Manual backport

To create the backport manually run:

backport --pr 3929

Questions ?

Please refer to the Backport tool documentation and see the Github Action logs for details

* docs: DOC-1362 * docs: more updates * docs: vale fix * docs: feedback apply suggestions from code review Co-authored-by: caroldelwing <[email protected]> * ci: auto-formatting prettier issues * docs: feedback * docs: feedback changes --------- Co-authored-by: caroldelwing <[email protected]> Co-authored-by: karl-cardenas-coding <[email protected]> (cherry picked from commit 8c9cbab) Co-authored-by: Karl Cardenas <[email protected]>

* docs: DOC-1362 * docs: more updates * docs: vale fix * docs: feedback apply suggestions from code review Co-authored-by: caroldelwing <[email protected]> * ci: auto-formatting prettier issues * docs: feedback * docs: feedback changes --------- Co-authored-by: caroldelwing <[email protected]> Co-authored-by: karl-cardenas-coding <[email protected]>

* docs: DOC-1362 * docs: more updates * docs: vale fix * docs: feedback apply suggestions from code review * ci: auto-formatting prettier issues * docs: feedback * docs: feedback changes --------- Co-authored-by: caroldelwing <[email protected]> Co-authored-by: karl-cardenas-coding <[email protected]>

vault-token-factory-spectrocloud · 2024-10-13T16:10:33Z

🎉 This issue has been resolved in version 4.5.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

docs: DOC-1362

f6e7061

docs: more updates

4081ccd

karl-cardenas-coding marked this pull request as ready for review September 16, 2024 16:15

karl-cardenas-coding requested a review from a team as a code owner September 16, 2024 16:15

karl-cardenas-coding requested review from addetz, lennessyy and caroldelwing September 16, 2024 16:15

github-actions bot reviewed Sep 16, 2024

View reviewed changes

docs: vale fix

db55a0e

caroldelwing approved these changes Sep 16, 2024

View reviewed changes

addetz approved these changes Sep 17, 2024

View reviewed changes

karl-cardenas-coding and others added 5 commits September 17, 2024 13:40

docs: feedback apply suggestions from code review

9127ad3

Co-authored-by: caroldelwing <[email protected]>

Merge branch 'master' of github.com:spectrocloud/librarium into API_keys

1316087

ci: auto-formatting prettier issues

f443597

docs: feedback

72f28fa

save

a2b9e90

github-actions bot reviewed Sep 17, 2024

View reviewed changes

docs/docs-content/user-management/saml-sso/saml-sso.md Outdated Show resolved Hide resolved

docs: feedback changes

3e2039d

github-actions bot reviewed Sep 17, 2024

View reviewed changes

Merge branch 'master' into API_keys

71d05d7

karl-cardenas-coding merged commit 8c9cbab into master Sep 17, 2024
15 checks passed

karl-cardenas-coding deleted the API_keys branch September 17, 2024 21:35

vault-token-factory-spectrocloud bot mentioned this pull request Sep 17, 2024

[version-4-4] docs: DOC-1362 (#3929) #3956

Merged

karl-cardenas-coding mentioned this pull request Sep 17, 2024

[version-4-3] docs: DOC-1362 (#3929) #3957

Merged

karl-cardenas-coding mentioned this pull request Sep 17, 2024

[version-4-2] docs: DOC-1362 (#3929) #3958

Merged

karl-cardenas-coding mentioned this pull request Sep 17, 2024

[version-4-1] docs: DOC-1362 (#3929) #3959

Merged

karl-cardenas-coding mentioned this pull request Sep 17, 2024

[version-4-0] docs: DOC-1362 (#3929) #3960

Merged

vault-token-factory-spectrocloud bot added the released label Oct 13, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: DOC-1362 #3929

docs: DOC-1362 #3929

karl-cardenas-coding commented Sep 16, 2024 •

edited

Loading

netlify bot commented Sep 16, 2024 •

edited

Loading

caroldelwing left a comment

addetz left a comment

addetz Sep 17, 2024

github-actions bot Sep 17, 2024

github-actions bot Sep 17, 2024

vault-token-factory-spectrocloud bot commented Sep 17, 2024

vault-token-factory-spectrocloud bot commented Oct 13, 2024


		## Limitations

		- API keys that belong to Palette users removed from the organization through OIDC/SAML are not automatically removed.

docs: DOC-1362 #3929

docs: DOC-1362 #3929

Conversation

karl-cardenas-coding commented Sep 16, 2024 • edited Loading

Describe the Change

Changed Pages

Jira Tickets

Backports

netlify bot commented Sep 16, 2024 • edited Loading

✅ Deploy Preview for docs-spectrocloud ready!

caroldelwing left a comment

Choose a reason for hiding this comment

addetz left a comment

Choose a reason for hiding this comment

addetz Sep 17, 2024

Choose a reason for hiding this comment

github-actions bot Sep 17, 2024

Choose a reason for hiding this comment

github-actions bot Sep 17, 2024

Choose a reason for hiding this comment

vault-token-factory-spectrocloud bot commented Sep 17, 2024

💔 Some backports could not be created

Manual backport

Questions ?

vault-token-factory-spectrocloud bot commented Oct 13, 2024

karl-cardenas-coding commented Sep 16, 2024 •

edited

Loading

netlify bot commented Sep 16, 2024 •

edited

Loading