{ "swagger": "2.0", "info": { "version": "1", "title": "ClearPass Swagger API", "contact": {} }, "host": "10.5.26.222", "basePath": "/api", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [], "schemes": ["https", "http"], "paths": { "/static-host-list": { "get": { "description": "Get a list of static host lists", "summary": "GET_for_StaticHostList", "operationId": "GET_for_StaticHostList", "deprecated": false, "produces": [ "application/vnd.identity.v1+json", "application/hal+json", "application/json" ], "parameters": [{ "name": "filter", "in": "query", "required": false, "default": "{}", "type": "string", "description": "JSON filter expression specifying the items to return" }, { "name": "sort", "in": "query", "required": false, "default": "+id", "type": "string", "description": "Sort ordering for returned items" }, { "name": "offset", "in": "query", "required": false, "default": 0, "type": "integer", "format": "int64", "minimum": 0.0, "exclusiveMinimum": false, "description": "Zero based offset to start from" }, { "name": "limit", "in": "query", "required": false, "default": 25, "type": "integer", "format": "int64", "minimum": 1.0, "maximum": 1000.0, "exclusiveMaximum": false, "exclusiveMinimum": false, "description": "Maximum number of items to return (1 – 1000)" }, { "name": "calculate_count", "in": "query", "required": false, "default": false, "type": "boolean", "description": "Whether to calculate the total item count" } ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/StaticHostListList" }, "headers": {} }, "401": { "description": "Unauthorized", "headers": {} }, "403": { "description": "Forbidden", "headers": {} }, "406": { "description": "Not Acceptable", "headers": {} }, "415": { "description": "Unsupported Media Type", "headers": {} }, "422": { "description": "Unprocessable Entity", "headers": {} } }, "security": [] }, "post": { "description": "Create a static host list", "summary": "POST_for_StaticHostList", "operationId": "POST_for_StaticHostList", "deprecated": false, "produces": [ "application/vnd.identity.v1+json", "application/hal+json", "application/json" ], "parameters": [{ "name": "body", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/StaticHostList" } }], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/StaticHostList" }, "headers": {} }, "201": { "description": "Created", "headers": {} }, "401": { "description": "Unauthorized", "headers": {} }, "403": { "description": "Forbidden", "headers": {} }, "406": { "description": "Not Acceptable", "headers": {} }, "415": { "description": "Unsupported Media Type", "headers": {} }, "422": { "description": "Unprocessable Entity", "headers": {} } }, "security": [] } }, "/static-host-list/{static_host_list_id}": { "get": { "description": "Get a static host list", "summary": "GET_for_StaticHostList", "operationId": "GetGET_for_StaticHostList", "deprecated": false, "produces": [ "application/vnd.identity.v1+json", "application/hal+json", "application/json" ], "parameters": [{ "name": "static_host_list_id", "in": "path", "required": true, "type": "integer", "format": "int32", "minimum": 0.0, "maximum": 1.0, "exclusiveMaximum": false, "exclusiveMinimum": false, "description": "Numeric ID of the static host list" }], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/StaticHostList" }, "headers": {} }, "401": { "description": "Unauthorized", "headers": {} }, "403": { "description": "Forbidden", "headers": {} }, "404": { "description": "Not Found", "headers": {} }, "406": { "description": "Not Acceptable", "headers": {} }, "415": { "description": "Unsupported Media Type", "headers": {} } }, "security": [] }, "patch": { "description": "Update some fields of a static host list", "summary": "PATCH_for_StaticHostList", "operationId": "PATCH_for_StaticHostList", "deprecated": false, "produces": [ "application/vnd.identity.v1+json", "application/hal+json", "application/json" ], "parameters": [{ "name": "static_host_list_id", "in": "path", "required": true, "type": "integer", "format": "int32", "minimum": 0.0, "maximum": 1.0, "exclusiveMaximum": false, "exclusiveMinimum": false, "description": "Numeric ID of the static host list" }, { "name": "body", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/StaticHostList" } } ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/StaticHostList" }, "headers": {} }, "204": { "description": "No Content", "headers": {} }, "304": { "description": "Not Modified", "headers": {} }, "401": { "description": "Unauthorized", "headers": {} }, "403": { "description": "Forbidden", "headers": {} }, "404": { "description": "Not Found", "headers": {} }, "406": { "description": "Not Acceptable", "headers": {} }, "415": { "description": "Unsupported Media Type", "headers": {} }, "422": { "description": "Unprocessable Entity", "headers": {} } }, "security": [] }, "put": { "description": "Replace a static host list", "summary": "PUT_for_StaticHostList", "operationId": "PUT_for_StaticHostList", "deprecated": false, "produces": [ "application/vnd.identity.v1+json", "application/hal+json", "application/json" ], "parameters": [{ "name": "static_host_list_id", "in": "path", "required": true, "type": "integer", "format": "int32", "minimum": 0.0, "maximum": 1.0, "exclusiveMaximum": false, "exclusiveMinimum": false, "description": "Numeric ID of the static host list" }, { "name": "body", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/StaticHostList" } } ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/StaticHostList" }, "headers": {} }, "204": { "description": "No Content", "headers": {} }, "304": { "description": "Not Modified", "headers": {} }, "401": { "description": "Unauthorized", "headers": {} }, "403": { "description": "Forbidden", "headers": {} }, "404": { "description": "Not Found", "headers": {} }, "406": { "description": "Not Acceptable", "headers": {} }, "415": { "description": "Unsupported Media Type", "headers": {} }, "422": { "description": "Unprocessable Entity", "headers": {} } }, "security": [] }, "delete": { "description": "Delete a static host list", "summary": "DELETE_for_StaticHostList", "operationId": "DELETE_for_StaticHostList", "deprecated": false, "produces": [ "application/json" ], "parameters": [{ "name": "static_host_list_id", "in": "path", "required": true, "type": "integer", "format": "int32", "minimum": 0.0, "maximum": 1.0, "exclusiveMaximum": false, "exclusiveMinimum": false, "description": "Numeric ID of the static host list" }], "responses": { "204": { "description": "No Content", "headers": {} }, "401": { "description": "Unauthorized", "headers": {} }, "403": { "description": "Forbidden", "headers": {} }, "404": { "description": "Not Found", "headers": {} }, "406": { "description": "Not Acceptable", "headers": {} }, "415": { "description": "Unsupported Media Type", "headers": {} } }, "security": [] } }, "/static-host-list/name/{name}": { "get": { "description": "Get a static host list by name", "summary": "GET_for_StaticHostList_by_name", "operationId": "GET_for_StaticHostList_by_name", "deprecated": false, "produces": [ "application/vnd.identity.v1+json", "application/hal+json", "application/json" ], "parameters": [{ "name": "name", "in": "path", "required": true, "type": "string", "description": "Unique name of the static host list" }], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/StaticHostList" }, "headers": {} }, "401": { "description": "Unauthorized", "headers": {} }, "403": { "description": "Forbidden", "headers": {} }, "404": { "description": "Not Found", "headers": {} }, "406": { "description": "Not Acceptable", "headers": {} }, "415": { "description": "Unsupported Media Type", "headers": {} } }, "security": [] }, "patch": { "description": "Update some fields of a static host list by name", "summary": "PATCH_for_StaticHostList_by_name", "operationId": "PATCH_for_StaticHostList_by_name", "deprecated": false, "produces": [ "application/vnd.identity.v1+json", "application/hal+json", "application/json" ], "parameters": [{ "name": "name", "in": "path", "required": true, "type": "string", "description": "Unique name of the static host list" }, { "name": "body", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/StaticHostList" } } ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/StaticHostList" }, "headers": {} }, "204": { "description": "No Content", "headers": {} }, "304": { "description": "Not Modified", "headers": {} }, "401": { "description": "Unauthorized", "headers": {} }, "403": { "description": "Forbidden", "headers": {} }, "404": { "description": "Not Found", "headers": {} }, "406": { "description": "Not Acceptable", "headers": {} }, "415": { "description": "Unsupported Media Type", "headers": {} }, "422": { "description": "Unprocessable Entity", "headers": {} } }, "security": [] }, "put": { "description": "Replace a static host list by name", "summary": "PUT_for_StaticHostList_by_name", "operationId": "PUT_for_StaticHostList_by_name", "deprecated": false, "produces": [ "application/vnd.identity.v1+json", "application/hal+json", "application/json" ], "parameters": [{ "name": "name", "in": "path", "required": true, "type": "string", "description": "Unique name of the static host list" }, { "name": "body", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/StaticHostList" } } ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/StaticHostList" }, "headers": {} }, "204": { "description": "No Content", "headers": {} }, "304": { "description": "Not Modified", "headers": {} }, "401": { "description": "Unauthorized", "headers": {} }, "403": { "description": "Forbidden", "headers": {} }, "404": { "description": "Not Found", "headers": {} }, "406": { "description": "Not Acceptable", "headers": {} }, "415": { "description": "Unsupported Media Type", "headers": {} }, "422": { "description": "Unprocessable Entity", "headers": {} } }, "security": [] }, "delete": { "description": "Delete a static host list by name", "summary": "DELETE_for_StaticHostList_by_name", "operationId": "DELETE_for_StaticHostList_by_name", "deprecated": false, "produces": [ "application/json" ], "parameters": [{ "name": "name", "in": "path", "required": true, "type": "string", "description": "Unique name of the static host list" }], "responses": { "204": { "description": "No Content", "headers": {} }, "401": { "description": "Unauthorized", "headers": {} }, "403": { "description": "Forbidden", "headers": {} }, "404": { "description": "Not Found", "headers": {} }, "406": { "description": "Not Acceptable", "headers": {} }, "415": { "description": "Unsupported Media Type", "headers": {} } }, "security": [] } }, "/role": { "get": { "description": "Get a list of roles", "summary": "GET_for_Role", "operationId": "GET_for_Role", "deprecated": false, "produces": [ "application/vnd.identity.v1+json", "application/hal+json", "application/json" ], "parameters": [{ "name": "filter", "in": "query", "required": false, "default": "{}", "type": "string", "description": "JSON filter expression specifying the items to return" }, { "name": "sort", "in": "query", "required": false, "default": "+id", "type": "string", "description": "Sort ordering for returned items" }, { "name": "offset", "in": "query", "required": false, "default": 0, "type": "integer", "format": "int64", "minimum": 0.0, "exclusiveMinimum": false, "description": "Zero based offset to start from" }, { "name": "limit", "in": "query", "required": false, "default": 25, "type": "integer", "format": "int64", "minimum": 1.0, "maximum": 1000.0, "exclusiveMaximum": false, "exclusiveMinimum": false, "description": "Maximum number of items to return (1 – 1000)" }, { "name": "calculate_count", "in": "query", "required": false, "default": false, "type": "boolean", "description": "Whether to calculate the total item count" } ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/RoleList" }, "headers": {} }, "401": { "description": "Unauthorized", "headers": {} }, "403": { "description": "Forbidden", "headers": {} }, "406": { "description": "Not Acceptable", "headers": {} }, "415": { "description": "Unsupported Media Type", "headers": {} }, "422": { "description": "Unprocessable Entity", "headers": {} } }, "security": [] }, "post": { "description": "Create a new role", "summary": "POST_for_Role", "operationId": "POST_for_Role", "deprecated": false, "produces": [ "application/vnd.identity.v1+json", "application/hal+json", "application/json" ], "parameters": [{ "name": "body", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/Role" } }], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/Role" }, "headers": {} }, "201": { "description": "Created", "headers": {} }, "401": { "description": "Unauthorized", "headers": {} }, "403": { "description": "Forbidden", "headers": {} }, "406": { "description": "Not Acceptable", "headers": {} }, "415": { "description": "Unsupported Media Type", "headers": {} }, "422": { "description": "Unprocessable Entity", "headers": {} } }, "security": [] } }, "/role/{role_id}": { "get": { "description": "Get a role", "summary": "GET_for_Role", "operationId": "GetGET_for_Role", "deprecated": false, "produces": [ "application/vnd.identity.v1+json", "application/hal+json", "application/json" ], "parameters": [{ "name": "role_id", "in": "path", "required": true, "type": "integer", "format": "int32", "minimum": 0.0, "maximum": 1.0, "exclusiveMaximum": false, "exclusiveMinimum": false, "description": "Numeric ID of the role" }], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/Role" }, "headers": {} }, "401": { "description": "Unauthorized", "headers": {} }, "403": { "description": "Forbidden", "headers": {} }, "404": { "description": "Not Found", "headers": {} }, "406": { "description": "Not Acceptable", "headers": {} }, "415": { "description": "Unsupported Media Type", "headers": {} } }, "security": [] }, "patch": { "description": "Update some fields of a role", "summary": "PATCH_for_Role", "operationId": "PATCH_for_Role", "deprecated": false, "produces": [ "application/vnd.identity.v1+json", "application/hal+json", "application/json" ], "parameters": [{ "name": "role_id", "in": "path", "required": true, "type": "integer", "format": "int32", "minimum": 0.0, "maximum": 1.0, "exclusiveMaximum": false, "exclusiveMinimum": false, "description": "Numeric ID of the role" }, { "name": "body", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/Role" } } ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/Role" }, "headers": {} }, "204": { "description": "No Content", "headers": {} }, "304": { "description": "Not Modified", "headers": {} }, "401": { "description": "Unauthorized", "headers": {} }, "403": { "description": "Forbidden", "headers": {} }, "404": { "description": "Not Found", "headers": {} }, "406": { "description": "Not Acceptable", "headers": {} }, "415": { "description": "Unsupported Media Type", "headers": {} }, "422": { "description": "Unprocessable Entity", "headers": {} } }, "security": [] }, "put": { "description": "Replace a role", "summary": "PUT_for_Role", "operationId": "PUT_for_Role", "deprecated": false, "produces": [ "application/vnd.identity.v1+json", "application/hal+json", "application/json" ], "parameters": [{ "name": "role_id", "in": "path", "required": true, "type": "integer", "format": "int32", "minimum": 0.0, "maximum": 1.0, "exclusiveMaximum": false, "exclusiveMinimum": false, "description": "Numeric ID of the role" }, { "name": "body", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/Role" } } ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/Role" }, "headers": {} }, "204": { "description": "No Content", "headers": {} }, "304": { "description": "Not Modified", "headers": {} }, "401": { "description": "Unauthorized", "headers": {} }, "403": { "description": "Forbidden", "headers": {} }, "404": { "description": "Not Found", "headers": {} }, "406": { "description": "Not Acceptable", "headers": {} }, "415": { "description": "Unsupported Media Type", "headers": {} }, "422": { "description": "Unprocessable Entity", "headers": {} } }, "security": [] }, "delete": { "description": "Delete a role", "summary": "DELETE_for_Role", "operationId": "DELETE_for_Role", "deprecated": false, "produces": [ "application/json" ], "parameters": [{ "name": "role_id", "in": "path", "required": true, "type": "integer", "format": "int32", "minimum": 0.0, "maximum": 1.0, "exclusiveMaximum": false, "exclusiveMinimum": false, "description": "Numeric ID of the role" }], "responses": { "204": { "description": "No Content", "headers": {} }, "401": { "description": "Unauthorized", "headers": {} }, "403": { "description": "Forbidden", "headers": {} }, "404": { "description": "Not Found", "headers": {} }, "406": { "description": "Not Acceptable", "headers": {} }, "415": { "description": "Unsupported Media Type", "headers": {} } }, "security": [] } }, "/role/name/{name}": { "get": { "description": "Get a role by name", "summary": "GET_for_Role_by_name", "operationId": "GET_for_Role_by_name", "deprecated": false, "produces": [ "application/vnd.identity.v1+json", "application/hal+json", "application/json" ], "parameters": [{ "name": "name", "in": "path", "required": true, "type": "string", "description": "Unique name of the role" }], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/Role" }, "headers": {} }, "401": { "description": "Unauthorized", "headers": {} }, "403": { "description": "Forbidden", "headers": {} }, "404": { "description": "Not Found", "headers": {} }, "406": { "description": "Not Acceptable", "headers": {} }, "415": { "description": "Unsupported Media Type", "headers": {} } }, "security": [] }, "patch": { "description": "Update some fields of a role by name", "summary": "PATCH_for_Role_by_name", "operationId": "PATCH_for_Role_by_name", "deprecated": false, "produces": [ "application/vnd.identity.v1+json", "application/hal+json", "application/json" ], "parameters": [{ "name": "name", "in": "path", "required": true, "type": "string", "description": "Unique name of the role" }, { "name": "body", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/Role" } } ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/Role" }, "headers": {} }, "204": { "description": "No Content", "headers": {} }, "304": { "description": "Not Modified", "headers": {} }, "401": { "description": "Unauthorized", "headers": {} }, "403": { "description": "Forbidden", "headers": {} }, "404": { "description": "Not Found", "headers": {} }, "406": { "description": "Not Acceptable", "headers": {} }, "415": { "description": "Unsupported Media Type", "headers": {} }, "422": { "description": "Unprocessable Entity", "headers": {} } }, "security": [] }, "put": { "description": "Replace a role by name", "summary": "PUT_for_Role_by_name", "operationId": "PUT_for_Role_by_name", "deprecated": false, "produces": [ "application/vnd.identity.v1+json", "application/hal+json", "application/json" ], "parameters": [{ "name": "name", "in": "path", "required": true, "type": "string", "description": "Unique name of the role" }, { "name": "body", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/Role" } } ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/Role" }, "headers": {} }, "204": { "description": "No Content", "headers": {} }, "304": { "description": "Not Modified", "headers": {} }, "401": { "description": "Unauthorized", "headers": {} }, "403": { "description": "Forbidden", "headers": {} }, "404": { "description": "Not Found", "headers": {} }, "406": { "description": "Not Acceptable", "headers": {} }, "415": { "description": "Unsupported Media Type", "headers": {} }, "422": { "description": "Unprocessable Entity", "headers": {} } }, "security": [] }, "delete": { "description": "Delete a role by name", "summary": "DELETE_for_Role_by_name", "operationId": "DELETE_for_Role_by_name", "deprecated": false, "produces": [ "application/json" ], "parameters": [{ "name": "name", "in": "path", "required": true, "type": "string", "description": "Unique name of the role" }], "responses": { "204": { "description": "No Content", "headers": {} }, "401": { "description": "Unauthorized", "headers": {} }, "403": { "description": "Forbidden", "headers": {} }, "404": { "description": "Not Found", "headers": {} }, "406": { "description": "Not Acceptable", "headers": {} }, "415": { "description": "Unsupported Media Type", "headers": {} } }, "security": [] } }, "/local-user/password-policy": { "get": { "description": "Get the local user password policy", "summary": "GET_for_LocalUserPasswordPolicy", "operationId": "GET_for_LocalUserPasswordPolicy", "deprecated": false, "produces": [ "application/vnd.identity.v1+json", "application/json" ], "parameters": [], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/LocalUserPasswordPolicy" }, "headers": {} }, "404": { "description": "Not Found", "headers": {} }, "406": { "description": "Not Acceptable", "headers": {} }, "415": { "description": "Unsupported Media Type", "headers": {} } }, "security": [] }, "put": { "description": "Put the local user password policy", "summary": "PUT_for_LocalUserPasswordPolicy", "operationId": "PUT_for_LocalUserPasswordPolicy", "deprecated": false, "produces": [ "application/vnd.identity.v1+json", "application/json" ], "parameters": [{ "name": "body", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/LocalUserPasswordPolicy" } }], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/LocalUserPasswordPolicy" }, "headers": {} }, "204": { "description": "No Content", "headers": {} }, "304": { "description": "Not Modified", "headers": {} }, "404": { "description": "Not Found", "headers": {} }, "406": { "description": "Not Acceptable", "headers": {} }, "415": { "description": "Unsupported Media Type", "headers": {} }, "422": { "description": "Unprocessable Entity", "headers": {} } }, "security": [] }, "patch": { "description": "Patch the local user password policy", "summary": "PATCH_for_LocalUserPasswordPolicy", "operationId": "PATCH_for_LocalUserPasswordPolicy", "deprecated": false, "produces": [ "application/vnd.identity.v1+json", "application/json" ], "parameters": [{ "name": "body", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/LocalUserPasswordPolicy" } }], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/LocalUserPasswordPolicy" }, "headers": {} }, "204": { "description": "No Content", "headers": {} }, "304": { "description": "Not Modified", "headers": {} }, "404": { "description": "Not Found", "headers": {} }, "406": { "description": "Not Acceptable", "headers": {} }, "415": { "description": "Unsupported Media Type", "headers": {} }, "422": { "description": "Unprocessable Entity", "headers": {} } }, "security": [] } }, "/local-user": { "get": { "description": "Get a list of local users", "summary": "GET_for_LocalUser", "operationId": "GET_for_LocalUser", "deprecated": false, "produces": [ "application/vnd.identity.v1+json", "application/hal+json", "application/json" ], "parameters": [{ "name": "filter", "in": "query", "required": false, "default": "{}", "type": "string", "description": "JSON filter expression specifying the items to return" }, { "name": "sort", "in": "query", "required": false, "default": "+id", "type": "string", "description": "Sort ordering for returned items" }, { "name": "offset", "in": "query", "required": false, "default": 0, "type": "integer", "format": "int64", "minimum": 0.0, "exclusiveMinimum": false, "description": "Zero based offset to start from" }, { "name": "limit", "in": "query", "required": false, "default": 25, "type": "integer", "format": "int64", "minimum": 1.0, "maximum": 1000.0, "exclusiveMaximum": false, "exclusiveMinimum": false, "description": "Maximum number of items to return (1 – 1000)" }, { "name": "calculate_count", "in": "query", "required": false, "default": false, "type": "boolean", "description": "Whether to calculate the total item count" } ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/LocalUserList" }, "headers": {} }, "401": { "description": "Unauthorized", "headers": {} }, "403": { "description": "Forbidden", "headers": {} }, "406": { "description": "Not Acceptable", "headers": {} }, "415": { "description": "Unsupported Media Type", "headers": {} }, "422": { "description": "Unprocessable Entity", "headers": {} } }, "security": [] }, "post": { "description": "Create a new local user", "summary": "POST_for_LocalUser", "operationId": "POST_for_LocalUser", "deprecated": false, "produces": [ "application/vnd.identity.v1+json", "application/hal+json", "application/json" ], "parameters": [{ "name": "body", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/LocalUser" } }], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/LocalUser" }, "headers": {} }, "201": { "description": "Created", "headers": {} }, "401": { "description": "Unauthorized", "headers": {} }, "403": { "description": "Forbidden", "headers": {} }, "406": { "description": "Not Acceptable", "headers": {} }, "415": { "description": "Unsupported Media Type", "headers": {} }, "422": { "description": "Unprocessable Entity", "headers": {} } }, "security": [] } }, "/local-user/{local_user_id}": { "get": { "description": "Get a local user", "summary": "GET_for_LocalUser", "operationId": "GetGET_for_LocalUser", "deprecated": false, "produces": [ "application/vnd.identity.v1+json", "application/hal+json", "application/json" ], "parameters": [{ "name": "local_user_id", "in": "path", "required": true, "type": "integer", "format": "int32", "minimum": 0.0, "maximum": 1.0, "exclusiveMaximum": false, "exclusiveMinimum": false, "description": "Numeric ID of the local user" }], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/LocalUser" }, "headers": {} }, "401": { "description": "Unauthorized", "headers": {} }, "403": { "description": "Forbidden", "headers": {} }, "404": { "description": "Not Found", "headers": {} }, "406": { "description": "Not Acceptable", "headers": {} }, "415": { "description": "Unsupported Media Type", "headers": {} } }, "security": [] }, "patch": { "description": "Update some fields of a local user", "summary": "PATCH_for_LocalUser", "operationId": "PATCH_for_LocalUser", "deprecated": false, "produces": [ "application/vnd.identity.v1+json", "application/hal+json", "application/json" ], "parameters": [{ "name": "local_user_id", "in": "path", "required": true, "type": "integer", "format": "int32", "minimum": 0.0, "maximum": 1.0, "exclusiveMaximum": false, "exclusiveMinimum": false, "description": "Numeric ID of the local user" }, { "name": "body", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/LocalUser" } } ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/LocalUser" }, "headers": {} }, "204": { "description": "No Content", "headers": {} }, "304": { "description": "Not Modified", "headers": {} }, "401": { "description": "Unauthorized", "headers": {} }, "403": { "description": "Forbidden", "headers": {} }, "404": { "description": "Not Found", "headers": {} }, "406": { "description": "Not Acceptable", "headers": {} }, "415": { "description": "Unsupported Media Type", "headers": {} }, "422": { "description": "Unprocessable Entity", "headers": {} } }, "security": [] }, "put": { "description": "Replace a local user", "summary": "PUT_for_LocalUser", "operationId": "PUT_for_LocalUser", "deprecated": false, "produces": [ "application/vnd.identity.v1+json", "application/hal+json", "application/json" ], "parameters": [{ "name": "local_user_id", "in": "path", "required": true, "type": "integer", "format": "int32", "minimum": 0.0, "maximum": 1.0, "exclusiveMaximum": false, "exclusiveMinimum": false, "description": "Numeric ID of the local user" }, { "name": "body", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/LocalUser" } } ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/LocalUser" }, "headers": {} }, "204": { "description": "No Content", "headers": {} }, "304": { "description": "Not Modified", "headers": {} }, "401": { "description": "Unauthorized", "headers": {} }, "403": { "description": "Forbidden", "headers": {} }, "404": { "description": "Not Found", "headers": {} }, "406": { "description": "Not Acceptable", "headers": {} }, "415": { "description": "Unsupported Media Type", "headers": {} }, "422": { "description": "Unprocessable Entity", "headers": {} } }, "security": [] }, "delete": { "description": "Delete a local user", "summary": "DELETE_for_LocalUser", "operationId": "DELETE_for_LocalUser", "deprecated": false, "produces": [ "application/json" ], "parameters": [{ "name": "local_user_id", "in": "path", "required": true, "type": "integer", "format": "int32", "minimum": 0.0, "maximum": 1.0, "exclusiveMaximum": false, "exclusiveMinimum": false, "description": "Numeric ID of the local user" }], "responses": { "204": { "description": "No Content", "headers": {} }, "401": { "description": "Unauthorized", "headers": {} }, "403": { "description": "Forbidden", "headers": {} }, "404": { "description": "Not Found", "headers": {} }, "406": { "description": "Not Acceptable", "headers": {} }, "415": { "description": "Unsupported Media Type", "headers": {} } }, "security": [] } }, "/local-user/user-id/{user_id}": { "get": { "description": "Get a local user by user_id", "summary": "GET_for_LocalUser_by_user_id", "operationId": "GET_for_LocalUser_by_user_id", "deprecated": false, "produces": [ "application/vnd.identity.v1+json", "application/hal+json", "application/json" ], "parameters": [{ "name": "user_id", "in": "path", "required": true, "type": "string", "description": "Unique user_id of the local user" }], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/LocalUser" }, "headers": {} }, "401": { "description": "Unauthorized", "headers": {} }, "403": { "description": "Forbidden", "headers": {} }, "404": { "description": "Not Found", "headers": {} }, "406": { "description": "Not Acceptable", "headers": {} }, "415": { "description": "Unsupported Media Type", "headers": {} } }, "security": [] }, "patch": { "description": "Update some fields of a local user by user_id", "summary": "PATCH_for_LocalUser_by_user_id", "operationId": "PATCH_for_LocalUser_by_user_id", "deprecated": false, "produces": [ "application/vnd.identity.v1+json", "application/hal+json", "application/json" ], "parameters": [{ "name": "user_id", "in": "path", "required": true, "type": "string", "description": "Unique user_id of the local user" }, { "name": "body", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/LocalUser" } } ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/LocalUser" }, "headers": {} }, "204": { "description": "No Content", "headers": {} }, "304": { "description": "Not Modified", "headers": {} }, "401": { "description": "Unauthorized", "headers": {} }, "403": { "description": "Forbidden", "headers": {} }, "404": { "description": "Not Found", "headers": {} }, "406": { "description": "Not Acceptable", "headers": {} }, "415": { "description": "Unsupported Media Type", "headers": {} }, "422": { "description": "Unprocessable Entity", "headers": {} } }, "security": [] }, "put": { "description": "Replace a local user by user_id", "summary": "PUT_for_LocalUser_by_user_id", "operationId": "PUT_for_LocalUser_by_user_id", "deprecated": false, "produces": [ "application/vnd.identity.v1+json", "application/hal+json", "application/json" ], "parameters": [{ "name": "user_id", "in": "path", "required": true, "type": "string", "description": "Unique user_id of the local user" }, { "name": "body", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/LocalUser" } } ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/LocalUser" }, "headers": {} }, "204": { "description": "No Content", "headers": {} }, "304": { "description": "Not Modified", "headers": {} }, "401": { "description": "Unauthorized", "headers": {} }, "403": { "description": "Forbidden", "headers": {} }, "404": { "description": "Not Found", "headers": {} }, "406": { "description": "Not Acceptable", "headers": {} }, "415": { "description": "Unsupported Media Type", "headers": {} }, "422": { "description": "Unprocessable Entity", "headers": {} } }, "security": [] }, "delete": { "description": "Delete a local user by user_id", "summary": "DELETE_for_LocalUser_by_user_id", "operationId": "DELETE_for_LocalUser_by_user_id", "deprecated": false, "produces": [ "application/json" ], "parameters": [{ "name": "user_id", "in": "path", "required": true, "type": "string", "description": "Unique user_id of the local user" }], "responses": { "204": { "description": "No Content", "headers": {} }, "401": { "description": "Unauthorized", "headers": {} }, "403": { "description": "Forbidden", "headers": {} }, "404": { "description": "Not Found", "headers": {} }, "406": { "description": "Not Acceptable", "headers": {} }, "415": { "description": "Unsupported Media Type", "headers": {} } }, "security": [] } }, "/endpoint": { "get": { "description": "Get a list of endpoints", "summary": "GET_for_Endpoint", "operationId": "GET_for_Endpoint", "deprecated": false, "produces": [ "application/vnd.identity.v1+json", "application/hal+json", "application/json" ], "parameters": [{ "name": "filter", "in": "query", "required": false, "default": "{}", "type": "string", "description": "JSON filter expression specifying the items to return" }, { "name": "sort", "in": "query", "required": false, "default": "+id", "type": "string", "description": "Sort ordering for returned items" }, { "name": "offset", "in": "query", "required": false, "default": 0, "type": "integer", "format": "int64", "minimum": 0.0, "exclusiveMinimum": false, "description": "Zero based offset to start from" }, { "name": "limit", "in": "query", "required": false, "default": 25, "type": "integer", "format": "int64", "minimum": 1.0, "maximum": 1000.0, "exclusiveMaximum": false, "exclusiveMinimum": false, "description": "Maximum number of items to return (1 – 1000)" }, { "name": "calculate_count", "in": "query", "required": false, "default": false, "type": "boolean", "description": "Whether to calculate the total item count" } ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/EndpointList" }, "headers": {} }, "401": { "description": "Unauthorized", "headers": {} }, "403": { "description": "Forbidden", "headers": {} }, "406": { "description": "Not Acceptable", "headers": {} }, "415": { "description": "Unsupported Media Type", "headers": {} }, "422": { "description": "Unprocessable Entity", "headers": {} } }, "security": [] }, "post": { "description": "Create a new endpoint", "summary": "POST_for_Endpoint", "operationId": "POST_for_Endpoint", "deprecated": false, "produces": [ "application/vnd.identity.v1+json", "application/hal+json", "application/json" ], "parameters": [{ "name": "body", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/Endpoint" } }], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/Endpoint" }, "headers": {} }, "201": { "description": "Created", "headers": {} }, "401": { "description": "Unauthorized", "headers": {} }, "403": { "description": "Forbidden", "headers": {} }, "406": { "description": "Not Acceptable", "headers": {} }, "415": { "description": "Unsupported Media Type", "headers": {} }, "422": { "description": "Unprocessable Entity", "headers": {} } }, "security": [] } }, "/endpoint/{endpoint_id}": { "get": { "description": "Get an endpoint", "summary": "GET_for_Endpoint", "operationId": "GetGET_for_Endpoint", "deprecated": false, "produces": [ "application/vnd.identity.v1+json", "application/hal+json", "application/json" ], "parameters": [{ "name": "endpoint_id", "in": "path", "required": true, "type": "integer", "format": "int32", "minimum": 0.0, "maximum": 1.0, "exclusiveMaximum": false, "exclusiveMinimum": false, "description": "Numeric ID of the endpoint" }], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/Endpoint" }, "headers": {} }, "401": { "description": "Unauthorized", "headers": {} }, "403": { "description": "Forbidden", "headers": {} }, "404": { "description": "Not Found", "headers": {} }, "406": { "description": "Not Acceptable", "headers": {} }, "415": { "description": "Unsupported Media Type", "headers": {} } }, "security": [] }, "patch": { "description": "Update some fields of an endpoint", "summary": "PATCH_for_Endpoint", "operationId": "PATCH_for_Endpoint", "deprecated": false, "produces": [ "application/vnd.identity.v1+json", "application/hal+json", "application/json" ], "parameters": [{ "name": "endpoint_id", "in": "path", "required": true, "type": "integer", "format": "int32", "minimum": 0.0, "maximum": 1.0, "exclusiveMaximum": false, "exclusiveMinimum": false, "description": "Numeric ID of the endpoint" }, { "name": "body", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/Endpoint" } } ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/Endpoint" }, "headers": {} }, "204": { "description": "No Content", "headers": {} }, "304": { "description": "Not Modified", "headers": {} }, "401": { "description": "Unauthorized", "headers": {} }, "403": { "description": "Forbidden", "headers": {} }, "404": { "description": "Not Found", "headers": {} }, "406": { "description": "Not Acceptable", "headers": {} }, "415": { "description": "Unsupported Media Type", "headers": {} }, "422": { "description": "Unprocessable Entity", "headers": {} } }, "security": [] }, "put": { "description": "Replace an endpoint", "summary": "PUT_for_Endpoint", "operationId": "PUT_for_Endpoint", "deprecated": false, "produces": [ "application/vnd.identity.v1+json", "application/hal+json", "application/json" ], "parameters": [{ "name": "endpoint_id", "in": "path", "required": true, "type": "integer", "format": "int32", "minimum": 0.0, "maximum": 1.0, "exclusiveMaximum": false, "exclusiveMinimum": false, "description": "Numeric ID of the endpoint" }, { "name": "body", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/Endpoint" } } ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/Endpoint" }, "headers": {} }, "204": { "description": "No Content", "headers": {} }, "304": { "description": "Not Modified", "headers": {} }, "401": { "description": "Unauthorized", "headers": {} }, "403": { "description": "Forbidden", "headers": {} }, "404": { "description": "Not Found", "headers": {} }, "406": { "description": "Not Acceptable", "headers": {} }, "415": { "description": "Unsupported Media Type", "headers": {} }, "422": { "description": "Unprocessable Entity", "headers": {} } }, "security": [] }, "delete": { "description": "Delete an endpoint", "summary": "DELETE_for_Endpoint", "operationId": "DELETE_for_Endpoint", "deprecated": false, "produces": [ "application/json" ], "parameters": [{ "name": "endpoint_id", "in": "path", "required": true, "type": "integer", "format": "int32", "minimum": 0.0, "maximum": 1.0, "exclusiveMaximum": false, "exclusiveMinimum": false, "description": "Numeric ID of the endpoint" }], "responses": { "204": { "description": "No Content", "headers": {} }, "401": { "description": "Unauthorized", "headers": {} }, "403": { "description": "Forbidden", "headers": {} }, "404": { "description": "Not Found", "headers": {} }, "406": { "description": "Not Acceptable", "headers": {} }, "415": { "description": "Unsupported Media Type", "headers": {} } }, "security": [] } }, "/endpoint/mac-address/{mac_address}": { "get": { "description": "Get an endpoint by mac_address", "summary": "GET_for_Endpoint_by_mac_address", "operationId": "GET_for_Endpoint_by_mac_address", "deprecated": false, "produces": [ "application/vnd.identity.v1+json", "application/hal+json", "application/json" ], "parameters": [{ "name": "mac_address", "in": "path", "required": true, "type": "string", "description": "Unique mac_address of the endpoint" }], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/Endpoint" }, "headers": {} }, "401": { "description": "Unauthorized", "headers": {} }, "403": { "description": "Forbidden", "headers": {} }, "404": { "description": "Not Found", "headers": {} }, "406": { "description": "Not Acceptable", "headers": {} }, "415": { "description": "Unsupported Media Type", "headers": {} } }, "security": [] }, "patch": { "description": "Update some fields of an endpoint by mac_address", "summary": "PATCH_for_Endpoint_by_mac_address", "operationId": "PATCH_for_Endpoint_by_mac_address", "deprecated": false, "produces": [ "application/vnd.identity.v1+json", "application/hal+json", "application/json" ], "parameters": [{ "name": "mac_address", "in": "path", "required": true, "type": "string", "description": "Unique mac_address of the endpoint" }, { "name": "body", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/Endpoint" } } ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/Endpoint" }, "headers": {} }, "204": { "description": "No Content", "headers": {} }, "304": { "description": "Not Modified", "headers": {} }, "401": { "description": "Unauthorized", "headers": {} }, "403": { "description": "Forbidden", "headers": {} }, "404": { "description": "Not Found", "headers": {} }, "406": { "description": "Not Acceptable", "headers": {} }, "415": { "description": "Unsupported Media Type", "headers": {} }, "422": { "description": "Unprocessable Entity", "headers": {} } }, "security": [] }, "put": { "description": "Replace an endpoint by mac_address", "summary": "PUT_for_Endpoint_by_mac_address", "operationId": "PUT_for_Endpoint_by_mac_address", "deprecated": false, "produces": [ "application/vnd.identity.v1+json", "application/hal+json", "application/json" ], "parameters": [{ "name": "mac_address", "in": "path", "required": true, "type": "string", "description": "Unique mac_address of the endpoint" }, { "name": "body", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/Endpoint" } } ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/Endpoint" }, "headers": {} }, "204": { "description": "No Content", "headers": {} }, "304": { "description": "Not Modified", "headers": {} }, "401": { "description": "Unauthorized", "headers": {} }, "403": { "description": "Forbidden", "headers": {} }, "404": { "description": "Not Found", "headers": {} }, "406": { "description": "Not Acceptable", "headers": {} }, "415": { "description": "Unsupported Media Type", "headers": {} }, "422": { "description": "Unprocessable Entity", "headers": {} } }, "security": [] }, "delete": { "description": "Delete an endpoint by mac_address", "summary": "DELETE_for_Endpoint_by_mac_address", "operationId": "DELETE_for_Endpoint_by_mac_address", "deprecated": false, "produces": [ "application/json" ], "parameters": [{ "name": "mac_address", "in": "path", "required": true, "type": "string", "description": "Unique mac_address of the endpoint" }], "responses": { "204": { "description": "No Content", "headers": {} }, "401": { "description": "Unauthorized", "headers": {} }, "403": { "description": "Forbidden", "headers": {} }, "404": { "description": "Not Found", "headers": {} }, "406": { "description": "Not Acceptable", "headers": {} }, "415": { "description": "Unsupported Media Type", "headers": {} } }, "security": [] } }, "/proxy-target": { "get": { "description": "Get a list of proxy targets", "summary": "GET_for_ProxyTarget", "operationId": "GET_for_ProxyTarget", "deprecated": false, "produces": [ "application/vnd.network.v1+json", "application/hal+json", "application/json" ], "parameters": [{ "name": "filter", "in": "query", "required": false, "default": "{}", "type": "string", "description": "JSON filter expression specifying the items to return" }, { "name": "sort", "in": "query", "required": false, "default": "+id", "type": "string", "description": "Sort ordering for returned items" }, { "name": "offset", "in": "query", "required": false, "default": 0, "type": "integer", "format": "int64", "minimum": 0.0, "exclusiveMinimum": false, "description": "Zero based offset to start from" }, { "name": "limit", "in": "query", "required": false, "default": 25, "type": "integer", "format": "int64", "minimum": 1.0, "maximum": 1000.0, "exclusiveMaximum": false, "exclusiveMinimum": false, "description": "Maximum number of items to return (1 – 1000)" }, { "name": "calculate_count", "in": "query", "required": false, "default": false, "type": "boolean", "description": "Whether to calculate the total item count" } ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/ProxyTargetList" }, "headers": {} }, "401": { "description": "Unauthorized", "headers": {} }, "403": { "description": "Forbidden", "headers": {} }, "406": { "description": "Not Acceptable", "headers": {} }, "415": { "description": "Unsupported Media Type", "headers": {} }, "422": { "description": "Unprocessable Entity", "headers": {} } }, "security": [] }, "post": { "description": "Create a new proxy target", "summary": "POST_for_ProxyTarget", "operationId": "POST_for_ProxyTarget", "deprecated": false, "produces": [ "application/vnd.network.v1+json", "application/hal+json", "application/json" ], "parameters": [{ "name": "body", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/ProxyTarget" } }], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/ProxyTarget" }, "headers": {} }, "201": { "description": "Created", "headers": {} }, "401": { "description": "Unauthorized", "headers": {} }, "403": { "description": "Forbidden", "headers": {} }, "406": { "description": "Not Acceptable", "headers": {} }, "415": { "description": "Unsupported Media Type", "headers": {} }, "422": { "description": "Unprocessable Entity", "headers": {} } }, "security": [] } }, "/proxy-target/{proxy_target_id}": { "get": { "description": "Get a proxy target", "summary": "GET_for_ProxyTarget", "operationId": "GetGET_for_ProxyTarget", "deprecated": false, "produces": [ "application/vnd.network.v1+json", "application/hal+json", "application/json" ], "parameters": [{ "name": "proxy_target_id", "in": "path", "required": true, "type": "integer", "format": "int32", "minimum": 0.0, "maximum": 1.0, "exclusiveMaximum": false, "exclusiveMinimum": false, "description": "Numeric ID of the proxy target" }], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/ProxyTarget" }, "headers": {} }, "401": { "description": "Unauthorized", "headers": {} }, "403": { "description": "Forbidden", "headers": {} }, "404": { "description": "Not Found", "headers": {} }, "406": { "description": "Not Acceptable", "headers": {} }, "415": { "description": "Unsupported Media Type", "headers": {} } }, "security": [] }, "patch": { "description": "Update some fields of a proxy target", "summary": "PATCH_for_ProxyTarget", "operationId": "PATCH_for_ProxyTarget", "deprecated": false, "produces": [ "application/vnd.network.v1+json", "application/hal+json", "application/json" ], "parameters": [{ "name": "proxy_target_id", "in": "path", "required": true, "type": "integer", "format": "int32", "minimum": 0.0, "maximum": 1.0, "exclusiveMaximum": false, "exclusiveMinimum": false, "description": "Numeric ID of the proxy target" }, { "name": "body", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/ProxyTarget" } } ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/ProxyTarget" }, "headers": {} }, "204": { "description": "No Content", "headers": {} }, "304": { "description": "Not Modified", "headers": {} }, "401": { "description": "Unauthorized", "headers": {} }, "403": { "description": "Forbidden", "headers": {} }, "404": { "description": "Not Found", "headers": {} }, "406": { "description": "Not Acceptable", "headers": {} }, "415": { "description": "Unsupported Media Type", "headers": {} }, "422": { "description": "Unprocessable Entity", "headers": {} } }, "security": [] }, "put": { "description": "Replace a proxy target", "summary": "PUT_for_ProxyTarget", "operationId": "PUT_for_ProxyTarget", "deprecated": false, "produces": [ "application/vnd.network.v1+json", "application/hal+json", "application/json" ], "parameters": [{ "name": "proxy_target_id", "in": "path", "required": true, "type": "integer", "format": "int32", "minimum": 0.0, "maximum": 1.0, "exclusiveMaximum": false, "exclusiveMinimum": false, "description": "Numeric ID of the proxy target" }, { "name": "body", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/ProxyTarget" } } ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/ProxyTarget" }, "headers": {} }, "204": { "description": "No Content", "headers": {} }, "304": { "description": "Not Modified", "headers": {} }, "401": { "description": "Unauthorized", "headers": {} }, "403": { "description": "Forbidden", "headers": {} }, "404": { "description": "Not Found", "headers": {} }, "406": { "description": "Not Acceptable", "headers": {} }, "415": { "description": "Unsupported Media Type", "headers": {} }, "422": { "description": "Unprocessable Entity", "headers": {} } }, "security": [] }, "delete": { "description": "Delete a proxy target", "summary": "DELETE_for_ProxyTarget", "operationId": "DELETE_for_ProxyTarget", "deprecated": false, "produces": [ "application/json" ], "parameters": [{ "name": "proxy_target_id", "in": "path", "required": true, "type": "integer", "format": "int32", "minimum": 0.0, "maximum": 1.0, "exclusiveMaximum": false, "exclusiveMinimum": false, "description": "Numeric ID of the proxy target" }], "responses": { "204": { "description": "No Content", "headers": {} }, "401": { "description": "Unauthorized", "headers": {} }, "403": { "description": "Forbidden", "headers": {} }, "404": { "description": "Not Found", "headers": {} }, "406": { "description": "Not Acceptable", "headers": {} }, "415": { "description": "Unsupported Media Type", "headers": {} } }, "security": [] } }, "/proxy-target/name/{name}": { "get": { "description": "Get a proxy target by name", "summary": "GET_for_ProxyTarget_by_name", "operationId": "GET_for_ProxyTarget_by_name", "deprecated": false, "produces": [ "application/vnd.network.v1+json", "application/hal+json", "application/json" ], "parameters": [{ "name": "name", "in": "path", "required": true, "type": "string", "description": "Unique name of the proxy target" }], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/ProxyTarget" }, "headers": {} }, "401": { "description": "Unauthorized", "headers": {} }, "403": { "description": "Forbidden", "headers": {} }, "404": { "description": "Not Found", "headers": {} }, "406": { "description": "Not Acceptable", "headers": {} }, "415": { "description": "Unsupported Media Type", "headers": {} } }, "security": [] }, "patch": { "description": "Update some fields of a proxy target by name", "summary": "PATCH_for_ProxyTarget_by_name", "operationId": "PATCH_for_ProxyTarget_by_name", "deprecated": false, "produces": [ "application/vnd.network.v1+json", "application/hal+json", "application/json" ], "parameters": [{ "name": "name", "in": "path", "required": true, "type": "string", "description": "Unique name of the proxy target" }, { "name": "body", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/ProxyTarget" } } ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/ProxyTarget" }, "headers": {} }, "204": { "description": "No Content", "headers": {} }, "304": { "description": "Not Modified", "headers": {} }, "401": { "description": "Unauthorized", "headers": {} }, "403": { "description": "Forbidden", "headers": {} }, "404": { "description": "Not Found", "headers": {} }, "406": { "description": "Not Acceptable", "headers": {} }, "415": { "description": "Unsupported Media Type", "headers": {} }, "422": { "description": "Unprocessable Entity", "headers": {} } }, "security": [] }, "put": { "description": "Replace a proxy target by name", "summary": "PUT_for_ProxyTarget_by_name", "operationId": "PUT_for_ProxyTarget_by_name", "deprecated": false, "produces": [ "application/vnd.network.v1+json", "application/hal+json", "application/json" ], "parameters": [{ "name": "name", "in": "path", "required": true, "type": "string", "description": "Unique name of the proxy target" }, { "name": "body", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/ProxyTarget" } } ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/ProxyTarget" }, "headers": {} }, "204": { "description": "No Content", "headers": {} }, "304": { "description": "Not Modified", "headers": {} }, "401": { "description": "Unauthorized", "headers": {} }, "403": { "description": "Forbidden", "headers": {} }, "404": { "description": "Not Found", "headers": {} }, "406": { "description": "Not Acceptable", "headers": {} }, "415": { "description": "Unsupported Media Type", "headers": {} }, "422": { "description": "Unprocessable Entity", "headers": {} } }, "security": [] }, "delete": { "description": "Delete a proxy target by name", "summary": "DELETE_for_ProxyTarget_by_name", "operationId": "DELETE_for_ProxyTarget_by_name", "deprecated": false, "produces": [ "application/json" ], "parameters": [{ "name": "name", "in": "path", "required": true, "type": "string", "description": "Unique name of the proxy target" }], "responses": { "204": { "description": "No Content", "headers": {} }, "401": { "description": "Unauthorized", "headers": {} }, "403": { "description": "Forbidden", "headers": {} }, "404": { "description": "Not Found", "headers": {} }, "406": { "description": "Not Acceptable", "headers": {} }, "415": { "description": "Unsupported Media Type", "headers": {} } }, "security": [] } }, "/network-device": { "get": { "description": "Get a list of network devices", "summary": "GET_for_NetworkDevice", "operationId": "GET_for_NetworkDevice", "deprecated": false, "produces": [ "application/vnd.network.v1+json", "application/hal+json", "application/json" ], "parameters": [{ "name": "filter", "in": "query", "required": false, "default": "{}", "type": "string", "description": "JSON filter expression specifying the items to return" }, { "name": "sort", "in": "query", "required": false, "default": "+id", "type": "string", "description": "Sort ordering for returned items" }, { "name": "offset", "in": "query", "required": false, "default": 0, "type": "integer", "format": "int64", "minimum": 0.0, "exclusiveMinimum": false, "description": "Zero based offset to start from" }, { "name": "limit", "in": "query", "required": false, "default": 25, "type": "integer", "format": "int64", "minimum": 1.0, "maximum": 1000.0, "exclusiveMaximum": false, "exclusiveMinimum": false, "description": "Maximum number of items to return (1 – 1000)" }, { "name": "calculate_count", "in": "query", "required": false, "default": false, "type": "boolean", "description": "Whether to calculate the total item count" } ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/NetworkDeviceList" }, "headers": {} }, "401": { "description": "Unauthorized", "headers": {} }, "403": { "description": "Forbidden", "headers": {} }, "406": { "description": "Not Acceptable", "headers": {} }, "415": { "description": "Unsupported Media Type", "headers": {} }, "422": { "description": "Unprocessable Entity", "headers": {} } }, "security": [] }, "post": { "description": "Create a new network device", "summary": "POST_for_NetworkDevice", "operationId": "POST_for_NetworkDevice", "deprecated": false, "produces": [ "application/vnd.network.v1+json", "application/hal+json", "application/json" ], "parameters": [{ "name": "body", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/NetworkDevice" } }], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/NetworkDevice" }, "headers": {} }, "201": { "description": "Created", "headers": {} }, "401": { "description": "Unauthorized", "headers": {} }, "403": { "description": "Forbidden", "headers": {} }, "406": { "description": "Not Acceptable", "headers": {} }, "415": { "description": "Unsupported Media Type", "headers": {} }, "422": { "description": "Unprocessable Entity", "headers": {} } }, "security": [] } }, "/network-device/{network_device_id}": { "get": { "description": "Get a network device", "summary": "GET_for_NetworkDevice", "operationId": "GetGET_for_NetworkDevice", "deprecated": false, "produces": [ "application/vnd.network.v1+json", "application/hal+json", "application/json" ], "parameters": [{ "name": "network_device_id", "in": "path", "required": true, "type": "integer", "format": "int32", "minimum": 0.0, "maximum": 1.0, "exclusiveMaximum": false, "exclusiveMinimum": false, "description": "Numeric ID of the network device" }], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/NetworkDevice" }, "headers": {} }, "401": { "description": "Unauthorized", "headers": {} }, "403": { "description": "Forbidden", "headers": {} }, "404": { "description": "Not Found", "headers": {} }, "406": { "description": "Not Acceptable", "headers": {} }, "415": { "description": "Unsupported Media Type", "headers": {} } }, "security": [] }, "patch": { "description": "Update some fields of a network device", "summary": "PATCH_for_NetworkDevice", "operationId": "PATCH_for_NetworkDevice", "deprecated": false, "produces": [ "application/vnd.network.v1+json", "application/hal+json", "application/json" ], "parameters": [{ "name": "network_device_id", "in": "path", "required": true, "type": "integer", "format": "int32", "minimum": 0.0, "maximum": 1.0, "exclusiveMaximum": false, "exclusiveMinimum": false, "description": "Numeric ID of the network device" }, { "name": "body", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/NetworkDevice" } } ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/NetworkDevice" }, "headers": {} }, "204": { "description": "No Content", "headers": {} }, "304": { "description": "Not Modified", "headers": {} }, "401": { "description": "Unauthorized", "headers": {} }, "403": { "description": "Forbidden", "headers": {} }, "404": { "description": "Not Found", "headers": {} }, "406": { "description": "Not Acceptable", "headers": {} }, "415": { "description": "Unsupported Media Type", "headers": {} }, "422": { "description": "Unprocessable Entity", "headers": {} } }, "security": [] }, "put": { "description": "Replace a network device", "summary": "PUT_for_NetworkDevice", "operationId": "PUT_for_NetworkDevice", "deprecated": false, "produces": [ "application/vnd.network.v1+json", "application/hal+json", "application/json" ], "parameters": [{ "name": "network_device_id", "in": "path", "required": true, "type": "integer", "format": "int32", "minimum": 0.0, "maximum": 1.0, "exclusiveMaximum": false, "exclusiveMinimum": false, "description": "Numeric ID of the network device" }, { "name": "body", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/NetworkDevice" } } ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/NetworkDevice" }, "headers": {} }, "204": { "description": "No Content", "headers": {} }, "304": { "description": "Not Modified", "headers": {} }, "401": { "description": "Unauthorized", "headers": {} }, "403": { "description": "Forbidden", "headers": {} }, "404": { "description": "Not Found", "headers": {} }, "406": { "description": "Not Acceptable", "headers": {} }, "415": { "description": "Unsupported Media Type", "headers": {} }, "422": { "description": "Unprocessable Entity", "headers": {} } }, "security": [] }, "delete": { "description": "Delete a network device", "summary": "DELETE_for_NetworkDevice", "operationId": "DELETE_for_NetworkDevice", "deprecated": false, "produces": [ "application/json" ], "parameters": [{ "name": "network_device_id", "in": "path", "required": true, "type": "integer", "format": "int32", "minimum": 0.0, "maximum": 1.0, "exclusiveMaximum": false, "exclusiveMinimum": false, "description": "Numeric ID of the network device" }], "responses": { "204": { "description": "No Content", "headers": {} }, "401": { "description": "Unauthorized", "headers": {} }, "403": { "description": "Forbidden", "headers": {} }, "404": { "description": "Not Found", "headers": {} }, "406": { "description": "Not Acceptable", "headers": {} }, "415": { "description": "Unsupported Media Type", "headers": {} } }, "security": [] } }, "/network-device/name/{name}": { "get": { "description": "Get a network device by name", "summary": "GET_for_NetworkDevice_by_name", "operationId": "GET_for_NetworkDevice_by_name", "deprecated": false, "produces": [ "application/vnd.network.v1+json", "application/hal+json", "application/json" ], "parameters": [{ "name": "name", "in": "path", "required": true, "type": "string", "description": "Unique name of the network device" }], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/NetworkDevice" }, "headers": {} }, "401": { "description": "Unauthorized", "headers": {} }, "403": { "description": "Forbidden", "headers": {} }, "404": { "description": "Not Found", "headers": {} }, "406": { "description": "Not Acceptable", "headers": {} }, "415": { "description": "Unsupported Media Type", "headers": {} } }, "security": [] }, "patch": { "description": "Update some fields of a network device by name", "summary": "PATCH_for_NetworkDevice_by_name", "operationId": "PATCH_for_NetworkDevice_by_name", "deprecated": false, "produces": [ "application/vnd.network.v1+json", "application/hal+json", "application/json" ], "parameters": [{ "name": "name", "in": "path", "required": true, "type": "string", "description": "Unique name of the network device" }, { "name": "body", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/NetworkDevice" } } ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/NetworkDevice" }, "headers": {} }, "204": { "description": "No Content", "headers": {} }, "304": { "description": "Not Modified", "headers": {} }, "401": { "description": "Unauthorized", "headers": {} }, "403": { "description": "Forbidden", "headers": {} }, "404": { "description": "Not Found", "headers": {} }, "406": { "description": "Not Acceptable", "headers": {} }, "415": { "description": "Unsupported Media Type", "headers": {} }, "422": { "description": "Unprocessable Entity", "headers": {} } }, "security": [] }, "put": { "description": "Replace a network device by name", "summary": "PUT_for_NetworkDevice_by_name", "operationId": "PUT_for_NetworkDevice_by_name", "deprecated": false, "produces": [ "application/vnd.network.v1+json", "application/hal+json", "application/json" ], "parameters": [{ "name": "name", "in": "path", "required": true, "type": "string", "description": "Unique name of the network device" }, { "name": "body", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/NetworkDevice" } } ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/NetworkDevice" }, "headers": {} }, "204": { "description": "No Content", "headers": {} }, "304": { "description": "Not Modified", "headers": {} }, "401": { "description": "Unauthorized", "headers": {} }, "403": { "description": "Forbidden", "headers": {} }, "404": { "description": "Not Found", "headers": {} }, "406": { "description": "Not Acceptable", "headers": {} }, "415": { "description": "Unsupported Media Type", "headers": {} }, "422": { "description": "Unprocessable Entity", "headers": {} } }, "security": [] }, "delete": { "description": "Delete a network device by name", "summary": "DELETE_for_NetworkDevice_by_name", "operationId": "DELETE_for_NetworkDevice_by_name", "deprecated": false, "produces": [ "application/json" ], "parameters": [{ "name": "name", "in": "path", "required": true, "type": "string", "description": "Unique name of the network device" }], "responses": { "204": { "description": "No Content", "headers": {} }, "401": { "description": "Unauthorized", "headers": {} }, "403": { "description": "Forbidden", "headers": {} }, "404": { "description": "Not Found", "headers": {} }, "406": { "description": "Not Acceptable", "headers": {} }, "415": { "description": "Unsupported Media Type", "headers": {} } }, "security": [] } }, "/network-device-group": { "get": { "description": "Get a list of network device groups", "summary": "GET_for_NetworkDeviceGroup", "operationId": "GET_for_NetworkDeviceGroup", "deprecated": false, "produces": [ "application/vnd.network.v1+json", "application/hal+json", "application/json" ], "parameters": [{ "name": "filter", "in": "query", "required": false, "default": "{}", "type": "string", "description": "JSON filter expression specifying the items to return" }, { "name": "sort", "in": "query", "required": false, "default": "+id", "type": "string", "description": "Sort ordering for returned items" }, { "name": "offset", "in": "query", "required": false, "default": 0, "type": "integer", "format": "int64", "minimum": 0.0, "exclusiveMinimum": false, "description": "Zero based offset to start from" }, { "name": "limit", "in": "query", "required": false, "default": 25, "type": "integer", "format": "int64", "minimum": 1.0, "maximum": 1000.0, "exclusiveMaximum": false, "exclusiveMinimum": false, "description": "Maximum number of items to return (1 – 1000)" }, { "name": "calculate_count", "in": "query", "required": false, "default": false, "type": "boolean", "description": "Whether to calculate the total item count" } ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/NetworkDeviceGroupList" }, "headers": {} }, "401": { "description": "Unauthorized", "headers": {} }, "403": { "description": "Forbidden", "headers": {} }, "406": { "description": "Not Acceptable", "headers": {} }, "415": { "description": "Unsupported Media Type", "headers": {} }, "422": { "description": "Unprocessable Entity", "headers": {} } }, "security": [] }, "post": { "description": "Create a new network device group", "summary": "POST_for_NetworkDeviceGroup", "operationId": "POST_for_NetworkDeviceGroup", "deprecated": false, "produces": [ "application/vnd.network.v1+json", "application/hal+json", "application/json" ], "parameters": [{ "name": "body", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/NetworkDeviceGroup" } }], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/NetworkDeviceGroup" }, "headers": {} }, "201": { "description": "Created", "headers": {} }, "401": { "description": "Unauthorized", "headers": {} }, "403": { "description": "Forbidden", "headers": {} }, "406": { "description": "Not Acceptable", "headers": {} }, "415": { "description": "Unsupported Media Type", "headers": {} }, "422": { "description": "Unprocessable Entity", "headers": {} } }, "security": [] } }, "/network-device-group/{network_device_group_id}": { "get": { "description": "Get a network device group", "summary": "GET_for_NetworkDeviceGroup", "operationId": "GetGET_for_NetworkDeviceGroup", "deprecated": false, "produces": [ "application/vnd.network.v1+json", "application/hal+json", "application/json" ], "parameters": [{ "name": "network_device_group_id", "in": "path", "required": true, "type": "integer", "format": "int32", "minimum": 0.0, "maximum": 1.0, "exclusiveMaximum": false, "exclusiveMinimum": false, "description": "Numeric ID of the network device group" }], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/NetworkDeviceGroup" }, "headers": {} }, "401": { "description": "Unauthorized", "headers": {} }, "403": { "description": "Forbidden", "headers": {} }, "404": { "description": "Not Found", "headers": {} }, "406": { "description": "Not Acceptable", "headers": {} }, "415": { "description": "Unsupported Media Type", "headers": {} } }, "security": [] }, "patch": { "description": "Update some fields of a network device group", "summary": "PATCH_for_NetworkDeviceGroup", "operationId": "PATCH_for_NetworkDeviceGroup", "deprecated": false, "produces": [ "application/vnd.network.v1+json", "application/hal+json", "application/json" ], "parameters": [{ "name": "network_device_group_id", "in": "path", "required": true, "type": "integer", "format": "int32", "minimum": 0.0, "maximum": 1.0, "exclusiveMaximum": false, "exclusiveMinimum": false, "description": "Numeric ID of the network device group" }, { "name": "body", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/NetworkDeviceGroup" } } ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/NetworkDeviceGroup" }, "headers": {} }, "204": { "description": "No Content", "headers": {} }, "304": { "description": "Not Modified", "headers": {} }, "401": { "description": "Unauthorized", "headers": {} }, "403": { "description": "Forbidden", "headers": {} }, "404": { "description": "Not Found", "headers": {} }, "406": { "description": "Not Acceptable", "headers": {} }, "415": { "description": "Unsupported Media Type", "headers": {} }, "422": { "description": "Unprocessable Entity", "headers": {} } }, "security": [] }, "put": { "description": "Replace a network device group", "summary": "PUT_for_NetworkDeviceGroup", "operationId": "PUT_for_NetworkDeviceGroup", "deprecated": false, "produces": [ "application/vnd.network.v1+json", "application/hal+json", "application/json" ], "parameters": [{ "name": "network_device_group_id", "in": "path", "required": true, "type": "integer", "format": "int32", "minimum": 0.0, "maximum": 1.0, "exclusiveMaximum": false, "exclusiveMinimum": false, "description": "Numeric ID of the network device group" }, { "name": "body", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/NetworkDeviceGroup" } } ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/NetworkDeviceGroup" }, "headers": {} }, "204": { "description": "No Content", "headers": {} }, "304": { "description": "Not Modified", "headers": {} }, "401": { "description": "Unauthorized", "headers": {} }, "403": { "description": "Forbidden", "headers": {} }, "404": { "description": "Not Found", "headers": {} }, "406": { "description": "Not Acceptable", "headers": {} }, "415": { "description": "Unsupported Media Type", "headers": {} }, "422": { "description": "Unprocessable Entity", "headers": {} } }, "security": [] }, "delete": { "description": "Delete a network device group", "summary": "DELETE_for_NetworkDeviceGroup", "operationId": "DELETE_for_NetworkDeviceGroup", "deprecated": false, "produces": [ "application/json" ], "parameters": [{ "name": "network_device_group_id", "in": "path", "required": true, "type": "integer", "format": "int32", "minimum": 0.0, "maximum": 1.0, "exclusiveMaximum": false, "exclusiveMinimum": false, "description": "Numeric ID of the network device group" }], "responses": { "204": { "description": "No Content", "headers": {} }, "401": { "description": "Unauthorized", "headers": {} }, "403": { "description": "Forbidden", "headers": {} }, "404": { "description": "Not Found", "headers": {} }, "406": { "description": "Not Acceptable", "headers": {} }, "415": { "description": "Unsupported Media Type", "headers": {} } }, "security": [] } }, "/network-device-group/name/{name}": { "get": { "description": "Get a network device group by name", "summary": "GET_for_NetworkDeviceGroup_by_name", "operationId": "GET_for_NetworkDeviceGroup_by_name", "deprecated": false, "produces": [ "application/vnd.network.v1+json", "application/hal+json", "application/json" ], "parameters": [{ "name": "name", "in": "path", "required": true, "type": "string", "description": "Unique name of the network device group" }], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/NetworkDeviceGroup" }, "headers": {} }, "401": { "description": "Unauthorized", "headers": {} }, "403": { "description": "Forbidden", "headers": {} }, "404": { "description": "Not Found", "headers": {} }, "406": { "description": "Not Acceptable", "headers": {} }, "415": { "description": "Unsupported Media Type", "headers": {} } }, "security": [] }, "patch": { "description": "Update some fields of a network device group by name", "summary": "PATCH_for_NetworkDeviceGroup_by_name", "operationId": "PATCH_for_NetworkDeviceGroup_by_name", "deprecated": false, "produces": [ "application/vnd.network.v1+json", "application/hal+json", "application/json" ], "parameters": [{ "name": "name", "in": "path", "required": true, "type": "string", "description": "Unique name of the network device group" }, { "name": "body", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/NetworkDeviceGroup" } } ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/NetworkDeviceGroup" }, "headers": {} }, "204": { "description": "No Content", "headers": {} }, "304": { "description": "Not Modified", "headers": {} }, "401": { "description": "Unauthorized", "headers": {} }, "403": { "description": "Forbidden", "headers": {} }, "404": { "description": "Not Found", "headers": {} }, "406": { "description": "Not Acceptable", "headers": {} }, "415": { "description": "Unsupported Media Type", "headers": {} }, "422": { "description": "Unprocessable Entity", "headers": {} } }, "security": [] }, "put": { "description": "Replace a network device group by name", "summary": "PUT_for_NetworkDeviceGroup_by_name", "operationId": "PUT_for_NetworkDeviceGroup_by_name", "deprecated": false, "produces": [ "application/vnd.network.v1+json", "application/hal+json", "application/json" ], "parameters": [{ "name": "name", "in": "path", "required": true, "type": "string", "description": "Unique name of the network device group" }, { "name": "body", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/NetworkDeviceGroup" } } ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/NetworkDeviceGroup" }, "headers": {} }, "204": { "description": "No Content", "headers": {} }, "304": { "description": "Not Modified", "headers": {} }, "401": { "description": "Unauthorized", "headers": {} }, "403": { "description": "Forbidden", "headers": {} }, "404": { "description": "Not Found", "headers": {} }, "406": { "description": "Not Acceptable", "headers": {} }, "415": { "description": "Unsupported Media Type", "headers": {} }, "422": { "description": "Unprocessable Entity", "headers": {} } }, "security": [] }, "delete": { "description": "Delete a network device group by name", "summary": "DELETE_for_NetworkDeviceGroup_by_name", "operationId": "DELETE_for_NetworkDeviceGroup_by_name", "deprecated": false, "produces": [ "application/json" ], "parameters": [{ "name": "name", "in": "path", "required": true, "type": "string", "description": "Unique name of the network device group" }], "responses": { "204": { "description": "No Content", "headers": {} }, "401": { "description": "Unauthorized", "headers": {} }, "403": { "description": "Forbidden", "headers": {} }, "404": { "description": "Not Found", "headers": {} }, "406": { "description": "Not Acceptable", "headers": {} }, "415": { "description": "Unsupported Media Type", "headers": {} } }, "security": [] } } }, "securityDefinitions": {}, "definitions": { "Role": { "title": "Role", "type": "object", "properties": { "id": { "description": "Numeric ID of the role", "type": "integer", "format": "int64" }, "name": { "description": "Name of the role", "type": "string" }, "description": { "description": "Description of the role", "type": "string" } } }, "RoleList": { "title": "RoleList", "type": "object", "properties": { "_embedded": { "$ref": "#/definitions/RoleItems" }, "_links": { "$ref": "#/definitions/HalLinks" }, "count": { "description": "Total number of items matching the filter; returned if calculate_count is true", "type": "integer", "format": "int64" } }, "required": [ "_embedded", "_links" ] }, "RoleItems": { "title": "RoleItems", "type": "object", "properties": { "items": { "description": "List of items matching the filter", "type": "array", "items": { "$ref": "#/definitions/Role" } } }, "required": [ "items" ] }, "HalLinks": { "title": "HalLinks", "type": "object", "properties": { "self": { "description": "URL of result", "type": "string" }, "first": { "description": "URL of first page of results", "type": "string" }, "last": { "description": "URL of last page of results", "type": "string" }, "prev": { "description": "URL of previous page of results", "type": "string" }, "next": { "description": "URL of next page of results", "type": "string" } }, "required": [ "self", "first" ] }, "LocalUserPasswordPolicy": { "title": "LocalUserPasswordPolicy", "type": "object", "properties": { "password_minimum_length": { "description": "(Acceptable values are: \"1-128\")", "type": "integer", "default": "1-128", "format": "int32" }, "password_complexity": { "$ref": "#/definitions/PasswordComplexity" }, "password_disallowed_characters": { "description": "Disallowed characters in the password", "type": "string" }, "password_disallowed_words": { "description": "Disallowed words in the password", "type": "string" }, "password_prohibit_user_id": { "description": "May not contain User ID or its characters in reversed order", "type": "boolean" }, "password_prohibit_repeated_chars": { "description": "May not contain repeated character four or more times consecutively", "type": "boolean" }, "password_expiry_days": { "description": "(Acceptable values are: \"0-500\")", "type": "integer", "default": "0-500", "format": "int32" }, "password_remember_history": { "description": "(Acceptable values are: \"1-99\")", "type": "integer", "default": "1-99", "format": "int32" }, "reminder_days": { "description": "(Acceptable values are: \"1-365\")", "type": "integer", "default": "1-365", "format": "int32" }, "reminder_message": { "description": "Reminder message to be displayed", "type": "string" }, "disable_after_days": { "description": "(Acceptable values are: \"1-1000\")", "type": "integer", "default": "1-1000", "format": "int32" }, "disable_after_date": { "$ref": "#/definitions/DisableAfterDate" }, "disable_after_unchanged_days": { "description": "(Acceptable values are: \"1-365\")", "type": "integer", "default": "1-365", "format": "int32" }, "disable_after_failed_attempts": { "description": "(Acceptable values are: \"1-100\")", "type": "integer", "default": "1-100", "format": "int32" }, "reset_failed_attempts_count": { "description": "Reset failed attempts count and enable those users", "type": "boolean" } } }, "DisableAfterDate": { "title": "DisableAfterDate", "description": "Disable after Date Exceeds", "type": "string", "enum": [ "yyyy-mm-dd" ] }, "PasswordComplexity": { "title": "PasswordComplexity", "description": "Complexity Level of the password", "type": "string", "enum": [ "NONE", "CASE", "NUMBER", "ALPHANUMERIC", "CASENUMERIC", "PUNCTUATION", "COMPLEX" ] }, "LocalUser": { "title": "LocalUser", "type": "object", "properties": { "id": { "description": "Numeric ID of the local user", "type": "integer", "format": "int64" }, "user_id": { "description": "Unique user id of the local user", "type": "string" }, "password": { "description": "Password of the local user", "type": "string" }, "username": { "description": "User name of the local user", "type": "string" }, "role_name": { "description": "Role name of the local user", "type": "string" }, "enabled": { "description": "Flag indicating if the account is enabled", "type": "boolean" }, "change_pwd_next_login": { "description": "Flag indicating if the password change is required in next login", "type": "boolean" }, "attributes": { "description": "Additional attributes(key/value pairs) may be stored with the local user account", "type": "object" } } }, "LocalUserList": { "title": "LocalUserList", "type": "object", "properties": { "_embedded": { "$ref": "#/definitions/LocalUserItems" }, "_links": { "$ref": "#/definitions/HalLinks" }, "count": { "description": "Total number of items matching the filter; returned if calculate_count is true", "type": "integer", "format": "int64" } }, "required": [ "_embedded", "_links" ] }, "LocalUserItems": { "title": "LocalUserItems", "type": "object", "properties": { "items": { "description": "List of items matching the filter", "type": "array", "items": { "$ref": "#/definitions/LocalUser" } } }, "required": [ "items" ] }, "Endpoint": { "title": "Endpoint", "type": "object", "properties": { "id": { "description": "Numeric ID of the endpoint", "type": "integer", "format": "int64" }, "mac_address": { "description": "MAC Address of the endpoint", "type": "string" }, "description": { "description": "Description of the endpoint", "type": "string" }, "status": { "$ref": "#/definitions/Status" }, "attributes": { "description": "Additional attributes(key/value pairs) may be stored with the endpoint", "type": "object" } } }, "EndpointList": { "title": "EndpointList", "type": "object", "properties": { "_embedded": { "$ref": "#/definitions/EndpointItems" }, "_links": { "$ref": "#/definitions/HalLinks" }, "count": { "description": "Total number of items matching the filter; returned if calculate_count is true", "type": "integer", "format": "int64" } }, "required": [ "_embedded", "_links" ] }, "EndpointItems": { "title": "EndpointItems", "type": "object", "properties": { "items": { "description": "List of items matching the filter", "type": "array", "items": { "$ref": "#/definitions/Endpoint" } } }, "required": [ "items" ] }, "Status": { "title": "Status", "description": "Status of the endpoint", "type": "string", "enum": [ "Known", "Unknown", "Disabled" ] }, "ProxyTarget": { "title": "ProxyTarget", "type": "object", "properties": { "id": { "description": "Numeric ID of the proxy target", "type": "integer", "format": "int64" }, "name": { "description": "Name of the proxy target", "type": "string" }, "host_name": { "description": "Host name of the proxy target", "type": "string" }, "description": { "description": "Description of the proxy target", "type": "string" }, "authentication_port": { "description": "Authentication port of the proxy target", "type": "integer", "format": "int64" }, "accounting_port": { "description": "Accounting port of the proxy target", "type": "integer", "format": "int64" }, "secret": { "description": "Shared Secret of the proxy target", "type": "string" } } }, "ProxyTargetList": { "title": "ProxyTargetList", "type": "object", "properties": { "_embedded": { "$ref": "#/definitions/ProxyTargetItems" }, "_links": { "$ref": "#/definitions/HalLinks" }, "count": { "description": "Total number of items matching the filter; returned if calculate_count is true", "type": "integer", "format": "int64" } }, "required": [ "_embedded", "_links" ] }, "ProxyTargetItems": { "title": "ProxyTargetItems", "type": "object", "properties": { "items": { "description": "List of items matching the filter", "type": "array", "items": { "$ref": "#/definitions/ProxyTarget" } } }, "required": [ "items" ] }, "NetworkDevice": { "title": "NetworkDevice", "type": "object", "properties": { "id": { "description": "Numeric ID of the network device", "type": "integer", "format": "int64" }, "description": { "description": "Description of the network device", "type": "string" }, "name": { "description": "Name of the network device", "type": "string" }, "ip_address": { "description": "IP or Subnet Address of the network device", "type": "string" }, "radius_secret": { "description": "RADIUS Shared Secret of the network device", "type": "string" }, "tacacs_secret": { "description": "TACACS+ Shared Secret of the network device", "type": "string" }, "vendor_name": { "description": "Vendor Name of the network device", "type": "string" }, "coa_capable": { "description": "Flag indicating if the network device is capable of CoA", "type": "boolean" }, "coa_port": { "description": "CoA port number of the network device", "type": "integer", "format": "int64" }, "radsec_enabled": { "description": "Flag indicating if the network device is radSec enabled", "type": "boolean" }, "snmp_read": { "$ref": "#/definitions/SNMPReadSettings" }, "snmp_write": { "$ref": "#/definitions/SNMPWriteSettings" }, "cli_config": { "$ref": "#/definitions/CLISettings" }, "onConnect_enforcement": { "$ref": "#/definitions/OnConnectEnforcementSettings" }, "attributes": { "description": "Additional attributes(key/value pairs) may be stored with the network device", "type": "object" } } }, "NetworkDeviceList": { "title": "NetworkDeviceList", "type": "object", "properties": { "_embedded": { "$ref": "#/definitions/NetworkDeviceItems" }, "_links": { "$ref": "#/definitions/HalLinks" }, "count": { "description": "Total number of items matching the filter; returned if calculate_count is true", "type": "integer", "format": "int64" } }, "required": [ "_embedded", "_links" ] }, "NetworkDeviceItems": { "title": "NetworkDeviceItems", "type": "object", "properties": { "items": { "description": "List of items matching the filter", "type": "array", "items": { "$ref": "#/definitions/NetworkDevice" } } }, "required": [ "items" ] }, "SNMPReadSettings": { "title": "SNMPReadSettings", "type": "object", "properties": { "force_read": { "description": "Enable to always read information from this device", "type": "boolean" }, "read_arp_info": { "description": "Enable to read ARP table from this device", "type": "boolean" }, "zone_name": { "description": "Policy Manager Zone name to be associated with the network device", "type": "string" }, "snmp_version": { "$ref": "#/definitions/SnmpVersion" }, "community_string": { "description": "Community string of the network device", "type": "string" }, "security_level": { "$ref": "#/definitions/SecurityLevel" }, "user": { "description": "Username of the network device", "type": "string" }, "auth_protocol": { "$ref": "#/definitions/AuthProtocol" }, "auth_key": { "description": "Authentication key of the network device", "type": "string" }, "privacy_protocol": { "$ref": "#/definitions/PrivacyProtocol" }, "privacy_key": { "description": "Privacy key of the network device", "type": "string" } } }, "SNMPWriteSettings": { "title": "SNMPWriteSettings", "type": "object", "properties": { "default_vlan": { "description": "Default VLAN for port when SNMP-enforced session expires", "type": "integer", "format": "int64" }, "snmp_version": { "$ref": "#/definitions/SnmpVersion" }, "community_string": { "description": "Community string of the network device", "type": "string" }, "security_level": { "$ref": "#/definitions/SecurityLevel" }, "user": { "description": "Username of the network device", "type": "string" }, "auth_protocol": { "$ref": "#/definitions/AuthProtocol" }, "auth_key": { "description": "Authentication key of the network device", "type": "string" }, "privacy_protocol": { "$ref": "#/definitions/PrivacyProtocol" }, "privacy_key": { "description": "Privacy key of the network device", "type": "string" } } }, "CLISettings": { "title": "CLISettings", "type": "object", "properties": { "type": { "$ref": "#/definitions/Type" }, "port": { "description": "SSH/Telnet port number of the network device", "type": "integer", "format": "int64" }, "username": { "description": "Username of the network device", "type": "string" }, "password": { "description": "Password of the network device", "type": "string" }, "username_prompt_regex": { "description": "Username prompt regex of the network device", "type": "string" }, "password_prompt_regex": { "description": "Password prompt regex of the network device", "type": "string" }, "command_prompt_regex": { "description": "Command prompt regex of the network device", "type": "string" }, "enable_prompt_regex": { "description": "Enable prompt regex of the network device", "type": "string" }, "enable_password": { "description": "Enable password of the network device", "type": "string" } } }, "OnConnectEnforcementSettings": { "title": "OnConnectEnforcementSettings", "type": "object", "properties": { "enabled": { "description": "Flag indicating if the network device is enabled with OnConnect Enforcement. SNMP read configuration and Policy Manager Zone is a must for this to work.", "type": "boolean" }, "ports": { "description": "Port names used in OnConnect Enforcement in CSV format (e.g. FastEthernet 1/0/10). Use empty string to enable for all ports. Ports determined to be uplink or trunk ports will be ignored.", "type": "string" } } }, "AuthProtocol": { "title": "AuthProtocol", "description": "Authentication protocol of the network device", "type": "string", "enum": [ "MD5", "SHA" ] }, "PrivacyProtocol": { "title": "PrivacyProtocol", "description": "Privacy protocol of the network device", "type": "string", "enum": [ "DES_CBC", "AES_128" ] }, "SecurityLevel": { "title": "SecurityLevel", "description": "Security level of the network device", "type": "string", "enum": [ "NOAUTH_NOPRIV", "AUTH_NOPRIV", "AUTH_PRIV" ] }, "SnmpVersion": { "title": "SnmpVersion", "description": "SNMP version of the network device", "type": "string", "enum": [ "V1", "V2C", "V3" ] }, "Type": { "title": "Type", "description": "Access type of the network device", "type": "string", "enum": [ "SSH", "Telnet" ] }, "NetworkDeviceGroup": { "title": "NetworkDeviceGroup", "type": "object", "properties": { "id": { "description": "Numeric ID of the network device group", "type": "integer", "format": "int64" }, "name": { "description": "Name of the network device group", "type": "string" }, "description": { "description": "Description of the network device group", "type": "string" }, "group_format": { "type": "string" }, "value": { "description": "Network devices in the specified format", "type": "string" } } }, "NetworkDeviceGroupList": { "title": "NetworkDeviceGroupList", "type": "object", "properties": { "_embedded": { "$ref": "#/definitions/NetworkDeviceGroupItems" }, "_links": { "$ref": "#/definitions/HalLinks" }, "count": { "description": "Total number of items matching the filter; returned if calculate_count is true", "type": "integer", "format": "int64" } }, "required": [ "_embedded", "_links" ] }, "NetworkDeviceGroupItems": { "title": "NetworkDeviceGroupItems", "type": "object", "properties": { "items": { "description": "List of items matching the filter", "type": "array", "items": { "$ref": "#/definitions/NetworkDeviceGroup" } } }, "required": [ "items" ] } , "StaticHostList": { "title": "StaticHostList", "type": "object", "properties": { "id": { "description": "Numeric ID of the static host list", "type": "integer", "format": "int64" }, "name": { "description": "Name of the static host list", "type": "string" }, "description": { "description": "Description of the static host list", "type": "string" }, "host_format": { "$ref": "#/definitions/HostFormat" }, "host_type": { "$ref": "#/definitions/HostType" }, "value": { "description": "List of static hosts in the selected format", "type": "string" } } }, "StaticHostListList": { "title": "StaticHostListList", "type": "object", "properties": { "_embedded": { "$ref": "#/definitions/StaticHostListItems" }, "_links": { "$ref": "#/definitions/HalLinks" }, "count": { "description": "Total number of items matching the filter; returned if calculate_count is true", "type": "integer", "format": "int64" } }, "required": [ "_embedded", "_links" ] }, "StaticHostListItems": { "title": "StaticHostListItems", "type": "object", "properties": { "items": { "description": "List of items matching the filter", "type": "array", "items": { "$ref": "#/definitions/StaticHostList" } } }, "required": [ "items" ] }, "HostFormat": { "title": "HostFormat", "description": "Format of the static host list", "type": "string", "enum": [ "subnet", "regex", "list" ] }, "HostType": { "title": "HostType", "description": "Host type of the static host list", "type": "string", "enum": [ "IPAddress", "MACAddress" ] } }, "externalDocs": { "description": "Find out more about ClearPass", "url": "https://developer.arubanetworks.com/aruba-cppm" } }