Package io.github.springwolf.asyncapi.v3.model.security_scheme

Class SecurityScheme

java.lang.Object

io.github.springwolf.asyncapi.v3.model.ExtendableObject

io.github.springwolf.asyncapi.v3.model.security_scheme.SecurityScheme

All Implemented Interfaces:

Reference

Direct Known Subclasses:

ApiKeySecurityScheme, HttpApiKeySecurityScheme, HttpSecurityScheme, OAuth2SecurityScheme, OpenIdConnectSecurityScheme

public class SecurityScheme
extends ExtendableObject
implements Reference

Defines a security scheme that can be used by the operations. Supported schemes are:

• User/Password.
• API key (either as user or as password).
• X.509 certificate.
• End-to-end encryption (either symmetric or asymmetric).
• HTTP authentication.
• HTTP API key.
• OAuth2's common flows (Implicit, Resource Owner Protected Credentials, Client Credentials and Authorization Code) as defined in RFC6749.
• OpenID Connect Discovery.
• SASL (Simple Authentication and Security Layer) as defined in RFC4422.

See Also:

• Schema Scheme Object

Field Summary

Fields inherited from class io.github.springwolf.asyncapi.v3.model.ExtendableObject

extensionFields

Constructor Summary

Constructors

Constructor	Description
SecurityScheme()

Method Summary

Modifier and Type	Method	Description
String	getRef()	Required.

Methods inherited from class io.github.springwolf.asyncapi.v3.model.ExtendableObject

readExtensionProperty

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SecurityScheme

public SecurityScheme()

Method Details

getRef

public String getRef()

Description copied from interface: Reference

Required. The reference string.

Specified by:

getRef in interface Reference