Entity-schema (List)#

Path: /facilities/data-sources/data-schemas/entity-schema

Set of related entity and relation schemas for the entity based data stores.

Parameters#

NameTypeRequiredDefaultDescription
idstringrequiredThe unique identifer of the schema, used for identification purposes.
descriptionstringoptionalA human readable description of the schema.

Subsections#

NameTypeDescription
entity ListDefines an entity type/schema, such as a group or an organization.
entity-relation ListA relation between entities.
account-relation ListA relation between entities and account resources.
oauth-client-relation ListA relation between entities and DB OAuth client resources.
global-groups SectionEnable if global groups are supported by this entity schema. Global groups are groups that are not specific to a given context. Any Account Manager indirectly using this schema, via a configured Entity Manager, will use the Entity Manager for group management.

Was this helpful?