Entity-schema (List)#
Path: /facilities/data-sources/data-schemas/entity-schema
Set of related entity and relation schemas for the entity based data stores.
Keys: id
Parameters#
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| id | string | required | - | The unique identifier of the schema, used for identification purposes. |
| description | string | optional | - | A human readable description of the schema. |
Subsections#
| Name | Type | Description |
|---|---|---|
| partitioned | Section | Enable if the schema has a partitioning entity, such as organizations. |
| entity | List | Defines an entity type/schema, such as a group or an organization. |
| entity-relation | List | A relation between entities. |
| account-relation | List | A relation between entities and account resources. |
| oauth-client-relation | List | A relation between entities and DB OAuth client resources. |
| configuration-setting-relation | List | A relation between entities and configuration settings. |
| global-groups | Section | Enable if global groups are supported by this entity schema. Global groups are groups that are not specific to a given partitioning entity. Any Account Manager indirectly using this schema, via a configured Entity Manager, will use the Entity Manager for group management. |
| profile-scopes | Section | Enable if profile database scopes are supported by this entity schema. Profile scopes are scopes that are associated to a profile and not specific to a partitioning entity. |