pronghorn-core Schemas

On this page:

groups-schema

{ "$schema": "http://json-schema.org/draft-07/schema", "$id": "groups-schema", "type": "object", "title": "Itential Group Schema", "description": "This is the schema for an IAP group stored in Mongo", "properties": { "provenance": { "$ref": "#/definitions/provenance" }, "name": { "$ref": "#/definitions/name" }, "description": { "$ref": "#/definitions/description" }, "memberOf": { "$ref": "#/definitions/memberOf" }, "assignedRoles": { "$ref": "#/definitions/assignedRoles" }, "inactive": { "$ref": "#/definitions/inactive" }, "_meta": { "title": "Metadata", "description": "Metadata for group", "type": "object", "properties": { "created": { "title": "Created", "description": "When the group was created", "type": "string", "examples": [ "2018-08-02T15:56:12.912Z" ] }, "updated": { "title": "Updated", "description": "When the group was last updated", "type": "string", "examples": [ "2018-08-02T15:56:12.912Z" ] } } } }, "additionalProperties": false, "required": [ "provenance", "name", "description", "memberOf", "assignedRoles", "inactive" ], "definitions": { "inactive": { "title": "Inactive", "description": "Setting for whether group is active or not", "type": "boolean" }, "provenance": { "title": "Provenance", "description": "AAA provider where group originated", "type": "string", "examples": [ "Local AAA", "Pronghorn" ] }, "name": { "title": "Name", "description": "Name of group", "type": "string", "examples": [ "group_1" ] }, "description": { "title": "Description", "description": "Description of group", "type": "string", "examples": [ "description of group_1" ] }, "memberOf": { "title": "Assigned Groups", "description": "Parent groups which this group is a part of", "type": "array", "items": { "type": "object", "properties": { "aaaManaged": { "description": "Whether group comes from an external AAA or not", "type": "boolean" }, "groupId": { "$ref": "common-schema#/definitions/objectId" } } } }, "assignedRoles": { "title": "Assigned Roles", "description": "Roles assigned to this group", "type": "array", "items": { "type": "object", "properties": { "roleId": { "title": "Role ID", "$ref": "common-schema#/definitions/objectId" } }, "additionalProperties": false } } } }