Skip to content

Commit 22d8a84

Browse files
Add description to Authenticate API (#2152)
* Authenticate * Add generated output schema
1 parent 765a609 commit 22d8a84

File tree

2 files changed

+4
-2
lines changed

2 files changed

+4
-2
lines changed

output/schema/schema.json

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

specification/security/authenticate/SecurityAuthenticateRequest.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,8 @@ import { RequestBase } from '@_types/Base'
2121

2222
/**
2323
* Enables you to submit a request with a basic auth header to authenticate a user and retrieve information about the authenticated user.
24+
* 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.
25+
* If the user cannot be authenticated, this API returns a 401 status code.
2426
* @rest_spec_name security.authenticate
2527
* @availability stack since=5.5.0 stability=stable
2628
* @availability serverless stability=stable visibility=public

0 commit comments

Comments
 (0)