service-accounts-schema

Copied to Clipboard

{ "$schema": "http://json-schema.org/draft-07/schema", "$id": "service-accounts-schema", "type": "object", "title": "Itential OAuth Service Account Schema", "description": "This is the schema for an OAuth service account stored in Mongo", "properties": { "_id": { "$ref": "common-schema#/definitions/objectId" }, "name": { "$ref": "#/definitions/name" }, "description": { "$ref": "#/definitions/description" }, "clientId": { "$ref": "#/definitions/clientId" }, "clientSecret": { "$ref": "#/definitions/clientSecret" }, "_meta": { "type": "object", "properties": { "updated": { "$ref": "#/definitions/timestamp" }, "updatedBy": { "$ref": "common-schema#/definitions/objectId" }, "created": { "$ref": "#/definitions/timestamp" }, "createdBy": { "$ref": "common-schema#/definitions/objectId" } } } }, "additionalProperties": false, "required": [ "name", "description", "clientId", "clientSecret" ], "definitions": { "name": { "type": "string", "description": "The name associated with the service account", "examples": [ "ExampleName" ] }, "description": { "type": "string", "description": "The description of the service account", "examples": [ "This is a service account for the external Example system" ] }, "clientId": { "$ref": "common-schema#/definitions/objectId" }, "clientSecret": { "type": "string", "description": "Uuid representation of client secret", "examples": [ "d4c673d6-17f8-4e76-8034-a87820f96618" ] }, "modifiedByDereferenced": { "type": "object", "properties": { "_id": { "$ref": "common-schema#/definitions/objectId" }, "username": { "type": "string", "examples": [ "username@itential" ] } } }, "timestamp": { "type": "string", "examples": [ "2018-08-02T15:56:12.912Z" ] } } }