Skip to content

Add description to Authenticate API #2152

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Jun 26, 2023
Merged

Add description to Authenticate API #2152

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3f338e4
Authenticate
abdonpijpelink Jun 23, 2023
5d028bf
Add generated output schema
abdonpijpelink Jun 23, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions output/schema/schema.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 2 additions & 0 deletions specification/security/authenticate/SecurityAuthenticateRequest.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ import { RequestBase } from '@_types/Base'

/**
* Enables you to submit a request with a basic auth header to authenticate a user and retrieve information about the authenticated user.
* A successful call returns a JSON structure that shows user information such as their username, the roles that are assigned to the user, any assigned metadata, and information about the realms that authenticated and authorized the user.
* If the user cannot be authenticated, this API returns a 401 status code.
* @rest_spec_name security.authenticate
* @availability stack since=5.5.0 stability=stable
* @availability serverless stability=stable visibility=public
Expand Down