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