org.raml.v2.api.model.v08.security

Interface AbstractSecurityScheme

All Superinterfaces:

RAMLLanguageElement

All Known Subinterfaces:

BasicSecurityScheme, CustomSecurityScheme, DigestSecurityScheme, OAuth1SecurityScheme, OAuth2SecurityScheme

public interface AbstractSecurityScheme
extends RAMLLanguageElement

Method Summary

Methods

Modifier and Type	Method and Description
SecuritySchemePart	describedBy() A description of the request components related to Security that are determined by the scheme: the headers, query parameters or responses.
String	name() Name of the security scheme
SecuritySchemeSettings	settings() The settings attribute MAY be used to provide security scheme-specific information.
String	type() The securitySchemes property MUST be used to specify an API's security mechanisms, including the required settings and the authentication methods that the API supports.

Methods inherited from interface org.raml.v2.api.model.v08.common.RAMLLanguageElement

description

Method Detail

name

String name()

Name of the security scheme

type

String type()

The securitySchemes property MUST be used to specify an API's security mechanisms, including the required settings and the authentication methods that the API supports. one authentication method is allowed if the API supports them.

describedBy

SecuritySchemePart describedBy()

A description of the request components related to Security that are determined by the scheme: the headers, query parameters or responses. As a best practice, even for standard security schemes, API designers SHOULD describe these properties of security schemes. Including the security scheme description completes an API documentation.

settings

SecuritySchemeSettings settings()

The settings attribute MAY be used to provide security scheme-specific information. The required attributes vary depending on the type of security scheme is being declared. It describes the minimum set of properties which any processing application MUST provide and validate if it chooses to implement the security scheme. Processing applications MAY choose to recognize other properties for things such as token lifetime, preferred cryptographic algorithms, and more.