org.raml.v2.model.v10.security

Interface OAuth2SecuritySchemeSettings

All Superinterfaces:

AbstractWrapperNode, Annotable, BasicFragmentNode, BasicNode, SecuritySchemeSettings

public interface OAuth2SecuritySchemeSettings
extends SecuritySchemeSettings

Method Summary

Methods

Modifier and Type	Method and Description
FixedUriString	accessTokenUri() The URI of the Token Endpoint as defined in RFC6749 Section 3.2.
List<String>	authorizationGrants() A list of the Authorization grants supported by the API as defined in RFC6749 Sections 4.1, 4.2, 4.3 and 4.4, can be any of: authorization_code, password, client_credentials, implicit, or refresh_token.
FixedUriString	authorizationUri() The URI of the Authorization Endpoint as defined in RFC6749 Section 3.1.
List<String>	scopes() A list of scopes supported by the security scheme as defined in RFC6749 Section 3.3

Methods inherited from interface org.raml.v2.model.v10.common.Annotable

annotations

Methods inherited from interface org.raml.v2.model.v10.fragment.BasicFragmentNode

fragment

Methods inherited from interface org.raml.v2.model.v10.core.BasicNode

meta, optional, optionalProperties, parent, toJSON

Method Detail

accessTokenUri

FixedUriString accessTokenUri()

The URI of the Token Endpoint as defined in RFC6749 Section 3.2. Not required forby implicit grant type.

authorizationUri

FixedUriString authorizationUri()

The URI of the Authorization Endpoint as defined in RFC6749 Section 3.1. Required forby authorization_code and implicit grant types.

authorizationGrants

List<String> authorizationGrants()

A list of the Authorization grants supported by the API as defined in RFC6749 Sections 4.1, 4.2, 4.3 and 4.4, can be any of: authorization_code, password, client_credentials, implicit, or refresh_token.

scopes

List<String> scopes()

A list of scopes supported by the security scheme as defined in RFC6749 Section 3.3