Stereotype «OpenAPISecurityScheme»
Stereotype «OpenAPISecurityScheme» can be used to define the authentication mechanism for servers that are defined in the OpenAPI specification.
| Stereotype | «OpenAPISecurityScheme» |
|
|---|---|---|
| Applicable Elements | Component |
|
| Tagged Values | ||
| Name | Type | Description |
type |
SecuritySchemeType |
Type of the security scheme. Possible values are: apiKey, http, oauth2, openIdConnect |
apiKeyName |
String |
Name of the api key in case that security scheme type apiKey is used. |
apiKeyLocation |
APIKeyLocation |
Name of the api key location in case that security scheme type apiKey is used. API keys can be provided as query, header or cookie param. |
httpAuthorizationScheme |
String |
The name of the HTTP Authorization scheme to be used in the Authorization header as defined in RFC7235. |
httpBearerFormat |
String |
A hint to the client to identify how the bearer token is formatted. Bearer tokens are usually generated by an authorization server, so this information is primarily for documentation purposes. |
openIdConnectUrl |
String |
OpenId Connect URL to discover OAuth2 configuration values. This must be in the form of a URL. The OpenID Connect standard requires the use of TLS. |
Generated by JEAF Generator