User API

The User API allows the end-user to retrieve basic information about themselves such as their userId, accountId and names.

{ "swagger": "2.0", "info": { "version": "2.3.0", "title": "Eagle Eye CameraManager API", "description": "RESTful API for the Eagle Eye CameraManager platform." }, "host": "rest.cameramanager.com", "schemes": [ "http", "https" ], "basePath": "/rest/v2.3", "produces": [ "application/json" ], "definitions": { "Error": { "type": "object", "description": "Generic error response, modelled after RFC 7807.", "properties": { "code": { "type": "integer", "description": "Error code within the system." }, "title": { "type": "string", "description": "This title is not meant to be shown to users and is not guaranteed to stay the same. Please use the code to parse the error." }, "detail": { "type": "string", "description": "Error details, to help developers detect what went wrong." } }, "required": [ "code", "title" ] }, "OAuth2Error": { "type": "object", "description": "Generic OAuth2 error response when there is something wrong with the OAuth2 authentication. Defined at RFC 6749.", "properties": { "error": { "type": "string", "description": "A single ASCII error code conforming the pattern." }, "error_description": { "type": "string", "description": "Human-readable ASCII text providing additional information, used to assist the client developer in understanding the error that occurred." } }, "required": [ "error" ] }, "UserBaseUpdate": { "type": "object", "properties": { "email": { "type": "string", "description": "The email of the user.", "minLength": 5, "maxLength": 255 }, "firstName": { "type": "string", "description": "The first name of the user. Also known as \"Given Name\"", "minLength": 2, "maxLength": 32 }, "lastName": { "type": "string", "description": "The last name of the user. Also known as \"Family Name\".", "minLength": 2, "maxLength": 32 } } }, "UserBase": { "allOf": [ { "$ref": "#/definitions/UserBaseUpdate" }, { "type": "object", "properties": { "userId": { "type": "integer", "description": "The user ID of the user." }, "accountId": { "type": "integer", "description": "The account ID of the account the user belongs to." } } } ] } }, "responses": { "unauthorized": { "description": "You are not authenticated. Please authenticate and try again.", "schema": { "$ref": "#/definitions/OAuth2Error" } }, "forbidden": { "description": "You have no permission to access the specified resource.", "schema": { "$ref": "#/definitions/Error" } }, "validationError": { "description": "The supplied object is invalid. Error detail will contain the validation error.", "schema": { "$ref": "#/definitions/Error" } }, "notAcceptableError": { "description": "The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request.", "schema": { "$ref": "#/definitions/Error" } }, "internalServerError": { "description": "Something went wrong in the server. Please try again.", "schema": { "$ref": "#/definitions/Error" } }, "conflict": { "description": "There was a conflict while trying to perform your request. See error details for more information." } }, "paths": { "/users/self": { "get": { "summary": "Get basic information about the user.", "description": "Get userId, accountId, email, firstName, lastName of the user.", "operationId": "getBaseUser", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserBase" } }, "401": { "$ref": "#/responses/unauthorized" }, "406": { "$ref": "#/responses/notAcceptableError" }, "500": { "$ref": "#/responses/internalServerError" } }, "tags": [ "User Base" ] }, "patch": { "summary": "Updates basic information about the user.", "description": "Updates user basic information like email, first and last name.", "operationId": "updateBaseUser", "parameters": [ { "name": "UserBaseUpdate", "in": "body", "required": true, "schema": { "$ref": "#/definitions/UserBaseUpdate" } } ], "responses": { "204": { "description": "No content" }, "400": { "$ref": "#/responses/validationError" }, "401": { "$ref": "#/responses/unauthorized" }, "403": { "$ref": "#/responses/forbidden" }, "406": { "$ref": "#/responses/notAcceptableError" }, "409": { "$ref": "#/responses/conflict" }, "500": { "$ref": "#/responses/internalServerError" } }, "tags": [ "User Base" ] } } } }

swagger-user-base.yaml