Token Generation API

{ "swagger": "2.0", "info": { "version": "2.2.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.2", "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" ] }, "Token": { "type": "object", "properties": { "accessToken": { "type": "string" }, "tokenType": { "$ref": "#/definitions/TokenType" }, "expiresIn": { "type": "integer", "format": "int32" }, "scope": { "$ref": "#/definitions/Scope" } } }, "TokenType": { "type": "string", "enum": [ "bearer" ] }, "Scope": { "type": "string", "enum": [ "read", "write" ] } }, "responses": { "resourceNotFound": { "description": "Referenced resource could not be found.", "schema": { "$ref": "#/definitions/Error" } }, "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" } }, "conflict": { "description": "There was a conflict while trying to perform your request. See error details for more information.", "schema": { "$ref": "#/definitions/Error" } }, "internalServerError": { "description": "Something went wrong in the server. Please try again.", "schema": { "$ref": "#/definitions/Error" } } }, "parameters": { "accountId": { "name": "accountId", "in": "path", "description": "ID of the account", "required": true, "type": "integer" }, "userId": { "name": "userId", "in": "path", "description": "ID of the user", "required": true, "type": "integer" } }, "paths": { "/resellers/self/accounts/{accountId}/users/{userId}/token": { "post": { "summary": "Generate token for a user by user ID", "description": "Generates and retrieves an authentication token for a user by user ID. User password is not needed for this action.", "operationId": "generateToken", "parameters": [ { "$ref": "#/parameters/accountId" }, { "$ref": "#/parameters/userId" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Token" } }, "400": { "$ref": "#/responses/validationError" }, "401": { "$ref": "#/responses/unauthorized" }, "403": { "$ref": "#/responses/forbidden" }, "404": { "$ref": "#/responses/resourceNotFound" }, "406": { "$ref": "#/responses/notAcceptableError" }, "500": { "$ref": "#/responses/internalServerError" } }, "tags": [ "TokenGeneration" ] } } } }