Skip to content

feat: Add client credentials guide for NGINXaaS Google#2052

Open
nparikh03 wants to merge 11 commits into
mainfrom
naas/client-creds-docs
Open

feat: Add client credentials guide for NGINXaaS Google#2052
nparikh03 wants to merge 11 commits into
mainfrom
naas/client-creds-docs

Conversation

@nparikh03

@nparikh03 nparikh03 commented Jun 17, 2026

Copy link
Copy Markdown

Proposed changes

Add new how-to guide for setting up OAuth2 client credentials for programmatic access to NGINXaaS for Google APIs.

This guide covers:

Creating and managing client credentials from the NGINXaaS console
Retrieving and displaying client information
Deleting expired credentials
Exchanging client credentials for access tokens
Best practices for credential security and expiration
This enables machine users such as Terraform, CI/CD pipelines, and automation tools to authenticate securely with the NGINXaaS API.

Checklist

Before sharing this pull request, I completed the following checklist:

Footnotes

  1. Potentially sensitive information includes personally identify information (PII), authentication credentials, and live URLs. Refer to the style guide for guidance about placeholder content.

@nparikh03 nparikh03 requested a review from a team as a code owner June 17, 2026 18:26
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Jun 17, 2026
@github-actions

github-actions Bot commented Jun 17, 2026

Copy link
Copy Markdown

✅ All required contributors have signed the F5 CLA for this PR. Thank you!
Posted by the CLA Assistant Lite bot.

@nparikh03

Copy link
Copy Markdown
Author

I have hereby read the F5 CLA and agree to its terms

@github-actions

Copy link
Copy Markdown

Deploy Preview will be available once build job completes!

Name Link
😎 Deploy Preview https://frontdoor-test-docs.nginx.com/previews/docs/2052/

Comment thread content/nginxaas-google/quickstart/security-controls/client-credentials.md Outdated
Comment thread content/nginxaas-google/quickstart/security-controls/client-credentials.md Outdated

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR adds a new NGINXaaS for Google Cloud quickstart how-to guide that explains how to create and use OAuth2 client credentials for programmatic access to the NGINXaaS API (for example, automation via Terraform or CI/CD).

Changes:

  • Adds a new “client credentials” guide with console-based creation/retrieval/deletion steps.
  • Documents token exchange and authenticated API call examples (cURL), plus best practices and error examples.
  • Adds a quick reference table summarizing limits and token/credential properties.

Comment thread content/nginxaas-google/quickstart/security-controls/client-credentials.md Outdated
Comment thread content/nginxaas-google/quickstart/security-controls/client-credentials.md Outdated
Comment thread content/nginxaas-google/quickstart/security-controls/client-credentials.md Outdated
Comment thread content/nginxaas-google/quickstart/security-controls/client-credentials.md Outdated
Comment thread content/nginxaas-google/quickstart/security-controls/client-credentials.md Outdated
Comment thread content/nginxaas-google/quickstart/security-controls/client-credentials.md Outdated
Comment thread content/nginxaas-google/quickstart/security-controls/client-credentials.md Outdated
Comment thread content/nginxaas-google/quickstart/security-controls/client-credentials.md Outdated
Comment thread content/nginxaas-google/quickstart/security-controls/client-credentials.md Outdated
Comment thread content/nginxaas-google/quickstart/security-controls/client-credentials.md Outdated
Comment thread content/nginxaas-google/quickstart/security-controls/client-credentials.md Outdated
Comment thread content/nginxaas-google/quickstart/security-controls/client-credentials.md Outdated
Comment thread content/nginxaas-google/quickstart/security-controls/client-credentials.md Outdated
Comment thread content/nginxaas-google/quickstart/security-controls/client-credentials.md Outdated
Comment thread content/nginxaas-google/quickstart/security-controls/client-credentials.md Outdated
Comment thread content/nginxaas-google/quickstart/security-controls/client-credentials.md Outdated
Comment thread content/nginxaas-google/quickstart/security-controls/client-credentials.md Outdated
Comment thread content/nginxaas-google/quickstart/security-controls/client-credentials.md Outdated
Comment thread content/nginxaas-google/quickstart/security-controls/client-credentials.md Outdated
Comment thread content/nginxaas-google/quickstart/security-controls/client-credentials.md Outdated
Comment thread content/nginxaas-google/quickstart/security-controls/client-credentials.md Outdated
Comment thread content/nginxaas-google/quickstart/security-controls/client-credentials.md Outdated
Comment thread content/nginxaas-google/quickstart/security-controls/client-credentials.md Outdated
Comment thread content/nginxaas-google/quickstart/security-controls/client-credentials.md Outdated
Comment thread content/nginxaas-google/quickstart/security-controls/client-credentials.md Outdated
@puneetsarna

Copy link
Copy Markdown
Contributor

@nparikh03 : Can you please make sure to address this https://github.com/nginx/documentation/pull/2052/changes#r3431835287. I will review the rest of it for now.

@nparikh03 nparikh03 force-pushed the naas/client-creds-docs branch from b2b0ddc to ac27394 Compare June 17, 2026 23:04
Comment thread content/nginxaas-google/quickstart/security-controls/client-credentials.md Outdated
Comment thread content/nginxaas-google/quickstart/security-controls/client-credentials.md Outdated
Comment thread content/nginxaas-google/quickstart/security-controls/client-credentials.md Outdated
Comment thread content/nginxaas-google/quickstart/security-controls/client-credentials.md Outdated
Comment thread content/nginxaas-google/quickstart/security-controls/client-credentials.md Outdated
Comment thread content/nginxaas-google/quickstart/security-controls/client-credentials.md Outdated
Comment thread content/nginxaas-google/quickstart/security-controls/client-credentials.md Outdated
Comment thread content/nginxaas-google/quickstart/security-controls/client-credentials.md Outdated
@nparikh03 nparikh03 force-pushed the naas/client-creds-docs branch from 851dafc to 55d1faa Compare June 20, 2026 22:10
@nparikh03 nparikh03 force-pushed the naas/client-creds-docs branch from 55d1faa to c50ac20 Compare June 20, 2026 22:19

@JTorreG JTorreG left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

approved with 2 nits

@JTorreG JTorreG requested review from mjang and puneetsarna June 22, 2026 14:44
@nparikh03 nparikh03 force-pushed the naas/client-creds-docs branch from 4ea1bb4 to 3fce686 Compare June 23, 2026 04:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants