Attributes
- Companion
- trait
- Graph
-
- Supertypes
-
trait Sumtrait Mirrorclass Objecttrait Matchableclass Any
- Self type
-
SecurityScheme.type
Members list
Type members
Classlikes
Defines an HTTP security scheme that can be used by the operations.
Defines an HTTP security scheme that can be used by the operations.
Value parameters
- description
-
A short description for security scheme.
- in
-
The location of the API key.
- name
-
The name of the header, query or cookie parameter to be used.
Attributes
- Companion
- object
- Supertypes
-
trait Serializabletrait Producttrait Equalstrait SecuritySchemeclass Objecttrait Matchableclass AnyShow all
Value parameters
- bearerFormat
-
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.
- description
-
A short description for security scheme.
- scheme
-
The name of the HTTP Authorization scheme to be used in the Authorization header as defined in [RFC7235]. The values used SHOULD be registered in the IANA Authentication Scheme registry.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalstrait SecuritySchemeclass Objecttrait Matchableclass AnyShow all
Value parameters
- description
-
A short description for security scheme.
- flows
-
An object containing configuration information for the flow types supported.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalstrait SecuritySchemeclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- object
- Supertypes
-
class Objecttrait Matchableclass Any
- Known subtypes
Allows configuration of the supported OAuth Flows.
Allows configuration of the supported OAuth Flows.
Value parameters
- `implicit`
-
Configuration for the OAuth Implicit flow.
- authorizationCode
-
Configuration for the OAuth Authorization Code flow. Previously called accessCode in OpenAPI 2.0.
- clientCredentials
-
Configuration for the OAuth Client Credentials flow. Previously called application in OpenAPI 2.0.
- password
-
Configuration for the OAuth Resource Owner Password flow
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Value parameters
- description
-
A short description for security scheme.
- openIdConnectUrl
-
OpenId Connect URL to discover OAuth2 configuration values.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalstrait SecuritySchemeclass Objecttrait Matchableclass AnyShow all
Lists the required security schemes to execute this operation. The name used for each property MUST correspond to a security scheme declared in the Security Schemes under the Components Object.
Lists the required security schemes to execute this operation. The name used for each property MUST correspond to a security scheme declared in the Security Schemes under the Components Object.
Security Requirement Objects that contain multiple schemes require that all schemes MUST be satisfied for a request to be authorized. This enables support for scenarios where multiple query parameters or HTTP headers are required to convey security information.
When a list of Security Requirement Objects is defined on the OpenAPI Object or Operation Object, only one of the Security Requirement Objects in the list needs to be satisfied to authorize the request.
Value parameters
- securitySchemes
-
If the security scheme is of type "oauth2" or "openIdConnect", then the value is a list of scope names required for the execution, and the list MAY be empty if authorization does not require a specified scope. For other security scheme types, the List MUST be empty.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Inherited types
The names of the product elements
The names of the product elements
Attributes
- Inherited from:
- Mirror
The name of the type
The name of the type
Attributes
- Inherited from:
- Mirror