org.raml.v2.api.model.v10.security

Interface SecuritySchemeSettings

All Superinterfaces:

Annotable

public interface SecuritySchemeSettings
extends Annotable

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 Resource Owner Authorization endpoint as defined in RFC5849 Section 2.2 (OAuth 1) The URI of the Authorization Endpoint as defined in RFC6749 Section 3.1.
FixedUriString	requestTokenUri() The URI of the Temporary Credential Request endpoint as defined in RFC5849 Section 2.1 (OAuth 1)
List<String>	scopes() A list of scopes supported by the security scheme as defined in RFC6749 Section 3.3 (OAuth 2)
List<String>	signatures() List of the signature methods used by the server.
FixedUriString	tokenCredentialsUri() The URI of the Token Request endpoint as defined in RFC5849 Section 2.3 (OAuth 1)

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

annotations

Method Detail

requestTokenUri

FixedUriString requestTokenUri()

The URI of the Temporary Credential Request endpoint as defined in RFC5849 Section 2.1 (OAuth 1)

authorizationUri

FixedUriString authorizationUri()

The URI of the Resource Owner Authorization endpoint as defined in RFC5849 Section 2.2 (OAuth 1) The URI of the Authorization Endpoint as defined in RFC6749 Section 3.1. Required forby authorization_code and implicit grant types. (OAuth 2)

tokenCredentialsUri

FixedUriString tokenCredentialsUri()

The URI of the Token Request endpoint as defined in RFC5849 Section 2.3 (OAuth 1)

signatures

List<String> signatures()

List of the signature methods used by the server. Available methods: HMAC-SHA1, RSA-SHA1, PLAINTEXT (OAuth 1)

accessTokenUri

FixedUriString accessTokenUri()

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

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. (OAuth 2)

scopes

List<String> scopes()

A list of scopes supported by the security scheme as defined in RFC6749 Section 3.3 (OAuth 2)