sb-beacon-api Beacon Configuration [ ↗ ]

{S}[B] Status [i]
proposed
Provenance
Used by
Contributors
Source (2.0.0)

Attributes

Type: object
Description: Files complaint with this schema are the configuration ones. The details returned in service-info are mirroring the ones in this configuration file.

Properties

PropertyType
$schema../common/beaconCommonComponents.json#/definitions/$schema
entryTypes#/definitions/EntryTypes
maturityAttributesobject
securityAttributesobject

$schema

entryTypes

maturityAttributes

Declares the level of maturity of the Beacon instance.

securityAttributes

Configuration of the security aspects of the Beacon. By default, a Beacon that does not declare the configuration settings would return boolean (true/false) responses, and only if the user is authenticated and explicitly authorized to access the Beacon resources. Although this is the safest set of settings, it is not recommended unless the Beacon shares very sensitive information. Non sensitive Beacons should preferably opt for a record and PUBLIC combination.