Update authentication API spec - #28
Merged
Merged
Conversation
- Lower rate limits for authorize and introspect to 100/min - Rename schema components to PascalCase (e.g., jwks→Jwks, clientId→ClientId) - Add error responses (400/401/429/500) to token, revoke, introspect, userinfo, logout endpoints - Add `create` prompt value and improve nonce/state parameter docs - Add `client_secret` body param to token endpoint - Add `required` field for token introspect request - Expand OidcSpec and userinfo examples; move from x-examples to inline examples - Rename `thumbnails`→`user_thumbnails`, `is_2fa_enabled`→`is_twofa_enabled` - Add twofa_type, contact_mode, user_source_type fields to UserInfo - Add server overrides for /userinfo pointing to api.aps.autodesk.com - Increase scope character limit from 2000 to 3000 - Fix introspect_endpoint (was introspection_endpoint) in OidcSpec - Remove required constraints from TwoLeggedToken/ThreeLeggedToken
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the Authentication OpenAPI specification to reflect revised rate limits, schema/component naming, and expanded endpoint behaviors (responses, parameters, and examples) for OAuth/OIDC flows.
Changes:
- Updates rate-limit documentation and improves authorization parameter documentation (nonce/state/prompt/scope).
- Renames schema components to PascalCase and expands inline examples (JWKS, token responses, introspect, OIDC discovery, userinfo).
- Adds/extends error responses and updates
/userinfohost overrides plus UserInfo fields/renames.
Comments suppressed due to low confidence (2)
authentication/authentication.yaml:358
- PR description says introspect should document 400/401/429/500 responses, but the spec currently omits a 429 response for rate limiting. Add a 429 response to match the documented behavior elsewhere (for example, token/userinfo).
'400':
description: The request is missing the required ``token`` parameter, or the ``client_id`` was supplied in the request body when Authorization headers are present.
'401':
description: The client credentials are invalid.
'500':
description: Generic internal server error.
authentication/authentication.yaml:433
- PR description says logout should include error responses (400/401/429/500), but the spec only adds a 500 response here. Either add the missing 400/401/429 responses (with appropriate descriptions) or update the PR description to reflect the intended scope.
responses:
'302':
description: The user was successfully logged out.
'500':
description: Generic internal server error.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| issuer: 'https://developer.api.autodesk.com' | ||
| authorization_endpoint: 'https://developer.api.autodesk.com/authentication/v2/authorize' | ||
| token_endpoint: 'https://developer.api.autodesk.com/authentication/v2/token' | ||
| userinfo_endpoint: 'https://api.userprofile.autodesk.com/userinfo' |
| operationId: get-user-info | ||
| description: Retrieves information about the authenticated user. | ||
| description: | | ||
| Retrieves the profile information of an authorizing end user in a OIDC-compliant three-legged context. |
Comment on lines
+162
to
+167
| '400': | ||
| description: The request is missing a required parameter, or the ``client_id`` was supplied in the request body when Authorization headers are present. | ||
| '401': | ||
| description: No client credentials were found, or the client credentials are invalid. | ||
| '500': | ||
| description: Generic internal server error. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
createprompt value and improve nonce/state parameter docsclient_secretbody param to token endpointrequiredfield for token introspect requestthumbnails→user_thumbnails,is_2fa_enabled→is_twofa_enabled