Hide Comments

The secured element applies one or more Security Schemes to control access to a Method, an Object Resource or Collection Resource, or an entire Resource API.

Syntax

secured [~by]

(<security-scheme>

[[~authorized [~for]] scopes <scopes>])...

Examples

secured by

auth.Basic

secured by

QueryStringKeyAuth

auth.OAuth2

authorized for scopes

admin, manager

Parameters

Name

Type

Description

<security-scheme>

QName(Security Scheme Definition)

A reference to a defined Security Scheme Definition that controls access to the Method(s) defined within the containing element.

<scopes>

List(Scope)

A delimited list of scopes authorized to use the Method(s) defined within the containing element. Each scope named in this list MUST be defined in the referenced <security-scheme>.

Child Elements

None.

Parent Elements

Resource API
Collection Resource
Object Resource
Method

Discussion

Security Schemes are applied with the following precedence rules:

1. A Security Scheme Application on a Method takes precedence for that Method, overriding any Security Scheme Application on the containing resource or Resource API.
2. A Security Scheme Application on a resource applies to all methods defined in that resource, except where overridden at the Method level.
3. A Security Scheme Application on a Resource API applies to all methods defined on all resources within that API, except where overridden at the resource or Method level.

Created with Help & Manual 6 and styled with Premium Pack Version 2.51 © by EC Software