{ "openapi": "3.0.2", "info": { "description": "Cisco Intersight is a management platform delivered as a service with embedded analytics for your Cisco and\n3rd party IT infrastructure. This platform offers an intelligent level of management that enables\nIT organizations to analyze, simplify, and automate their environments in more advanced ways than the prior\ngenerations of tools. Cisco Intersight provides an integrated and intuitive management experience for\nresources in the traditional data center as well as at the edge. With flexible deployment options to address\ncomplex security needs, getting started with Intersight is quick and easy.\nCisco Intersight has deep integration with Cisco UCS and HyperFlex systems allowing for remote deployment,\nconfiguration, and ongoing maintenance. The model-based deployment works for a single system in a remote\nlocation or hundreds of systems in a data center and enables rapid, standardized configuration and deployment.\nIt also streamlines maintaining those systems whether you are working with small or very large configurations.\nThe Intersight OpenAPI document defines the complete set of properties that are returned in the\nHTTP response. From that perspective, a client can expect that no additional properties are returned,\nunless these properties are explicitly defined in the OpenAPI document.\nHowever, when a client uses an older version of the Intersight OpenAPI document, the server may\nsend additional properties because the software is more recent than the client. In that case, the client\nmay receive properties that it does not know about.\nSome generated SDKs perform a strict validation of the HTTP response body against the OpenAPI document.\nThis document was created on 2026-08-07T06:46:04Z.", "version": "1.0.11-20260807064027971", "title": "Cisco Intersight Workflows", "license": { "name": "Apache License, Version 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, "contact": { "name": "Intersight API support", "url": "https://intersight.com/help", "email": "intersight@cisco.com" } }, "externalDocs": { "url": "/apidocs", "description": "Online documentation for the Intersight APIs" }, "servers": [ { "url": "https://{server}", "variables": { "server": { "default": "intersight.com" } }, "description": "The Intersight URL for the cloud-based infrastructure management APIs." } ], "tags": [ { "name": "aaa" }, { "name": "apic" }, { "name": "asset" }, { "name": "catalystsdwan" }, { "name": "connectorpack" }, { "name": "convergedinfra" }, { "name": "dnac" }, { "name": "energy" }, { "name": "feedback" }, { "name": "fmc" }, { "name": "iaas" }, { "name": "iam" }, { "name": "license" }, { "name": "meraki" }, { "name": "meta" }, { "name": "notification" }, { "name": "oauth" }, { "name": "openapi" }, { "name": "oprs" }, { "name": "organization" }, { "name": "resource" }, { "name": "servicenow" }, { "name": "task" }, { "name": "ucsd" }, { "name": "webhook" }, { "name": "workflow" } ], "paths": { "/api/v1/aaa/AuditRecords": { "get": { "tags": [ "aaa" ], "summary": "Read a 'aaa.AuditRecord' resource.", "operationId": "GetAaaAuditRecordList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Monitor audit logs", "PRIVSET.Read-only all audit logs", "PRIVSET.View Audit Logs", "READ.aaa.AuditRecord", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'aaa.AuditRecord' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/aaa.AuditRecord.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/aaa/AuditRecords/{Moid}": { "get": { "tags": [ "aaa" ], "summary": "Read a 'aaa.AuditRecord' resource.", "operationId": "GetAaaAuditRecordByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Monitor audit logs", "PRIVSET.Read-only all audit logs", "PRIVSET.View Audit Logs", "READ.aaa.AuditRecord", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'aaa.AuditRecord' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/aaa.AuditRecord" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetAaaAuditRecordByMoid": { "operationId": "GetAaaAuditRecordByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/aaa/AuditRecords/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/aaa/RetentionConfigs": { "get": { "tags": [ "aaa" ], "summary": "Read a 'aaa.RetentionConfig' resource.", "operationId": "GetAaaRetentionConfigList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure account details", "PRIVSET.Monitor audit logs", "PRIVSET.Read-Only", "PRIVSET.View Audit Logs", "READ.aaa.RetentionConfig", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'aaa.RetentionConfig' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/aaa.RetentionConfig.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/aaa/RetentionConfigs/{Moid}": { "get": { "tags": [ "aaa" ], "summary": "Read a 'aaa.RetentionConfig' resource.", "operationId": "GetAaaRetentionConfigByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure account details", "PRIVSET.Monitor audit logs", "PRIVSET.Read-Only", "PRIVSET.View Audit Logs", "READ.aaa.RetentionConfig", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'aaa.RetentionConfig' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/aaa.RetentionConfig" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetAaaRetentionConfigByMoid": { "operationId": "GetAaaRetentionConfigByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/aaa/RetentionConfigs/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/aaa/RetentionPolicies": { "get": { "tags": [ "aaa" ], "summary": "Read a 'aaa.RetentionPolicy' resource.", "operationId": "GetAaaRetentionPolicyList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure account details", "PRIVSET.Monitor audit logs", "PRIVSET.Read-Only", "PRIVSET.Read-only all audit logs", "PRIVSET.View Audit Logs", "READ.aaa.RetentionPolicy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'aaa.RetentionPolicy' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/aaa.RetentionPolicy.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "aaa" ], "summary": "Create a 'aaa.RetentionPolicy' resource.", "operationId": "CreateAaaRetentionPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.aaa.RetentionPolicy", "PRIVSET.Account Administrator", "PRIVSET.Configure account details", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'aaa.RetentionPolicy' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/aaa.RetentionPolicy" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'aaa.RetentionPolicy' resource was created as requested. The 'aaa.RetentionPolicy' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/aaa.RetentionPolicy" } } }, "links": { "GetAaaRetentionPolicyByMoid": { "operationId": "GetAaaRetentionPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/aaa/RetentionPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/aaa/RetentionPolicies/{Moid}": { "get": { "tags": [ "aaa" ], "summary": "Read a 'aaa.RetentionPolicy' resource.", "operationId": "GetAaaRetentionPolicyByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure account details", "PRIVSET.Monitor audit logs", "PRIVSET.Read-Only", "PRIVSET.Read-only all audit logs", "PRIVSET.View Audit Logs", "READ.aaa.RetentionPolicy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'aaa.RetentionPolicy' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/aaa.RetentionPolicy" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetAaaRetentionPolicyByMoid": { "operationId": "GetAaaRetentionPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/aaa/RetentionPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "aaa" ], "summary": "Update a 'aaa.RetentionPolicy' resource.", "operationId": "UpdateAaaRetentionPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure account details", "ROLE.Account Administrator", "UPDATE.aaa.RetentionPolicy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'aaa.RetentionPolicy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/aaa.RetentionPolicy" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'aaa.RetentionPolicy' resource was modified as requested. The 'aaa.RetentionPolicy' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/aaa.RetentionPolicy" } } }, "links": { "GetAaaRetentionPolicyByMoid": { "operationId": "GetAaaRetentionPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/aaa/RetentionPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "aaa" ], "summary": "Update a 'aaa.RetentionPolicy' resource.", "operationId": "PatchAaaRetentionPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure account details", "ROLE.Account Administrator", "UPDATE.aaa.RetentionPolicy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'aaa.RetentionPolicy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/aaa.RetentionPolicy" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'aaa.RetentionPolicy' resource was patched as requested. The 'aaa.RetentionPolicy' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/aaa.RetentionPolicy" } } }, "links": { "GetAaaRetentionPolicyByMoid": { "operationId": "GetAaaRetentionPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/aaa/RetentionPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/asset/ClaimTokens": { "get": { "tags": [ "asset" ], "summary": "Read a 'asset.ClaimToken' resource.", "operationId": "GetAssetClaimTokenList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Claim Devices", "PRIVSET.Claim targets", "READ.asset.ClaimToken", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'asset.ClaimToken' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/asset.ClaimToken.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "asset" ], "summary": "Create a 'asset.ClaimToken' resource.", "operationId": "CreateAssetClaimToken", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.asset.ClaimToken", "PRIVSET.Account Administrator", "PRIVSET.Claim Devices", "PRIVSET.Claim targets", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'asset.ClaimToken' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/asset.ClaimToken" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'asset.ClaimToken' resource was created as requested. The 'asset.ClaimToken' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/asset.ClaimToken" } } }, "links": { "GetAssetClaimTokenByMoid": { "operationId": "GetAssetClaimTokenByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/asset/ClaimTokens/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/asset/ClaimTokens/{Moid}": { "get": { "tags": [ "asset" ], "summary": "Read a 'asset.ClaimToken' resource.", "operationId": "GetAssetClaimTokenByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Claim Devices", "PRIVSET.Claim targets", "READ.asset.ClaimToken", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'asset.ClaimToken' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/asset.ClaimToken" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetAssetClaimTokenByMoid": { "operationId": "GetAssetClaimTokenByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/asset/ClaimTokens/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "asset" ], "summary": "Delete a 'asset.ClaimToken' resource.", "operationId": "DeleteAssetClaimToken", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.asset.ClaimToken", "PRIVSET.Account Administrator", "PRIVSET.Claim Devices", "PRIVSET.Claim targets", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/asset/ClusterMembers": { "get": { "tags": [ "asset" ], "summary": "Read a 'asset.ClusterMember' resource.", "operationId": "GetAssetClusterMemberList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Read-only UCS domain profiles", "PRIVSET.Read-only targets", "PRIVSET.View Devices", "READ.asset.ClusterMember", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'asset.ClusterMember' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/asset.ClusterMember.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/asset/ClusterMembers/{Moid}": { "get": { "tags": [ "asset" ], "summary": "Read a 'asset.ClusterMember' resource.", "operationId": "GetAssetClusterMemberByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Read-only UCS domain profiles", "PRIVSET.Read-only targets", "PRIVSET.View Devices", "READ.asset.ClusterMember", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'asset.ClusterMember' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/asset.ClusterMember" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetAssetClusterMemberByMoid": { "operationId": "GetAssetClusterMemberByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/asset/ClusterMembers/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/asset/Deployments": { "get": { "tags": [ "asset" ], "summary": "Read a 'asset.Deployment' resource.", "operationId": "GetAssetDeploymentList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.asset.Deployment", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'asset.Deployment' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/asset.Deployment.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/asset/Deployments/{Moid}": { "get": { "tags": [ "asset" ], "summary": "Read a 'asset.Deployment' resource.", "operationId": "GetAssetDeploymentByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.asset.Deployment", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'asset.Deployment' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/asset.Deployment" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetAssetDeploymentByMoid": { "operationId": "GetAssetDeploymentByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/asset/Deployments/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/asset/DeploymentDevices": { "get": { "tags": [ "asset" ], "summary": "Read a 'asset.DeploymentDevice' resource.", "operationId": "GetAssetDeploymentDeviceList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.asset.DeploymentDevice", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'asset.DeploymentDevice' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/asset.DeploymentDevice.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/asset/DeploymentDevices/{Moid}": { "get": { "tags": [ "asset" ], "summary": "Read a 'asset.DeploymentDevice' resource.", "operationId": "GetAssetDeploymentDeviceByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.asset.DeploymentDevice", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'asset.DeploymentDevice' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/asset.DeploymentDevice" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetAssetDeploymentDeviceByMoid": { "operationId": "GetAssetDeploymentDeviceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/asset/DeploymentDevices/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/asset/DeviceClaims": { "post": { "tags": [ "asset" ], "summary": "Create a 'asset.DeviceClaim' resource.", "operationId": "CreateAssetDeviceClaim", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.asset.DeviceClaim", "PRIVSET.Account Administrator", "PRIVSET.Claim Devices", "PRIVSET.Claim targets", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'asset.DeviceClaim' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/asset.DeviceClaim" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'asset.DeviceClaim' resource was created as requested. The 'asset.DeviceClaim' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/asset.DeviceClaim" } } }, "links": { "GetAssetDeviceClaimByMoid": { "operationId": "GetAssetDeviceClaimByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/asset/DeviceClaims/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/asset/DeviceClaims/{Moid}": { "delete": { "tags": [ "asset" ], "summary": "Delete a 'asset.DeviceClaim' resource.", "operationId": "DeleteAssetDeviceClaim", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.asset.DeviceClaim", "PRIVSET.Account Administrator", "PRIVSET.Delete Devices", "PRIVSET.Unclaim targets", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/asset/DeviceConfigurations": { "get": { "tags": [ "asset" ], "summary": "Read a 'asset.DeviceConfiguration' resource.", "operationId": "GetAssetDeviceConfigurationList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "READ.asset.DeviceConfiguration" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'asset.DeviceConfiguration' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/asset.DeviceConfiguration.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/asset/DeviceConfigurations/{Moid}": { "get": { "tags": [ "asset" ], "summary": "Read a 'asset.DeviceConfiguration' resource.", "operationId": "GetAssetDeviceConfigurationByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "READ.asset.DeviceConfiguration" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'asset.DeviceConfiguration' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/asset.DeviceConfiguration" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetAssetDeviceConfigurationByMoid": { "operationId": "GetAssetDeviceConfigurationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/asset/DeviceConfigurations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "asset" ], "summary": "Update a 'asset.DeviceConfiguration' resource.", "operationId": "UpdateAssetDeviceConfiguration", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "UPDATE.asset.DeviceConfiguration" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'asset.DeviceConfiguration' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/asset.DeviceConfiguration" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'asset.DeviceConfiguration' resource was modified as requested. The 'asset.DeviceConfiguration' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/asset.DeviceConfiguration" } } }, "links": { "GetAssetDeviceConfigurationByMoid": { "operationId": "GetAssetDeviceConfigurationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/asset/DeviceConfigurations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "asset" ], "summary": "Update a 'asset.DeviceConfiguration' resource.", "operationId": "PatchAssetDeviceConfiguration", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "UPDATE.asset.DeviceConfiguration" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'asset.DeviceConfiguration' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/asset.DeviceConfiguration" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'asset.DeviceConfiguration' resource was patched as requested. The 'asset.DeviceConfiguration' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/asset.DeviceConfiguration" } } }, "links": { "GetAssetDeviceConfigurationByMoid": { "operationId": "GetAssetDeviceConfigurationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/asset/DeviceConfigurations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/asset/DeviceConnectorManagers": { "get": { "tags": [ "asset" ], "summary": "Read a 'asset.DeviceConnectorManager' resource.", "operationId": "GetAssetDeviceConnectorManagerList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Claim Devices", "PRIVSET.Delete Devices", "PRIVSET.Read-Only", "PRIVSET.View Devices", "READ.asset.DeviceConnectorManager", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'asset.DeviceConnectorManager' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/asset.DeviceConnectorManager.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/asset/DeviceConnectorManagers/{Moid}": { "get": { "tags": [ "asset" ], "summary": "Read a 'asset.DeviceConnectorManager' resource.", "operationId": "GetAssetDeviceConnectorManagerByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Claim Devices", "PRIVSET.Delete Devices", "PRIVSET.Read-Only", "PRIVSET.View Devices", "READ.asset.DeviceConnectorManager", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'asset.DeviceConnectorManager' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/asset.DeviceConnectorManager" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetAssetDeviceConnectorManagerByMoid": { "operationId": "GetAssetDeviceConnectorManagerByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/asset/DeviceConnectorManagers/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/asset/DeviceContractInformations": { "get": { "tags": [ "asset" ], "summary": "Read a 'asset.DeviceContractInformation' resource.", "operationId": "GetAssetDeviceContractInformationList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Read-only Fabric Interconnects", "PRIVSET.Read-only chassis", "PRIVSET.Read-only networking", "PRIVSET.Read-only servers", "PRIVSET.View Devices", "PRIVSET.View Servers", "READ.asset.DeviceContractInformation", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'asset.DeviceContractInformation' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/asset.DeviceContractInformation.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/asset/DeviceContractInformations/{Moid}": { "get": { "tags": [ "asset" ], "summary": "Read a 'asset.DeviceContractInformation' resource.", "operationId": "GetAssetDeviceContractInformationByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Read-only Fabric Interconnects", "PRIVSET.Read-only chassis", "PRIVSET.Read-only networking", "PRIVSET.Read-only servers", "PRIVSET.View Devices", "PRIVSET.View Servers", "READ.asset.DeviceContractInformation", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'asset.DeviceContractInformation' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/asset.DeviceContractInformation" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetAssetDeviceContractInformationByMoid": { "operationId": "GetAssetDeviceContractInformationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/asset/DeviceContractInformations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "asset" ], "summary": "Update a 'asset.DeviceContractInformation' resource.", "operationId": "UpdateAssetDeviceContractInformation", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.asset.DeviceContractInformation" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'asset.DeviceContractInformation' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/asset.DeviceContractInformation" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'asset.DeviceContractInformation' resource was modified as requested. The 'asset.DeviceContractInformation' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/asset.DeviceContractInformation" } } }, "links": { "GetAssetDeviceContractInformationByMoid": { "operationId": "GetAssetDeviceContractInformationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/asset/DeviceContractInformations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "asset" ], "summary": "Update a 'asset.DeviceContractInformation' resource.", "operationId": "PatchAssetDeviceContractInformation", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.asset.DeviceContractInformation" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'asset.DeviceContractInformation' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/asset.DeviceContractInformation" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'asset.DeviceContractInformation' resource was patched as requested. The 'asset.DeviceContractInformation' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/asset.DeviceContractInformation" } } }, "links": { "GetAssetDeviceContractInformationByMoid": { "operationId": "GetAssetDeviceContractInformationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/asset/DeviceContractInformations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/asset/DeviceContractNotifications": { "post": { "tags": [ "asset" ], "summary": "Create a 'asset.DeviceContractNotification' resource.", "operationId": "CreateAssetDeviceContractNotification", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.asset.DeviceContractNotification" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'asset.DeviceContractNotification' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/asset.DeviceContractNotification" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'asset.DeviceContractNotification' resource was created as requested. The 'asset.DeviceContractNotification' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/asset.DeviceContractNotification" } } }, "links": { "GetAssetDeviceContractNotificationByMoid": { "operationId": "GetAssetDeviceContractNotificationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/asset/DeviceContractNotifications/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/asset/DeviceRegistrations": { "get": { "tags": [ "asset" ], "summary": "Read a 'asset.DeviceRegistration' resource.", "operationId": "GetAssetDeviceRegistrationList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Claim Devices", "PRIVSET.Delete Devices", "PRIVSET.Read-Only", "PRIVSET.Read-only resource pools", "PRIVSET.Read-only software repository", "PRIVSET.Read-only targets", "PRIVSET.Read-only tech support bundles", "PRIVSET.View Devices", "PRIVSET.View Servers", "READ.asset.DeviceRegistration", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'asset.DeviceRegistration' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/asset.DeviceRegistration.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/asset/DeviceRegistrations/{Moid}": { "get": { "tags": [ "asset" ], "summary": "Read a 'asset.DeviceRegistration' resource.", "operationId": "GetAssetDeviceRegistrationByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Claim Devices", "PRIVSET.Delete Devices", "PRIVSET.Read-Only", "PRIVSET.Read-only resource pools", "PRIVSET.Read-only software repository", "PRIVSET.Read-only targets", "PRIVSET.Read-only tech support bundles", "PRIVSET.View Devices", "PRIVSET.View Servers", "READ.asset.DeviceRegistration", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'asset.DeviceRegistration' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/asset.DeviceRegistration" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetAssetDeviceRegistrationByMoid": { "operationId": "GetAssetDeviceRegistrationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/asset/DeviceRegistrations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "asset" ], "summary": "Updates the resource representing the device connector. For example, this can be used to annotate the device connector resource with user-specified tags.", "operationId": "UpdateAssetDeviceRegistration", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Claim Devices", "PRIVSET.Claim targets", "ROLE.Account Administrator", "UPDATE.asset.DeviceRegistration" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'asset.DeviceRegistration' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/asset.DeviceRegistration" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'asset.DeviceRegistration' resource was modified as requested. The 'asset.DeviceRegistration' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/asset.DeviceRegistration" } } }, "links": { "GetAssetDeviceRegistrationByMoid": { "operationId": "GetAssetDeviceRegistrationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/asset/DeviceRegistrations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "asset" ], "summary": "Updates the resource representing the device connector. For example, this can be used to annotate the device connector resource with user-specified tags.", "operationId": "PatchAssetDeviceRegistration", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Claim Devices", "PRIVSET.Claim targets", "ROLE.Account Administrator", "UPDATE.asset.DeviceRegistration" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'asset.DeviceRegistration' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/asset.DeviceRegistration" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'asset.DeviceRegistration' resource was patched as requested. The 'asset.DeviceRegistration' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/asset.DeviceRegistration" } } }, "links": { "GetAssetDeviceRegistrationByMoid": { "operationId": "GetAssetDeviceRegistrationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/asset/DeviceRegistrations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/asset/GeoLocations": { "get": { "tags": [ "asset" ], "summary": "Read a 'asset.GeoLocation' resource.", "operationId": "GetAssetGeoLocationList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Global Read Privileges", "PRIVSET.Global System Privileges", "READ.asset.GeoLocation" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'asset.GeoLocation' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/asset.GeoLocation.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "asset" ], "summary": "Create a 'asset.GeoLocation' resource.", "operationId": "CreateAssetGeoLocation", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.asset.GeoLocation", "PRIVSET.Account Administrator", "PRIVSET.Manage Geo Locations", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'asset.GeoLocation' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/asset.GeoLocation" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'asset.GeoLocation' resource was created as requested. The 'asset.GeoLocation' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/asset.GeoLocation" } } }, "links": { "GetAssetGeoLocationByMoid": { "operationId": "GetAssetGeoLocationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/asset/GeoLocations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/asset/GeoLocations/{Moid}": { "get": { "tags": [ "asset" ], "summary": "Read a 'asset.GeoLocation' resource.", "operationId": "GetAssetGeoLocationByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Global Read Privileges", "PRIVSET.Global System Privileges", "READ.asset.GeoLocation" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'asset.GeoLocation' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/asset.GeoLocation" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetAssetGeoLocationByMoid": { "operationId": "GetAssetGeoLocationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/asset/GeoLocations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "asset" ], "summary": "Update a 'asset.GeoLocation' resource.", "operationId": "UpdateAssetGeoLocation", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Geo Locations", "ROLE.Account Administrator", "UPDATE.asset.GeoLocation" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'asset.GeoLocation' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/asset.GeoLocation" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'asset.GeoLocation' resource was modified as requested. The 'asset.GeoLocation' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/asset.GeoLocation" } } }, "links": { "GetAssetGeoLocationByMoid": { "operationId": "GetAssetGeoLocationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/asset/GeoLocations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "asset" ], "summary": "Update a 'asset.GeoLocation' resource.", "operationId": "PatchAssetGeoLocation", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Geo Locations", "ROLE.Account Administrator", "UPDATE.asset.GeoLocation" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'asset.GeoLocation' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/asset.GeoLocation" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'asset.GeoLocation' resource was patched as requested. The 'asset.GeoLocation' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/asset.GeoLocation" } } }, "links": { "GetAssetGeoLocationByMoid": { "operationId": "GetAssetGeoLocationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/asset/GeoLocations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "asset" ], "summary": "Delete a 'asset.GeoLocation' resource.", "operationId": "DeleteAssetGeoLocation", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.asset.GeoLocation", "PRIVSET.Account Administrator", "PRIVSET.Manage Geo Locations", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/asset/PreClaims": { "post": { "tags": [ "asset" ], "summary": "Create a 'asset.PreClaim' resource.", "operationId": "CreateAssetPreClaim", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.asset.PreClaim", "PRIVSET.Account Administrator", "PRIVSET.Claim Devices", "PRIVSET.Complete Claim", "ROLE.Account Administrator", "ROLE.Complete Claim" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'asset.PreClaim' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/asset.PreClaim" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'asset.PreClaim' resource was created as requested. The 'asset.PreClaim' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/asset.PreClaim" } } }, "links": { "GetAssetPreClaimByMoid": { "operationId": "GetAssetPreClaimByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/asset/PreClaims/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/asset/PreClaims/{Moid}": { "post": { "tags": [ "asset" ], "summary": "Update a 'asset.PreClaim' resource.", "operationId": "UpdateAssetPreClaim", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Claim Devices", "PRIVSET.Complete Claim", "ROLE.Account Administrator", "ROLE.Complete Claim", "UPDATE.asset.PreClaim" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'asset.PreClaim' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/asset.PreClaim" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'asset.PreClaim' resource was modified as requested. The 'asset.PreClaim' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/asset.PreClaim" } } }, "links": { "GetAssetPreClaimByMoid": { "operationId": "GetAssetPreClaimByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/asset/PreClaims/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "asset" ], "summary": "Update a 'asset.PreClaim' resource.", "operationId": "PatchAssetPreClaim", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Claim Devices", "PRIVSET.Complete Claim", "ROLE.Account Administrator", "ROLE.Complete Claim", "UPDATE.asset.PreClaim" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'asset.PreClaim' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/asset.PreClaim" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'asset.PreClaim' resource was patched as requested. The 'asset.PreClaim' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/asset.PreClaim" } } }, "links": { "GetAssetPreClaimByMoid": { "operationId": "GetAssetPreClaimByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/asset/PreClaims/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/asset/Subscriptions": { "get": { "tags": [ "asset" ], "summary": "Read a 'asset.Subscription' resource.", "operationId": "GetAssetSubscriptionList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.asset.Subscription", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'asset.Subscription' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/asset.Subscription.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/asset/Subscriptions/{Moid}": { "get": { "tags": [ "asset" ], "summary": "Read a 'asset.Subscription' resource.", "operationId": "GetAssetSubscriptionByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.asset.Subscription", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'asset.Subscription' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/asset.Subscription" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetAssetSubscriptionByMoid": { "operationId": "GetAssetSubscriptionByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/asset/Subscriptions/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/asset/SubscriptionAccounts": { "get": { "tags": [ "asset" ], "summary": "Read a 'asset.SubscriptionAccount' resource.", "operationId": "GetAssetSubscriptionAccountList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.asset.SubscriptionAccount", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'asset.SubscriptionAccount' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/asset.SubscriptionAccount.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/asset/SubscriptionAccounts/{Moid}": { "get": { "tags": [ "asset" ], "summary": "Read a 'asset.SubscriptionAccount' resource.", "operationId": "GetAssetSubscriptionAccountByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.asset.SubscriptionAccount", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'asset.SubscriptionAccount' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/asset.SubscriptionAccount" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetAssetSubscriptionAccountByMoid": { "operationId": "GetAssetSubscriptionAccountByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/asset/SubscriptionAccounts/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/asset/SubscriptionDeviceContractInformations": { "get": { "tags": [ "asset" ], "summary": "Read a 'asset.SubscriptionDeviceContractInformation' resource.", "operationId": "GetAssetSubscriptionDeviceContractInformationList", "deprecated": true, "x-sunset": "2027-03-01", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Devices", "PRIVSET.View Servers", "READ.asset.SubscriptionDeviceContractInformation", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'asset.SubscriptionDeviceContractInformation' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/asset.SubscriptionDeviceContractInformation.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/asset/SubscriptionDeviceContractInformations/{Moid}": { "get": { "tags": [ "asset" ], "summary": "Read a 'asset.SubscriptionDeviceContractInformation' resource.", "operationId": "GetAssetSubscriptionDeviceContractInformationByMoid", "deprecated": true, "x-sunset": "2027-03-01", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Devices", "PRIVSET.View Servers", "READ.asset.SubscriptionDeviceContractInformation", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'asset.SubscriptionDeviceContractInformation' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/asset.SubscriptionDeviceContractInformation" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetAssetSubscriptionDeviceContractInformationByMoid": { "operationId": "GetAssetSubscriptionDeviceContractInformationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/asset/SubscriptionDeviceContractInformations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/asset/Targets": { "get": { "tags": [ "asset" ], "summary": "Read a 'asset.Target' resource.", "operationId": "GetAssetTargetList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Claim Devices", "PRIVSET.Delete Devices", "PRIVSET.Read-Only", "PRIVSET.Read-only targets", "PRIVSET.View Devices", "READ.asset.Target", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'asset.Target' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/asset.Target.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "asset" ], "summary": "Create a 'asset.Target' resource.", "operationId": "CreateAssetTarget", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.asset.Target", "PRIVSET.Account Administrator", "PRIVSET.Claim Devices", "PRIVSET.Claim targets", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'asset.Target' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/asset.Target" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'asset.Target' resource was created as requested. The 'asset.Target' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/asset.Target" } } }, "links": { "GetAssetTargetByMoid": { "operationId": "GetAssetTargetByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/asset/Targets/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/asset/Targets/{Moid}": { "get": { "tags": [ "asset" ], "summary": "Read a 'asset.Target' resource.", "operationId": "GetAssetTargetByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Claim Devices", "PRIVSET.Delete Devices", "PRIVSET.Read-Only", "PRIVSET.Read-only targets", "PRIVSET.View Devices", "READ.asset.Target", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'asset.Target' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/asset.Target" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetAssetTargetByMoid": { "operationId": "GetAssetTargetByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/asset/Targets/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "asset" ], "summary": "Update a 'asset.Target' resource.", "operationId": "UpdateAssetTarget", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Claim Devices", "PRIVSET.Claim targets", "ROLE.Account Administrator", "UPDATE.asset.Target" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'asset.Target' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/asset.Target" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'asset.Target' resource was modified as requested. The 'asset.Target' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/asset.Target" } } }, "links": { "GetAssetTargetByMoid": { "operationId": "GetAssetTargetByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/asset/Targets/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "asset" ], "summary": "Update a 'asset.Target' resource.", "operationId": "PatchAssetTarget", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Claim Devices", "PRIVSET.Claim targets", "ROLE.Account Administrator", "UPDATE.asset.Target" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'asset.Target' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/asset.Target" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'asset.Target' resource was patched as requested. The 'asset.Target' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/asset.Target" } } }, "links": { "GetAssetTargetByMoid": { "operationId": "GetAssetTargetByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/asset/Targets/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "asset" ], "summary": "Delete a 'asset.Target' resource.", "operationId": "DeleteAssetTarget", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.asset.Target", "PRIVSET.Account Administrator", "PRIVSET.Delete Devices", "PRIVSET.Unclaim targets", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/catalystsdwan/ConfigGroups": { "get": { "tags": [ "catalystsdwan" ], "x-intersight-type": "SaaS", "summary": "Read a 'catalystsdwan.ConfigGroup' resource.", "operationId": "GetCatalystsdwanConfigGroupList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.catalystsdwan.ConfigGroup", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'catalystsdwan.ConfigGroup' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/catalystsdwan.ConfigGroup.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/catalystsdwan/ConfigGroups/{Moid}": { "get": { "tags": [ "catalystsdwan" ], "x-intersight-type": "SaaS", "summary": "Read a 'catalystsdwan.ConfigGroup' resource.", "operationId": "GetCatalystsdwanConfigGroupByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.catalystsdwan.ConfigGroup", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'catalystsdwan.ConfigGroup' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/catalystsdwan.ConfigGroup" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetCatalystsdwanConfigGroupByMoid": { "operationId": "GetCatalystsdwanConfigGroupByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/catalystsdwan/ConfigGroups/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/catalystsdwan/Interfaces": { "get": { "tags": [ "catalystsdwan" ], "x-intersight-type": "SaaS", "summary": "Read a 'catalystsdwan.Interface' resource.", "operationId": "GetCatalystsdwanInterfaceList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Network Administrator", "PRIVSET.Read-Only", "PRIVSET.View Fabric Interconnects", "PRIVSET.View Unified Edge", "READ.catalystsdwan.Interface", "ROLE.Account Administrator", "ROLE.Network Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'catalystsdwan.Interface' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/catalystsdwan.Interface.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/catalystsdwan/Interfaces/{Moid}": { "get": { "tags": [ "catalystsdwan" ], "x-intersight-type": "SaaS", "summary": "Read a 'catalystsdwan.Interface' resource.", "operationId": "GetCatalystsdwanInterfaceByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Network Administrator", "PRIVSET.Read-Only", "PRIVSET.View Fabric Interconnects", "PRIVSET.View Unified Edge", "READ.catalystsdwan.Interface", "ROLE.Account Administrator", "ROLE.Network Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'catalystsdwan.Interface' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/catalystsdwan.Interface" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetCatalystsdwanInterfaceByMoid": { "operationId": "GetCatalystsdwanInterfaceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/catalystsdwan/Interfaces/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/catalystsdwan/PhysicalPorts": { "get": { "tags": [ "catalystsdwan" ], "x-intersight-type": "SaaS", "summary": "Read a 'catalystsdwan.PhysicalPort' resource.", "operationId": "GetCatalystsdwanPhysicalPortList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Network Administrator", "PRIVSET.Read-Only", "PRIVSET.View Fabric Interconnects", "PRIVSET.View Unified Edge", "READ.catalystsdwan.PhysicalPort", "ROLE.Account Administrator", "ROLE.Network Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'catalystsdwan.PhysicalPort' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/catalystsdwan.PhysicalPort.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/catalystsdwan/PhysicalPorts/{Moid}": { "get": { "tags": [ "catalystsdwan" ], "x-intersight-type": "SaaS", "summary": "Read a 'catalystsdwan.PhysicalPort' resource.", "operationId": "GetCatalystsdwanPhysicalPortByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Network Administrator", "PRIVSET.Read-Only", "PRIVSET.View Fabric Interconnects", "PRIVSET.View Unified Edge", "READ.catalystsdwan.PhysicalPort", "ROLE.Account Administrator", "ROLE.Network Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'catalystsdwan.PhysicalPort' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/catalystsdwan.PhysicalPort" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetCatalystsdwanPhysicalPortByMoid": { "operationId": "GetCatalystsdwanPhysicalPortByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/catalystsdwan/PhysicalPorts/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/catalystsdwan/PolicyGroups": { "get": { "tags": [ "catalystsdwan" ], "x-intersight-type": "SaaS", "summary": "Read a 'catalystsdwan.PolicyGroup' resource.", "operationId": "GetCatalystsdwanPolicyGroupList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.catalystsdwan.PolicyGroup", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'catalystsdwan.PolicyGroup' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/catalystsdwan.PolicyGroup.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/catalystsdwan/PolicyGroups/{Moid}": { "get": { "tags": [ "catalystsdwan" ], "x-intersight-type": "SaaS", "summary": "Read a 'catalystsdwan.PolicyGroup' resource.", "operationId": "GetCatalystsdwanPolicyGroupByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.catalystsdwan.PolicyGroup", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'catalystsdwan.PolicyGroup' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/catalystsdwan.PolicyGroup" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetCatalystsdwanPolicyGroupByMoid": { "operationId": "GetCatalystsdwanPolicyGroupByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/catalystsdwan/PolicyGroups/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/catalystsdwan/PortChannels": { "get": { "tags": [ "catalystsdwan" ], "x-intersight-type": "SaaS", "summary": "Read a 'catalystsdwan.PortChannel' resource.", "operationId": "GetCatalystsdwanPortChannelList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Network Administrator", "PRIVSET.Read-Only", "PRIVSET.View Fabric Interconnects", "PRIVSET.View Unified Edge", "READ.catalystsdwan.PortChannel", "ROLE.Account Administrator", "ROLE.Network Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'catalystsdwan.PortChannel' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/catalystsdwan.PortChannel.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/catalystsdwan/PortChannels/{Moid}": { "get": { "tags": [ "catalystsdwan" ], "x-intersight-type": "SaaS", "summary": "Read a 'catalystsdwan.PortChannel' resource.", "operationId": "GetCatalystsdwanPortChannelByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Network Administrator", "PRIVSET.Read-Only", "PRIVSET.View Fabric Interconnects", "PRIVSET.View Unified Edge", "READ.catalystsdwan.PortChannel", "ROLE.Account Administrator", "ROLE.Network Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'catalystsdwan.PortChannel' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/catalystsdwan.PortChannel" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetCatalystsdwanPortChannelByMoid": { "operationId": "GetCatalystsdwanPortChannelByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/catalystsdwan/PortChannels/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/catalystsdwan/VedgeDevices": { "get": { "tags": [ "catalystsdwan" ], "x-intersight-type": "SaaS", "summary": "Read a 'catalystsdwan.VedgeDevice' resource.", "operationId": "GetCatalystsdwanVedgeDeviceList", "deprecated": true, "x-sunset": "2027-05-31", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.catalystsdwan.VedgeDevice", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'catalystsdwan.VedgeDevice' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/catalystsdwan.VedgeDevice.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/catalystsdwan/VedgeDevices/{Moid}": { "get": { "tags": [ "catalystsdwan" ], "x-intersight-type": "SaaS", "summary": "Read a 'catalystsdwan.VedgeDevice' resource.", "operationId": "GetCatalystsdwanVedgeDeviceByMoid", "deprecated": true, "x-sunset": "2027-05-31", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.catalystsdwan.VedgeDevice", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'catalystsdwan.VedgeDevice' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/catalystsdwan.VedgeDevice" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetCatalystsdwanVedgeDeviceByMoid": { "operationId": "GetCatalystsdwanVedgeDeviceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/catalystsdwan/VedgeDevices/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/catalystsdwan/Vlans": { "get": { "tags": [ "catalystsdwan" ], "x-intersight-type": "SaaS", "summary": "Read a 'catalystsdwan.Vlan' resource.", "operationId": "GetCatalystsdwanVlanList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Network Administrator", "PRIVSET.Read-Only", "PRIVSET.View Fabric Interconnects", "PRIVSET.View Unified Edge", "READ.catalystsdwan.Vlan", "ROLE.Account Administrator", "ROLE.Network Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'catalystsdwan.Vlan' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/catalystsdwan.Vlan.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/catalystsdwan/Vlans/{Moid}": { "get": { "tags": [ "catalystsdwan" ], "x-intersight-type": "SaaS", "summary": "Read a 'catalystsdwan.Vlan' resource.", "operationId": "GetCatalystsdwanVlanByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Network Administrator", "PRIVSET.Read-Only", "PRIVSET.View Fabric Interconnects", "PRIVSET.View Unified Edge", "READ.catalystsdwan.Vlan", "ROLE.Account Administrator", "ROLE.Network Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'catalystsdwan.Vlan' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/catalystsdwan.Vlan" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetCatalystsdwanVlanByMoid": { "operationId": "GetCatalystsdwanVlanByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/catalystsdwan/Vlans/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/catalystsdwan/WanEdgeDevices": { "get": { "tags": [ "catalystsdwan" ], "x-intersight-type": "SaaS", "summary": "Read a 'catalystsdwan.WanEdgeDevice' resource.", "operationId": "GetCatalystsdwanWanEdgeDeviceList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Network Administrator", "PRIVSET.Read-Only", "PRIVSET.View Fabric Interconnects", "PRIVSET.View Unified Edge", "READ.catalystsdwan.WanEdgeDevice", "ROLE.Account Administrator", "ROLE.Network Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'catalystsdwan.WanEdgeDevice' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/catalystsdwan.WanEdgeDevice.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/catalystsdwan/WanEdgeDevices/{Moid}": { "get": { "tags": [ "catalystsdwan" ], "x-intersight-type": "SaaS", "summary": "Read a 'catalystsdwan.WanEdgeDevice' resource.", "operationId": "GetCatalystsdwanWanEdgeDeviceByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Network Administrator", "PRIVSET.Read-Only", "PRIVSET.View Fabric Interconnects", "PRIVSET.View Unified Edge", "READ.catalystsdwan.WanEdgeDevice", "ROLE.Account Administrator", "ROLE.Network Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'catalystsdwan.WanEdgeDevice' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/catalystsdwan.WanEdgeDevice" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetCatalystsdwanWanEdgeDeviceByMoid": { "operationId": "GetCatalystsdwanWanEdgeDeviceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/catalystsdwan/WanEdgeDevices/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/connectorpack/ConnectorPackUpgrades": { "get": { "tags": [ "connectorpack" ], "summary": "Read a 'connectorpack.ConnectorPackUpgrade' resource.", "operationId": "GetConnectorpackConnectorPackUpgradeList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.connectorpack.ConnectorPackUpgrade", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'connectorpack.ConnectorPackUpgrade' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/connectorpack.ConnectorPackUpgrade.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "connectorpack" ], "summary": "Create a 'connectorpack.ConnectorPackUpgrade' resource.", "operationId": "CreateConnectorpackConnectorPackUpgrade", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.connectorpack.ConnectorPackUpgrade", "PRIVSET.Account Administrator", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'connectorpack.ConnectorPackUpgrade' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/connectorpack.ConnectorPackUpgrade" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'connectorpack.ConnectorPackUpgrade' resource was created as requested. The 'connectorpack.ConnectorPackUpgrade' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/connectorpack.ConnectorPackUpgrade" } } }, "links": { "GetConnectorpackConnectorPackUpgradeByMoid": { "operationId": "GetConnectorpackConnectorPackUpgradeByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/connectorpack/ConnectorPackUpgrades/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/connectorpack/ConnectorPackUpgrades/{Moid}": { "get": { "tags": [ "connectorpack" ], "summary": "Read a 'connectorpack.ConnectorPackUpgrade' resource.", "operationId": "GetConnectorpackConnectorPackUpgradeByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.connectorpack.ConnectorPackUpgrade", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'connectorpack.ConnectorPackUpgrade' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/connectorpack.ConnectorPackUpgrade" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetConnectorpackConnectorPackUpgradeByMoid": { "operationId": "GetConnectorpackConnectorPackUpgradeByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/connectorpack/ConnectorPackUpgrades/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "connectorpack" ], "summary": "Delete a 'connectorpack.ConnectorPackUpgrade' resource.", "operationId": "DeleteConnectorpackConnectorPackUpgrade", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.connectorpack.ConnectorPackUpgrade", "PRIVSET.Account Administrator", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/connectorpack/UpgradeImpacts": { "get": { "tags": [ "connectorpack" ], "summary": "Read a 'connectorpack.UpgradeImpact' resource.", "operationId": "GetConnectorpackUpgradeImpactList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.connectorpack.UpgradeImpact", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'connectorpack.UpgradeImpact' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/connectorpack.UpgradeImpact.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/connectorpack/UpgradeImpacts/{Moid}": { "get": { "tags": [ "connectorpack" ], "summary": "Read a 'connectorpack.UpgradeImpact' resource.", "operationId": "GetConnectorpackUpgradeImpactByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.connectorpack.UpgradeImpact", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'connectorpack.UpgradeImpact' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/connectorpack.UpgradeImpact" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetConnectorpackUpgradeImpactByMoid": { "operationId": "GetConnectorpackUpgradeImpactByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/connectorpack/UpgradeImpacts/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/convergedinfra/AdapterComplianceDetails": { "get": { "tags": [ "convergedinfra" ], "summary": "Read a 'convergedinfra.AdapterComplianceDetails' resource.", "operationId": "GetConvergedinfraAdapterComplianceDetailsList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Integrated Systems Administrator", "PRIVSET.Integrated Systems Operator", "PRIVSET.Read-Only", "PRIVSET.Read-only integrated systems", "READ.convergedinfra.AdapterComplianceDetails", "ROLE.Account Administrator", "ROLE.Integrated Systems Administrator", "ROLE.Integrated Systems Operator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'convergedinfra.AdapterComplianceDetails' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/convergedinfra.AdapterComplianceDetails.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/convergedinfra/AdapterComplianceDetails/{Moid}": { "get": { "tags": [ "convergedinfra" ], "summary": "Read a 'convergedinfra.AdapterComplianceDetails' resource.", "operationId": "GetConvergedinfraAdapterComplianceDetailsByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Integrated Systems Administrator", "PRIVSET.Integrated Systems Operator", "PRIVSET.Read-Only", "PRIVSET.Read-only integrated systems", "READ.convergedinfra.AdapterComplianceDetails", "ROLE.Account Administrator", "ROLE.Integrated Systems Administrator", "ROLE.Integrated Systems Operator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'convergedinfra.AdapterComplianceDetails' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/convergedinfra.AdapterComplianceDetails" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetConvergedinfraAdapterComplianceDetailsByMoid": { "operationId": "GetConvergedinfraAdapterComplianceDetailsByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/convergedinfra/AdapterComplianceDetails/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/convergedinfra/Pods": { "get": { "tags": [ "convergedinfra" ], "summary": "Read a 'convergedinfra.Pod' resource.", "operationId": "GetConvergedinfraPodList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Integrated Systems Administrator", "PRIVSET.Integrated Systems Operator", "PRIVSET.Read-Only", "PRIVSET.Read-only integrated systems", "READ.convergedinfra.Pod", "ROLE.Account Administrator", "ROLE.Integrated Systems Administrator", "ROLE.Integrated Systems Operator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'convergedinfra.Pod' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/convergedinfra.Pod.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/convergedinfra/Pods/{Moid}": { "get": { "tags": [ "convergedinfra" ], "summary": "Read a 'convergedinfra.Pod' resource.", "operationId": "GetConvergedinfraPodByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Integrated Systems Administrator", "PRIVSET.Integrated Systems Operator", "PRIVSET.Read-Only", "PRIVSET.Read-only integrated systems", "READ.convergedinfra.Pod", "ROLE.Account Administrator", "ROLE.Integrated Systems Administrator", "ROLE.Integrated Systems Operator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'convergedinfra.Pod' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/convergedinfra.Pod" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetConvergedinfraPodByMoid": { "operationId": "GetConvergedinfraPodByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/convergedinfra/Pods/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "convergedinfra" ], "summary": "Update a 'convergedinfra.Pod' resource.", "operationId": "UpdateConvergedinfraPod", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Integrated Systems Administrator", "PRIVSET.Read-Only", "ROLE.Account Administrator", "ROLE.Integrated Systems Administrator", "ROLE.Read-Only", "UPDATE.convergedinfra.Pod" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'convergedinfra.Pod' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/convergedinfra.Pod" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'convergedinfra.Pod' resource was modified as requested. The 'convergedinfra.Pod' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/convergedinfra.Pod" } } }, "links": { "GetConvergedinfraPodByMoid": { "operationId": "GetConvergedinfraPodByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/convergedinfra/Pods/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "convergedinfra" ], "summary": "Update a 'convergedinfra.Pod' resource.", "operationId": "PatchConvergedinfraPod", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Integrated Systems Administrator", "PRIVSET.Read-Only", "ROLE.Account Administrator", "ROLE.Integrated Systems Administrator", "ROLE.Read-Only", "UPDATE.convergedinfra.Pod" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'convergedinfra.Pod' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/convergedinfra.Pod" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'convergedinfra.Pod' resource was patched as requested. The 'convergedinfra.Pod' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/convergedinfra.Pod" } } }, "links": { "GetConvergedinfraPodByMoid": { "operationId": "GetConvergedinfraPodByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/convergedinfra/Pods/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/convergedinfra/PodComplianceInfos": { "get": { "tags": [ "convergedinfra" ], "summary": "Read a 'convergedinfra.PodComplianceInfo' resource.", "operationId": "GetConvergedinfraPodComplianceInfoList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Integrated Systems Administrator", "PRIVSET.Integrated Systems Operator", "PRIVSET.Read-Only", "PRIVSET.Read-only integrated systems", "READ.convergedinfra.PodComplianceInfo", "ROLE.Account Administrator", "ROLE.Integrated Systems Administrator", "ROLE.Integrated Systems Operator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'convergedinfra.PodComplianceInfo' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/convergedinfra.PodComplianceInfo.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/convergedinfra/PodComplianceInfos/{Moid}": { "get": { "tags": [ "convergedinfra" ], "summary": "Read a 'convergedinfra.PodComplianceInfo' resource.", "operationId": "GetConvergedinfraPodComplianceInfoByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Integrated Systems Administrator", "PRIVSET.Integrated Systems Operator", "PRIVSET.Read-Only", "PRIVSET.Read-only integrated systems", "READ.convergedinfra.PodComplianceInfo", "ROLE.Account Administrator", "ROLE.Integrated Systems Administrator", "ROLE.Integrated Systems Operator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'convergedinfra.PodComplianceInfo' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/convergedinfra.PodComplianceInfo" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetConvergedinfraPodComplianceInfoByMoid": { "operationId": "GetConvergedinfraPodComplianceInfoByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/convergedinfra/PodComplianceInfos/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/convergedinfra/ServerComplianceDetails": { "get": { "tags": [ "convergedinfra" ], "summary": "Read a 'convergedinfra.ServerComplianceDetails' resource.", "operationId": "GetConvergedinfraServerComplianceDetailsList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Integrated Systems Administrator", "PRIVSET.Integrated Systems Operator", "PRIVSET.Read-Only", "PRIVSET.Read-only integrated systems", "READ.convergedinfra.ServerComplianceDetails", "ROLE.Account Administrator", "ROLE.Integrated Systems Administrator", "ROLE.Integrated Systems Operator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'convergedinfra.ServerComplianceDetails' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/convergedinfra.ServerComplianceDetails.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/convergedinfra/ServerComplianceDetails/{Moid}": { "get": { "tags": [ "convergedinfra" ], "summary": "Read a 'convergedinfra.ServerComplianceDetails' resource.", "operationId": "GetConvergedinfraServerComplianceDetailsByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Integrated Systems Administrator", "PRIVSET.Integrated Systems Operator", "PRIVSET.Read-Only", "PRIVSET.Read-only integrated systems", "READ.convergedinfra.ServerComplianceDetails", "ROLE.Account Administrator", "ROLE.Integrated Systems Administrator", "ROLE.Integrated Systems Operator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'convergedinfra.ServerComplianceDetails' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/convergedinfra.ServerComplianceDetails" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetConvergedinfraServerComplianceDetailsByMoid": { "operationId": "GetConvergedinfraServerComplianceDetailsByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/convergedinfra/ServerComplianceDetails/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/convergedinfra/StorageComplianceDetails": { "get": { "tags": [ "convergedinfra" ], "summary": "Read a 'convergedinfra.StorageComplianceDetails' resource.", "operationId": "GetConvergedinfraStorageComplianceDetailsList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Integrated Systems Administrator", "PRIVSET.Integrated Systems Operator", "PRIVSET.Read-Only", "PRIVSET.Read-only integrated systems", "READ.convergedinfra.StorageComplianceDetails", "ROLE.Account Administrator", "ROLE.Integrated Systems Administrator", "ROLE.Integrated Systems Operator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'convergedinfra.StorageComplianceDetails' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/convergedinfra.StorageComplianceDetails.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/convergedinfra/StorageComplianceDetails/{Moid}": { "get": { "tags": [ "convergedinfra" ], "summary": "Read a 'convergedinfra.StorageComplianceDetails' resource.", "operationId": "GetConvergedinfraStorageComplianceDetailsByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Integrated Systems Administrator", "PRIVSET.Integrated Systems Operator", "PRIVSET.Read-Only", "PRIVSET.Read-only integrated systems", "READ.convergedinfra.StorageComplianceDetails", "ROLE.Account Administrator", "ROLE.Integrated Systems Administrator", "ROLE.Integrated Systems Operator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'convergedinfra.StorageComplianceDetails' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/convergedinfra.StorageComplianceDetails" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetConvergedinfraStorageComplianceDetailsByMoid": { "operationId": "GetConvergedinfraStorageComplianceDetailsByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/convergedinfra/StorageComplianceDetails/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/convergedinfra/SwitchComplianceDetails": { "get": { "tags": [ "convergedinfra" ], "summary": "Read a 'convergedinfra.SwitchComplianceDetails' resource.", "operationId": "GetConvergedinfraSwitchComplianceDetailsList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Integrated Systems Administrator", "PRIVSET.Integrated Systems Operator", "PRIVSET.Read-Only", "PRIVSET.Read-only integrated systems", "READ.convergedinfra.SwitchComplianceDetails", "ROLE.Account Administrator", "ROLE.Integrated Systems Administrator", "ROLE.Integrated Systems Operator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'convergedinfra.SwitchComplianceDetails' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/convergedinfra.SwitchComplianceDetails.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/convergedinfra/SwitchComplianceDetails/{Moid}": { "get": { "tags": [ "convergedinfra" ], "summary": "Read a 'convergedinfra.SwitchComplianceDetails' resource.", "operationId": "GetConvergedinfraSwitchComplianceDetailsByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Integrated Systems Administrator", "PRIVSET.Integrated Systems Operator", "PRIVSET.Read-Only", "PRIVSET.Read-only integrated systems", "READ.convergedinfra.SwitchComplianceDetails", "ROLE.Account Administrator", "ROLE.Integrated Systems Administrator", "ROLE.Integrated Systems Operator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'convergedinfra.SwitchComplianceDetails' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/convergedinfra.SwitchComplianceDetails" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetConvergedinfraSwitchComplianceDetailsByMoid": { "operationId": "GetConvergedinfraSwitchComplianceDetailsByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/convergedinfra/SwitchComplianceDetails/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/dnac/Devices": { "get": { "tags": [ "dnac" ], "x-intersight-type": "SaaS", "summary": "Read a 'dnac.Device' resource.", "operationId": "GetDnacDeviceList", "deprecated": true, "x-sunset": "2026-12-20", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.dnac.Device", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'dnac.Device' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dnac.Device.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/dnac/Devices/{Moid}": { "get": { "tags": [ "dnac" ], "x-intersight-type": "SaaS", "summary": "Read a 'dnac.Device' resource.", "operationId": "GetDnacDeviceByMoid", "deprecated": true, "x-sunset": "2026-12-20", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.dnac.Device", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'dnac.Device' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dnac.Device" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetDnacDeviceByMoid": { "operationId": "GetDnacDeviceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/dnac/Devices/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/dnac/DeviceInterfaces": { "get": { "tags": [ "dnac" ], "x-intersight-type": "SaaS", "summary": "Read a 'dnac.DeviceInterface' resource.", "operationId": "GetDnacDeviceInterfaceList", "deprecated": true, "x-sunset": "2026-12-20", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.dnac.DeviceInterface", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'dnac.DeviceInterface' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dnac.DeviceInterface.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/dnac/DeviceInterfaces/{Moid}": { "get": { "tags": [ "dnac" ], "x-intersight-type": "SaaS", "summary": "Read a 'dnac.DeviceInterface' resource.", "operationId": "GetDnacDeviceInterfaceByMoid", "deprecated": true, "x-sunset": "2026-12-20", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.dnac.DeviceInterface", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'dnac.DeviceInterface' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dnac.DeviceInterface" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetDnacDeviceInterfaceByMoid": { "operationId": "GetDnacDeviceInterfaceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/dnac/DeviceInterfaces/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/dnac/ExternalBorderNodes": { "get": { "tags": [ "dnac" ], "x-intersight-type": "SaaS", "summary": "Read a 'dnac.ExternalBorderNode' resource.", "operationId": "GetDnacExternalBorderNodeList", "deprecated": true, "x-sunset": "2026-12-20", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.dnac.ExternalBorderNode", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'dnac.ExternalBorderNode' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dnac.ExternalBorderNode.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/dnac/ExternalBorderNodes/{Moid}": { "get": { "tags": [ "dnac" ], "x-intersight-type": "SaaS", "summary": "Read a 'dnac.ExternalBorderNode' resource.", "operationId": "GetDnacExternalBorderNodeByMoid", "deprecated": true, "x-sunset": "2026-12-20", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.dnac.ExternalBorderNode", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'dnac.ExternalBorderNode' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dnac.ExternalBorderNode" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetDnacExternalBorderNodeByMoid": { "operationId": "GetDnacExternalBorderNodeByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/dnac/ExternalBorderNodes/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/dnac/ExternalBorderNodeInterfaces": { "get": { "tags": [ "dnac" ], "x-intersight-type": "SaaS", "summary": "Read a 'dnac.ExternalBorderNodeInterface' resource.", "operationId": "GetDnacExternalBorderNodeInterfaceList", "deprecated": true, "x-sunset": "2026-12-20", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.dnac.ExternalBorderNodeInterface", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'dnac.ExternalBorderNodeInterface' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dnac.ExternalBorderNodeInterface.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/dnac/ExternalBorderNodeInterfaces/{Moid}": { "get": { "tags": [ "dnac" ], "x-intersight-type": "SaaS", "summary": "Read a 'dnac.ExternalBorderNodeInterface' resource.", "operationId": "GetDnacExternalBorderNodeInterfaceByMoid", "deprecated": true, "x-sunset": "2026-12-20", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.dnac.ExternalBorderNodeInterface", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'dnac.ExternalBorderNodeInterface' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dnac.ExternalBorderNodeInterface" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetDnacExternalBorderNodeInterfaceByMoid": { "operationId": "GetDnacExternalBorderNodeInterfaceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/dnac/ExternalBorderNodeInterfaces/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/dnac/FabricSites": { "get": { "tags": [ "dnac" ], "x-intersight-type": "SaaS", "summary": "Read a 'dnac.FabricSite' resource.", "operationId": "GetDnacFabricSiteList", "deprecated": true, "x-sunset": "2026-12-20", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.dnac.FabricSite", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'dnac.FabricSite' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dnac.FabricSite.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/dnac/FabricSites/{Moid}": { "get": { "tags": [ "dnac" ], "x-intersight-type": "SaaS", "summary": "Read a 'dnac.FabricSite' resource.", "operationId": "GetDnacFabricSiteByMoid", "deprecated": true, "x-sunset": "2026-12-20", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.dnac.FabricSite", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'dnac.FabricSite' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dnac.FabricSite" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetDnacFabricSiteByMoid": { "operationId": "GetDnacFabricSiteByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/dnac/FabricSites/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/dnac/Sites": { "get": { "tags": [ "dnac" ], "x-intersight-type": "SaaS", "summary": "Read a 'dnac.Site' resource.", "operationId": "GetDnacSiteList", "deprecated": true, "x-sunset": "2026-12-20", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.dnac.Site", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'dnac.Site' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dnac.Site.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/dnac/Sites/{Moid}": { "get": { "tags": [ "dnac" ], "x-intersight-type": "SaaS", "summary": "Read a 'dnac.Site' resource.", "operationId": "GetDnacSiteByMoid", "deprecated": true, "x-sunset": "2026-12-20", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.dnac.Site", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'dnac.Site' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dnac.Site" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetDnacSiteByMoid": { "operationId": "GetDnacSiteByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/dnac/Sites/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/dnac/SiteIpPools": { "get": { "tags": [ "dnac" ], "x-intersight-type": "SaaS", "summary": "Read a 'dnac.SiteIpPool' resource.", "operationId": "GetDnacSiteIpPoolList", "deprecated": true, "x-sunset": "2026-12-20", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.dnac.SiteIpPool", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'dnac.SiteIpPool' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dnac.SiteIpPool.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/dnac/SiteIpPools/{Moid}": { "get": { "tags": [ "dnac" ], "x-intersight-type": "SaaS", "summary": "Read a 'dnac.SiteIpPool' resource.", "operationId": "GetDnacSiteIpPoolByMoid", "deprecated": true, "x-sunset": "2026-12-20", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.dnac.SiteIpPool", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'dnac.SiteIpPool' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dnac.SiteIpPool" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetDnacSiteIpPoolByMoid": { "operationId": "GetDnacSiteIpPoolByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/dnac/SiteIpPools/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/dnac/Templates": { "get": { "tags": [ "dnac" ], "x-intersight-type": "SaaS", "summary": "Read a 'dnac.Template' resource.", "operationId": "GetDnacTemplateList", "deprecated": true, "x-sunset": "2026-12-20", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.dnac.Template", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'dnac.Template' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dnac.Template.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/dnac/Templates/{Moid}": { "get": { "tags": [ "dnac" ], "x-intersight-type": "SaaS", "summary": "Read a 'dnac.Template' resource.", "operationId": "GetDnacTemplateByMoid", "deprecated": true, "x-sunset": "2026-12-20", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.dnac.Template", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'dnac.Template' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dnac.Template" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetDnacTemplateByMoid": { "operationId": "GetDnacTemplateByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/dnac/Templates/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/dnac/Transits": { "get": { "tags": [ "dnac" ], "x-intersight-type": "SaaS", "summary": "Read a 'dnac.Transit' resource.", "operationId": "GetDnacTransitList", "deprecated": true, "x-sunset": "2026-12-20", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.dnac.Transit", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'dnac.Transit' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dnac.Transit.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/dnac/Transits/{Moid}": { "get": { "tags": [ "dnac" ], "x-intersight-type": "SaaS", "summary": "Read a 'dnac.Transit' resource.", "operationId": "GetDnacTransitByMoid", "deprecated": true, "x-sunset": "2026-12-20", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.dnac.Transit", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'dnac.Transit' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dnac.Transit" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetDnacTransitByMoid": { "operationId": "GetDnacTransitByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/dnac/Transits/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/dnac/VirtualNetworkFabricSites": { "get": { "tags": [ "dnac" ], "x-intersight-type": "SaaS", "summary": "Read a 'dnac.VirtualNetworkFabricSite' resource.", "operationId": "GetDnacVirtualNetworkFabricSiteList", "deprecated": true, "x-sunset": "2026-12-20", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.dnac.VirtualNetworkFabricSite", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'dnac.VirtualNetworkFabricSite' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dnac.VirtualNetworkFabricSite.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/dnac/VirtualNetworkFabricSites/{Moid}": { "get": { "tags": [ "dnac" ], "x-intersight-type": "SaaS", "summary": "Read a 'dnac.VirtualNetworkFabricSite' resource.", "operationId": "GetDnacVirtualNetworkFabricSiteByMoid", "deprecated": true, "x-sunset": "2026-12-20", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.dnac.VirtualNetworkFabricSite", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'dnac.VirtualNetworkFabricSite' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dnac.VirtualNetworkFabricSite" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetDnacVirtualNetworkFabricSiteByMoid": { "operationId": "GetDnacVirtualNetworkFabricSiteByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/dnac/VirtualNetworkFabricSites/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/energy/DailyMetrics": { "post": { "tags": [ "energy" ], "x-intersight-type": "SaaS", "summary": "Create a 'energy.DailyMetrics' resource.", "operationId": "CreateEnergyDailyMetrics", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.energy.DailyMetrics", "PRIVSET.Account Administrator", "PRIVSET.Sustainability Metrics Viewer", "ROLE.Account Administrator", "ROLE.Sustainability Metrics Viewer" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'energy.DailyMetrics' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/energy.DailyMetrics" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'energy.DailyMetrics' resource was created as requested. The 'energy.DailyMetrics' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/energy.DailyMetrics" } } }, "links": { "GetEnergyDailyMetricsByMoid": { "operationId": "GetEnergyDailyMetricsByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/energy/DailyMetrics/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/energy/Metrics": { "post": { "tags": [ "energy" ], "x-intersight-type": "SaaS", "summary": "Create a 'energy.Metrics' resource.", "operationId": "CreateEnergyMetrics", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.energy.Metrics", "PRIVSET.Account Administrator", "PRIVSET.Sustainability Metrics Viewer", "ROLE.Account Administrator", "ROLE.Sustainability Metrics Viewer" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'energy.Metrics' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/energy.Metrics" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'energy.Metrics' resource was created as requested. The 'energy.Metrics' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/energy.Metrics" } } }, "links": { "GetEnergyMetricsByMoid": { "operationId": "GetEnergyMetricsByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/energy/Metrics/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/feedback/FeedbackPosts": { "post": { "tags": [ "feedback" ], "summary": "Create a 'feedback.FeedbackPost' resource.", "operationId": "CreateFeedbackFeedbackPost", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.feedback.FeedbackPost", "PRIVSET.Global System Privileges", "PRIVSET.Global Write Privileges" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'feedback.FeedbackPost' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/feedback.FeedbackPost" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'feedback.FeedbackPost' resource was created as requested. The 'feedback.FeedbackPost' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/feedback.FeedbackPost" } } }, "links": { "GetFeedbackFeedbackPostByMoid": { "operationId": "GetFeedbackFeedbackPostByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/feedback/FeedbackPosts/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/feedback/FeedbackPosts/{Moid}": { "post": { "tags": [ "feedback" ], "summary": "Update a 'feedback.FeedbackPost' resource.", "operationId": "UpdateFeedbackFeedbackPost", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Global System Privileges", "PRIVSET.Global Write Privileges", "UPDATE.feedback.FeedbackPost" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'feedback.FeedbackPost' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/feedback.FeedbackPost" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'feedback.FeedbackPost' resource was modified as requested. The 'feedback.FeedbackPost' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/feedback.FeedbackPost" } } }, "links": { "GetFeedbackFeedbackPostByMoid": { "operationId": "GetFeedbackFeedbackPostByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/feedback/FeedbackPosts/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "feedback" ], "summary": "Update a 'feedback.FeedbackPost' resource.", "operationId": "PatchFeedbackFeedbackPost", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Global System Privileges", "PRIVSET.Global Write Privileges", "UPDATE.feedback.FeedbackPost" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'feedback.FeedbackPost' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/feedback.FeedbackPost" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'feedback.FeedbackPost' resource was patched as requested. The 'feedback.FeedbackPost' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/feedback.FeedbackPost" } } }, "links": { "GetFeedbackFeedbackPostByMoid": { "operationId": "GetFeedbackFeedbackPostByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/feedback/FeedbackPosts/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/fmc/Devices": { "get": { "tags": [ "fmc" ], "x-intersight-type": "SaaS", "summary": "Read a 'fmc.Device' resource.", "operationId": "GetFmcDeviceList", "deprecated": true, "x-sunset": "2026-12-19", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.fmc.Device", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'fmc.Device' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/fmc.Device.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/fmc/Devices/{Moid}": { "get": { "tags": [ "fmc" ], "x-intersight-type": "SaaS", "summary": "Read a 'fmc.Device' resource.", "operationId": "GetFmcDeviceByMoid", "deprecated": true, "x-sunset": "2026-12-19", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.fmc.Device", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'fmc.Device' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/fmc.Device" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetFmcDeviceByMoid": { "operationId": "GetFmcDeviceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fmc/Devices/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/fmc/DeviceHaPairs": { "get": { "tags": [ "fmc" ], "x-intersight-type": "SaaS", "summary": "Read a 'fmc.DeviceHaPair' resource.", "operationId": "GetFmcDeviceHaPairList", "deprecated": true, "x-sunset": "2026-12-19", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.fmc.DeviceHaPair", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'fmc.DeviceHaPair' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/fmc.DeviceHaPair.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/fmc/DeviceHaPairs/{Moid}": { "get": { "tags": [ "fmc" ], "x-intersight-type": "SaaS", "summary": "Read a 'fmc.DeviceHaPair' resource.", "operationId": "GetFmcDeviceHaPairByMoid", "deprecated": true, "x-sunset": "2026-12-19", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.fmc.DeviceHaPair", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'fmc.DeviceHaPair' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/fmc.DeviceHaPair" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetFmcDeviceHaPairByMoid": { "operationId": "GetFmcDeviceHaPairByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fmc/DeviceHaPairs/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/fmc/Domains": { "get": { "tags": [ "fmc" ], "x-intersight-type": "SaaS", "summary": "Read a 'fmc.Domain' resource.", "operationId": "GetFmcDomainList", "deprecated": true, "x-sunset": "2026-12-19", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.fmc.Domain", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'fmc.Domain' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/fmc.Domain.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/fmc/Domains/{Moid}": { "get": { "tags": [ "fmc" ], "x-intersight-type": "SaaS", "summary": "Read a 'fmc.Domain' resource.", "operationId": "GetFmcDomainByMoid", "deprecated": true, "x-sunset": "2026-12-19", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.fmc.Domain", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'fmc.Domain' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/fmc.Domain" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetFmcDomainByMoid": { "operationId": "GetFmcDomainByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fmc/Domains/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/fmc/PhysicalInterfaces": { "get": { "tags": [ "fmc" ], "x-intersight-type": "SaaS", "summary": "Read a 'fmc.PhysicalInterface' resource.", "operationId": "GetFmcPhysicalInterfaceList", "deprecated": true, "x-sunset": "2026-12-19", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.fmc.PhysicalInterface", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'fmc.PhysicalInterface' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/fmc.PhysicalInterface.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/fmc/PhysicalInterfaces/{Moid}": { "get": { "tags": [ "fmc" ], "x-intersight-type": "SaaS", "summary": "Read a 'fmc.PhysicalInterface' resource.", "operationId": "GetFmcPhysicalInterfaceByMoid", "deprecated": true, "x-sunset": "2026-12-19", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.fmc.PhysicalInterface", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'fmc.PhysicalInterface' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/fmc.PhysicalInterface" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetFmcPhysicalInterfaceByMoid": { "operationId": "GetFmcPhysicalInterfaceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fmc/PhysicalInterfaces/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iaas/ConnectorPacks": { "get": { "tags": [ "iaas" ], "summary": "Read a 'iaas.ConnectorPack' resource.", "operationId": "GetIaasConnectorPackList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "READ.iaas.ConnectorPack" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iaas.ConnectorPack' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iaas.ConnectorPack.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iaas/ConnectorPacks/{Moid}": { "get": { "tags": [ "iaas" ], "summary": "Read a 'iaas.ConnectorPack' resource.", "operationId": "GetIaasConnectorPackByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "READ.iaas.ConnectorPack" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iaas.ConnectorPack' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iaas.ConnectorPack" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetIaasConnectorPackByMoid": { "operationId": "GetIaasConnectorPackByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iaas/ConnectorPacks/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iaas/CustomTaskInfos": { "get": { "tags": [ "iaas" ], "summary": "Read a 'iaas.CustomTaskInfo' resource.", "operationId": "GetIaasCustomTaskInfoList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "READ.iaas.CustomTaskInfo" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iaas.CustomTaskInfo' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iaas.CustomTaskInfo.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iaas/CustomTaskInfos/{Moid}": { "get": { "tags": [ "iaas" ], "summary": "Read a 'iaas.CustomTaskInfo' resource.", "operationId": "GetIaasCustomTaskInfoByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "READ.iaas.CustomTaskInfo" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iaas.CustomTaskInfo' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iaas.CustomTaskInfo" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetIaasCustomTaskInfoByMoid": { "operationId": "GetIaasCustomTaskInfoByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iaas/CustomTaskInfos/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iaas/DeviceStatuses": { "get": { "tags": [ "iaas" ], "summary": "Read a 'iaas.DeviceStatus' resource.", "operationId": "GetIaasDeviceStatusList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "READ.iaas.DeviceStatus" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iaas.DeviceStatus' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iaas.DeviceStatus.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iaas/DeviceStatuses/{Moid}": { "get": { "tags": [ "iaas" ], "summary": "Read a 'iaas.DeviceStatus' resource.", "operationId": "GetIaasDeviceStatusByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "READ.iaas.DeviceStatus" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iaas.DeviceStatus' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iaas.DeviceStatus" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetIaasDeviceStatusByMoid": { "operationId": "GetIaasDeviceStatusByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iaas/DeviceStatuses/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iaas/DiagnosticMessages": { "get": { "tags": [ "iaas" ], "summary": "Read a 'iaas.DiagnosticMessages' resource.", "operationId": "GetIaasDiagnosticMessagesList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "READ.iaas.DiagnosticMessages" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iaas.DiagnosticMessages' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iaas.DiagnosticMessages.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iaas/DiagnosticMessages/{Moid}": { "get": { "tags": [ "iaas" ], "summary": "Read a 'iaas.DiagnosticMessages' resource.", "operationId": "GetIaasDiagnosticMessagesByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "READ.iaas.DiagnosticMessages" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iaas.DiagnosticMessages' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iaas.DiagnosticMessages" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetIaasDiagnosticMessagesByMoid": { "operationId": "GetIaasDiagnosticMessagesByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iaas/DiagnosticMessages/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iaas/LicenseInfos": { "get": { "tags": [ "iaas" ], "summary": "Read a 'iaas.LicenseInfo' resource.", "operationId": "GetIaasLicenseInfoList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "READ.iaas.LicenseInfo" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iaas.LicenseInfo' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iaas.LicenseInfo.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iaas/LicenseInfos/{Moid}": { "get": { "tags": [ "iaas" ], "summary": "Read a 'iaas.LicenseInfo' resource.", "operationId": "GetIaasLicenseInfoByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "READ.iaas.LicenseInfo" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iaas.LicenseInfo' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iaas.LicenseInfo" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetIaasLicenseInfoByMoid": { "operationId": "GetIaasLicenseInfoByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iaas/LicenseInfos/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iaas/MostRunTasks": { "get": { "tags": [ "iaas" ], "summary": "Read a 'iaas.MostRunTasks' resource.", "operationId": "GetIaasMostRunTasksList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "READ.iaas.MostRunTasks" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iaas.MostRunTasks' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iaas.MostRunTasks.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iaas/MostRunTasks/{Moid}": { "get": { "tags": [ "iaas" ], "summary": "Read a 'iaas.MostRunTasks' resource.", "operationId": "GetIaasMostRunTasksByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "READ.iaas.MostRunTasks" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iaas.MostRunTasks' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iaas.MostRunTasks" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetIaasMostRunTasksByMoid": { "operationId": "GetIaasMostRunTasksByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iaas/MostRunTasks/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iaas/ServiceRequests": { "get": { "tags": [ "iaas" ], "summary": "Read a 'iaas.ServiceRequest' resource.", "operationId": "GetIaasServiceRequestList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "READ.iaas.ServiceRequest" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iaas.ServiceRequest' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iaas.ServiceRequest.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iaas/ServiceRequests/{Moid}": { "get": { "tags": [ "iaas" ], "summary": "Read a 'iaas.ServiceRequest' resource.", "operationId": "GetIaasServiceRequestByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "READ.iaas.ServiceRequest" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iaas.ServiceRequest' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iaas.ServiceRequest" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetIaasServiceRequestByMoid": { "operationId": "GetIaasServiceRequestByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iaas/ServiceRequests/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iaas/SystemTaskInfos": { "get": { "tags": [ "iaas" ], "summary": "Read a 'iaas.SystemTaskInfo' resource.", "operationId": "GetIaasSystemTaskInfoList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "READ.iaas.SystemTaskInfo" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iaas.SystemTaskInfo' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iaas.SystemTaskInfo.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iaas/SystemTaskInfos/{Moid}": { "get": { "tags": [ "iaas" ], "summary": "Read a 'iaas.SystemTaskInfo' resource.", "operationId": "GetIaasSystemTaskInfoByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "READ.iaas.SystemTaskInfo" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iaas.SystemTaskInfo' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iaas.SystemTaskInfo" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetIaasSystemTaskInfoByMoid": { "operationId": "GetIaasSystemTaskInfoByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iaas/SystemTaskInfos/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iaas/UcsdInfos": { "get": { "tags": [ "iaas" ], "summary": "Read a 'iaas.UcsdInfo' resource.", "operationId": "GetIaasUcsdInfoList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.iaas.UcsdInfo", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iaas.UcsdInfo' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iaas.UcsdInfo.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iaas/UcsdInfos/{Moid}": { "get": { "tags": [ "iaas" ], "summary": "Read a 'iaas.UcsdInfo' resource.", "operationId": "GetIaasUcsdInfoByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.iaas.UcsdInfo", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iaas.UcsdInfo' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iaas.UcsdInfo" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetIaasUcsdInfoByMoid": { "operationId": "GetIaasUcsdInfoByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iaas/UcsdInfos/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "iaas" ], "summary": "Update a 'iaas.UcsdInfo' resource.", "operationId": "UpdateIaasUcsdInfo", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.iaas.UcsdInfo" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iaas.UcsdInfo' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iaas.UcsdInfo" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iaas.UcsdInfo' resource was modified as requested. The 'iaas.UcsdInfo' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iaas.UcsdInfo" } } }, "links": { "GetIaasUcsdInfoByMoid": { "operationId": "GetIaasUcsdInfoByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iaas/UcsdInfos/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "iaas" ], "summary": "Update a 'iaas.UcsdInfo' resource.", "operationId": "PatchIaasUcsdInfo", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.iaas.UcsdInfo" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iaas.UcsdInfo' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iaas.UcsdInfo" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iaas.UcsdInfo' resource was patched as requested. The 'iaas.UcsdInfo' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iaas.UcsdInfo" } } }, "links": { "GetIaasUcsdInfoByMoid": { "operationId": "GetIaasUcsdInfoByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iaas/UcsdInfos/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iaas/UcsdManagedInfras": { "get": { "tags": [ "iaas" ], "summary": "Read a 'iaas.UcsdManagedInfra' resource.", "operationId": "GetIaasUcsdManagedInfraList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "READ.iaas.UcsdManagedInfra" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iaas.UcsdManagedInfra' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iaas.UcsdManagedInfra.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iaas/UcsdManagedInfras/{Moid}": { "get": { "tags": [ "iaas" ], "summary": "Read a 'iaas.UcsdManagedInfra' resource.", "operationId": "GetIaasUcsdManagedInfraByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "READ.iaas.UcsdManagedInfra" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iaas.UcsdManagedInfra' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iaas.UcsdManagedInfra" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetIaasUcsdManagedInfraByMoid": { "operationId": "GetIaasUcsdManagedInfraByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iaas/UcsdManagedInfras/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iaas/UcsdMessages": { "get": { "tags": [ "iaas" ], "summary": "Read a 'iaas.UcsdMessages' resource.", "operationId": "GetIaasUcsdMessagesList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "READ.iaas.UcsdMessages" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iaas.UcsdMessages' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iaas.UcsdMessages.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iaas/UcsdMessages/{Moid}": { "get": { "tags": [ "iaas" ], "summary": "Read a 'iaas.UcsdMessages' resource.", "operationId": "GetIaasUcsdMessagesByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "READ.iaas.UcsdMessages" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iaas.UcsdMessages' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iaas.UcsdMessages" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetIaasUcsdMessagesByMoid": { "operationId": "GetIaasUcsdMessagesByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iaas/UcsdMessages/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/Accounts": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.Account' resource.", "operationId": "GetIamAccountList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Global Read Privileges", "PRIVSET.Global System Privileges", "READ.iam.Account" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iam.Account' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.Account.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "iam" ], "summary": "Create a 'iam.Account' resource.", "operationId": "CreateIamAccount", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.iam.Account" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'iam.Account' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.Account" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.Account' resource was created as requested. The 'iam.Account' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.Account" } } }, "links": { "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/Accounts/{Moid}": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.Account' resource.", "operationId": "GetIamAccountByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Global Read Privileges", "PRIVSET.Global System Privileges", "READ.iam.Account" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iam.Account' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.Account" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "iam" ], "summary": "Update a 'iam.Account' resource.", "operationId": "UpdateIamAccount", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure account details", "ROLE.Account Administrator", "UPDATE.iam.Account" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.Account' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.Account" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.Account' resource was modified as requested. The 'iam.Account' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.Account" } } }, "links": { "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "iam" ], "summary": "Update a 'iam.Account' resource.", "operationId": "PatchIamAccount", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure account details", "ROLE.Account Administrator", "UPDATE.iam.Account" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.Account' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.Account" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.Account' resource was patched as requested. The 'iam.Account' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.Account" } } }, "links": { "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "iam" ], "summary": "Delete a 'iam.Account' resource.", "operationId": "DeleteIamAccount", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.iam.Account" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/AccountExperiences": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.AccountExperience' resource.", "operationId": "GetIamAccountExperienceList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Global System Privileges", "READ.iam.AccountExperience" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iam.AccountExperience' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.AccountExperience.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/AccountExperiences/{Moid}": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.AccountExperience' resource.", "operationId": "GetIamAccountExperienceByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Global System Privileges", "READ.iam.AccountExperience" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iam.AccountExperience' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.AccountExperience" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetIamAccountExperienceByMoid": { "operationId": "GetIamAccountExperienceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/AccountExperiences/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/ApiKeys": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.ApiKey' resource.", "operationId": "GetIamApiKeyList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Delete API keys", "PRIVSET.Edit API keys", "PRIVSET.Enable and disable API keys", "PRIVSET.Generate API keys", "PRIVSET.Manage API Keys", "PRIVSET.Read all API keys in the account", "PRIVSET.Read-Only", "PRIVSET.Workload Optimizer Administrator", "PRIVSET.Workload Optimizer Advisor", "PRIVSET.Workload Optimizer Automator", "PRIVSET.Workload Optimizer Deployer", "PRIVSET.Workload Optimizer Observer", "READ.iam.ApiKey", "ROLE.Account Administrator", "ROLE.Read-Only", "ROLE.Workload Optimizer Administrator", "ROLE.Workload Optimizer Advisor", "ROLE.Workload Optimizer Automator", "ROLE.Workload Optimizer Deployer", "ROLE.Workload Optimizer Observer" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iam.ApiKey' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.ApiKey.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "iam" ], "summary": "Create a 'iam.ApiKey' resource.", "operationId": "CreateIamApiKey", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.iam.ApiKey", "PRIVSET.Account Administrator", "PRIVSET.Generate API keys", "PRIVSET.Manage API Keys", "PRIVSET.Read-Only", "PRIVSET.Workload Optimizer Administrator", "PRIVSET.Workload Optimizer Advisor", "PRIVSET.Workload Optimizer Automator", "PRIVSET.Workload Optimizer Deployer", "PRIVSET.Workload Optimizer Observer", "ROLE.Account Administrator", "ROLE.Read-Only", "ROLE.Workload Optimizer Administrator", "ROLE.Workload Optimizer Advisor", "ROLE.Workload Optimizer Automator", "ROLE.Workload Optimizer Deployer", "ROLE.Workload Optimizer Observer" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'iam.ApiKey' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.ApiKey" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.ApiKey' resource was created as requested. The 'iam.ApiKey' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.ApiKey" } } }, "links": { "GetIamApiKeyByMoid": { "operationId": "GetIamApiKeyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/ApiKeys/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/ApiKeys/{Moid}": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.ApiKey' resource.", "operationId": "GetIamApiKeyByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Delete API keys", "PRIVSET.Edit API keys", "PRIVSET.Enable and disable API keys", "PRIVSET.Generate API keys", "PRIVSET.Manage API Keys", "PRIVSET.Read all API keys in the account", "PRIVSET.Read-Only", "PRIVSET.Workload Optimizer Administrator", "PRIVSET.Workload Optimizer Advisor", "PRIVSET.Workload Optimizer Automator", "PRIVSET.Workload Optimizer Deployer", "PRIVSET.Workload Optimizer Observer", "READ.iam.ApiKey", "ROLE.Account Administrator", "ROLE.Read-Only", "ROLE.Workload Optimizer Administrator", "ROLE.Workload Optimizer Advisor", "ROLE.Workload Optimizer Automator", "ROLE.Workload Optimizer Deployer", "ROLE.Workload Optimizer Observer" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iam.ApiKey' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.ApiKey" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetIamApiKeyByMoid": { "operationId": "GetIamApiKeyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/ApiKeys/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "iam" ], "summary": "Delete a 'iam.ApiKey' resource.", "operationId": "DeleteIamApiKey", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.iam.ApiKey", "PRIVSET.Account Administrator", "PRIVSET.Delete API keys", "PRIVSET.Manage API Keys", "PRIVSET.Read-Only", "PRIVSET.Workload Optimizer Administrator", "PRIVSET.Workload Optimizer Advisor", "PRIVSET.Workload Optimizer Automator", "PRIVSET.Workload Optimizer Deployer", "PRIVSET.Workload Optimizer Observer", "ROLE.Account Administrator", "ROLE.Read-Only", "ROLE.Workload Optimizer Administrator", "ROLE.Workload Optimizer Advisor", "ROLE.Workload Optimizer Automator", "ROLE.Workload Optimizer Deployer", "ROLE.Workload Optimizer Observer" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "iam" ], "summary": "Update a 'iam.ApiKey' resource.", "operationId": "UpdateIamApiKey", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit API keys", "PRIVSET.Manage API Keys", "PRIVSET.Read-Only", "PRIVSET.Workload Optimizer Administrator", "PRIVSET.Workload Optimizer Advisor", "PRIVSET.Workload Optimizer Automator", "PRIVSET.Workload Optimizer Deployer", "PRIVSET.Workload Optimizer Observer", "ROLE.Account Administrator", "ROLE.Read-Only", "ROLE.Workload Optimizer Administrator", "ROLE.Workload Optimizer Advisor", "ROLE.Workload Optimizer Automator", "ROLE.Workload Optimizer Deployer", "ROLE.Workload Optimizer Observer", "UPDATE.iam.ApiKey" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.ApiKey' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.ApiKey" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.ApiKey' resource was modified as requested. The 'iam.ApiKey' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.ApiKey" } } }, "links": { "GetIamApiKeyByMoid": { "operationId": "GetIamApiKeyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/ApiKeys/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "iam" ], "summary": "Update a 'iam.ApiKey' resource.", "operationId": "PatchIamApiKey", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit API keys", "PRIVSET.Manage API Keys", "PRIVSET.Read-Only", "PRIVSET.Workload Optimizer Administrator", "PRIVSET.Workload Optimizer Advisor", "PRIVSET.Workload Optimizer Automator", "PRIVSET.Workload Optimizer Deployer", "PRIVSET.Workload Optimizer Observer", "ROLE.Account Administrator", "ROLE.Read-Only", "ROLE.Workload Optimizer Administrator", "ROLE.Workload Optimizer Advisor", "ROLE.Workload Optimizer Automator", "ROLE.Workload Optimizer Deployer", "ROLE.Workload Optimizer Observer", "UPDATE.iam.ApiKey" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.ApiKey' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.ApiKey" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.ApiKey' resource was patched as requested. The 'iam.ApiKey' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.ApiKey" } } }, "links": { "GetIamApiKeyByMoid": { "operationId": "GetIamApiKeyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/ApiKeys/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/AppRegistrations": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.AppRegistration' resource.", "operationId": "GetIamAppRegistrationList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Create OAuth 2.0 grant type applications", "PRIVSET.Delete OAuth 2.0 grant type applications", "PRIVSET.Edit OAuth 2.0 grant type applications", "PRIVSET.Enable and disable OAuth 2.0 grant type applications", "PRIVSET.Global System Privileges", "PRIVSET.Read all OAuth apps in the account", "READ.iam.AppRegistration" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iam.AppRegistration' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.AppRegistration.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "iam" ], "summary": "Create a 'iam.AppRegistration' resource.", "operationId": "CreateIamAppRegistration", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.iam.AppRegistration", "PRIVSET.Create OAuth 2.0 grant type applications", "PRIVSET.Global System Privileges" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'iam.AppRegistration' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.AppRegistration" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.AppRegistration' resource was created as requested. The 'iam.AppRegistration' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.AppRegistration" } } }, "links": { "GetIamAppRegistrationByMoid": { "operationId": "GetIamAppRegistrationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/AppRegistrations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/AppRegistrations/{Moid}": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.AppRegistration' resource.", "operationId": "GetIamAppRegistrationByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Create OAuth 2.0 grant type applications", "PRIVSET.Delete OAuth 2.0 grant type applications", "PRIVSET.Edit OAuth 2.0 grant type applications", "PRIVSET.Enable and disable OAuth 2.0 grant type applications", "PRIVSET.Global System Privileges", "PRIVSET.Read all OAuth apps in the account", "READ.iam.AppRegistration" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iam.AppRegistration' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.AppRegistration" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetIamAppRegistrationByMoid": { "operationId": "GetIamAppRegistrationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/AppRegistrations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "iam" ], "summary": "Delete a 'iam.AppRegistration' resource.", "operationId": "DeleteIamAppRegistration", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.iam.AppRegistration", "PRIVSET.Delete OAuth 2.0 grant type applications", "PRIVSET.Global System Privileges" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "iam" ], "summary": "Update a 'iam.AppRegistration' resource.", "operationId": "UpdateIamAppRegistration", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Edit OAuth 2.0 grant type applications", "PRIVSET.Global System Privileges", "UPDATE.iam.AppRegistration" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.AppRegistration' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.AppRegistration" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.AppRegistration' resource was modified as requested. The 'iam.AppRegistration' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.AppRegistration" } } }, "links": { "GetIamAppRegistrationByMoid": { "operationId": "GetIamAppRegistrationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/AppRegistrations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "iam" ], "summary": "Update a 'iam.AppRegistration' resource.", "operationId": "PatchIamAppRegistration", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Edit OAuth 2.0 grant type applications", "PRIVSET.Global System Privileges", "UPDATE.iam.AppRegistration" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.AppRegistration' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.AppRegistration" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.AppRegistration' resource was patched as requested. The 'iam.AppRegistration' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.AppRegistration" } } }, "links": { "GetIamAppRegistrationByMoid": { "operationId": "GetIamAppRegistrationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/AppRegistrations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/BannerMessages": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.BannerMessage' resource.", "operationId": "GetIamBannerMessageList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure banner message", "READ.iam.BannerMessage", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iam.BannerMessage' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.BannerMessage.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/BannerMessages/{Moid}": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.BannerMessage' resource.", "operationId": "GetIamBannerMessageByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure banner message", "READ.iam.BannerMessage", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iam.BannerMessage' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.BannerMessage" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetIamBannerMessageByMoid": { "operationId": "GetIamBannerMessageByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/BannerMessages/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "iam" ], "summary": "Update a 'iam.BannerMessage' resource.", "operationId": "UpdateIamBannerMessage", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure banner message", "ROLE.Account Administrator", "UPDATE.iam.BannerMessage" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.BannerMessage' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.BannerMessage" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.BannerMessage' resource was modified as requested. The 'iam.BannerMessage' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.BannerMessage" } } }, "links": { "GetIamBannerMessageByMoid": { "operationId": "GetIamBannerMessageByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/BannerMessages/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "iam" ], "summary": "Update a 'iam.BannerMessage' resource.", "operationId": "PatchIamBannerMessage", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure banner message", "ROLE.Account Administrator", "UPDATE.iam.BannerMessage" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.BannerMessage' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.BannerMessage" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.BannerMessage' resource was patched as requested. The 'iam.BannerMessage' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.BannerMessage" } } }, "links": { "GetIamBannerMessageByMoid": { "operationId": "GetIamBannerMessageByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/BannerMessages/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/Certificates": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.Certificate' resource.", "operationId": "GetIamCertificateList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-only SSL Certificates", "READ.iam.Certificate", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iam.Certificate' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.Certificate.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "iam" ], "summary": "Create a 'iam.Certificate' resource.", "operationId": "CreateIamCertificate", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.iam.Certificate", "PRIVSET.Account Administrator", "PRIVSET.Apply SSL Certificate", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'iam.Certificate' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.Certificate" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.Certificate' resource was created as requested. The 'iam.Certificate' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.Certificate" } } }, "links": { "GetIamCertificateByMoid": { "operationId": "GetIamCertificateByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/Certificates/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/Certificates/{Moid}": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.Certificate' resource.", "operationId": "GetIamCertificateByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-only SSL Certificates", "READ.iam.Certificate", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iam.Certificate' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.Certificate" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetIamCertificateByMoid": { "operationId": "GetIamCertificateByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/Certificates/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "iam" ], "summary": "Update a 'iam.Certificate' resource.", "operationId": "UpdateIamCertificate", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.iam.Certificate" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.Certificate' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.Certificate" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.Certificate' resource was modified as requested. The 'iam.Certificate' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.Certificate" } } }, "links": { "GetIamCertificateByMoid": { "operationId": "GetIamCertificateByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/Certificates/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "iam" ], "summary": "Update a 'iam.Certificate' resource.", "operationId": "PatchIamCertificate", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.iam.Certificate" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.Certificate' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.Certificate" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.Certificate' resource was patched as requested. The 'iam.Certificate' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.Certificate" } } }, "links": { "GetIamCertificateByMoid": { "operationId": "GetIamCertificateByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/Certificates/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "iam" ], "summary": "Delete a 'iam.Certificate' resource.", "operationId": "DeleteIamCertificate", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.iam.Certificate", "PRIVSET.Account Administrator", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/CertificateRequests": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.CertificateRequest' resource.", "operationId": "GetIamCertificateRequestList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-only SSL Certificates", "READ.iam.CertificateRequest", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iam.CertificateRequest' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.CertificateRequest.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "iam" ], "summary": "Create a 'iam.CertificateRequest' resource.", "operationId": "CreateIamCertificateRequest", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.iam.CertificateRequest", "PRIVSET.Account Administrator", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'iam.CertificateRequest' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.CertificateRequest" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.CertificateRequest' resource was created as requested. The 'iam.CertificateRequest' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.CertificateRequest" } } }, "links": { "GetIamCertificateRequestByMoid": { "operationId": "GetIamCertificateRequestByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/CertificateRequests/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/CertificateRequests/{Moid}": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.CertificateRequest' resource.", "operationId": "GetIamCertificateRequestByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-only SSL Certificates", "READ.iam.CertificateRequest", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iam.CertificateRequest' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.CertificateRequest" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetIamCertificateRequestByMoid": { "operationId": "GetIamCertificateRequestByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/CertificateRequests/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "iam" ], "summary": "Update a 'iam.CertificateRequest' resource.", "operationId": "UpdateIamCertificateRequest", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.iam.CertificateRequest" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.CertificateRequest' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.CertificateRequest" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.CertificateRequest' resource was modified as requested. The 'iam.CertificateRequest' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.CertificateRequest" } } }, "links": { "GetIamCertificateRequestByMoid": { "operationId": "GetIamCertificateRequestByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/CertificateRequests/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "iam" ], "summary": "Update a 'iam.CertificateRequest' resource.", "operationId": "PatchIamCertificateRequest", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.iam.CertificateRequest" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.CertificateRequest' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.CertificateRequest" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.CertificateRequest' resource was patched as requested. The 'iam.CertificateRequest' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.CertificateRequest" } } }, "links": { "GetIamCertificateRequestByMoid": { "operationId": "GetIamCertificateRequestByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/CertificateRequests/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "iam" ], "summary": "Delete a 'iam.CertificateRequest' resource.", "operationId": "DeleteIamCertificateRequest", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.iam.CertificateRequest", "PRIVSET.Account Administrator", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/CuiIntegrations": { "post": { "tags": [ "iam" ], "summary": "Create a 'iam.CuiIntegration' resource.", "operationId": "CreateIamCuiIntegration", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.iam.CuiIntegration", "PRIVSET.Account Administrator", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'iam.CuiIntegration' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.CuiIntegration" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.CuiIntegration' resource was created as requested. The 'iam.CuiIntegration' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.CuiIntegration" } } }, "links": { "GetIamCuiIntegrationByMoid": { "operationId": "GetIamCuiIntegrationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/CuiIntegrations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "get": { "tags": [ "iam" ], "summary": "Read a 'iam.CuiIntegration' resource.", "operationId": "GetIamCuiIntegrationList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "READ.iam.CuiIntegration", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iam.CuiIntegration' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.CuiIntegration.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/CuiIntegrations/{Moid}": { "post": { "tags": [ "iam" ], "summary": "Update a 'iam.CuiIntegration' resource.", "operationId": "UpdateIamCuiIntegration", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.iam.CuiIntegration" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.CuiIntegration' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.CuiIntegration" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.CuiIntegration' resource was modified as requested. The 'iam.CuiIntegration' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.CuiIntegration" } } }, "links": { "GetIamCuiIntegrationByMoid": { "operationId": "GetIamCuiIntegrationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/CuiIntegrations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "iam" ], "summary": "Update a 'iam.CuiIntegration' resource.", "operationId": "PatchIamCuiIntegration", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.iam.CuiIntegration" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.CuiIntegration' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.CuiIntegration" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.CuiIntegration' resource was patched as requested. The 'iam.CuiIntegration' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.CuiIntegration" } } }, "links": { "GetIamCuiIntegrationByMoid": { "operationId": "GetIamCuiIntegrationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/CuiIntegrations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "get": { "tags": [ "iam" ], "summary": "Read a 'iam.CuiIntegration' resource.", "operationId": "GetIamCuiIntegrationByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "READ.iam.CuiIntegration", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iam.CuiIntegration' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.CuiIntegration" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetIamCuiIntegrationByMoid": { "operationId": "GetIamCuiIntegrationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/CuiIntegrations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/DefaultAuthentications": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.DefaultAuthentication' resource.", "operationId": "GetIamDefaultAuthenticationList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure account details", "PRIVSET.Manage Access and Permissions", "PRIVSET.View Access and Permissions", "READ.iam.DefaultAuthentication", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iam.DefaultAuthentication' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.DefaultAuthentication.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/DefaultAuthentications/{Moid}": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.DefaultAuthentication' resource.", "operationId": "GetIamDefaultAuthenticationByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure account details", "PRIVSET.Manage Access and Permissions", "PRIVSET.View Access and Permissions", "READ.iam.DefaultAuthentication", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iam.DefaultAuthentication' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.DefaultAuthentication" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetIamDefaultAuthenticationByMoid": { "operationId": "GetIamDefaultAuthenticationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/DefaultAuthentications/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "iam" ], "summary": "Update a 'iam.DefaultAuthentication' resource.", "operationId": "UpdateIamDefaultAuthentication", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "ROLE.Account Administrator", "UPDATE.iam.DefaultAuthentication" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.DefaultAuthentication' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.DefaultAuthentication" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.DefaultAuthentication' resource was modified as requested. The 'iam.DefaultAuthentication' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.DefaultAuthentication" } } }, "links": { "GetIamDefaultAuthenticationByMoid": { "operationId": "GetIamDefaultAuthenticationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/DefaultAuthentications/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "iam" ], "summary": "Update a 'iam.DefaultAuthentication' resource.", "operationId": "PatchIamDefaultAuthentication", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "ROLE.Account Administrator", "UPDATE.iam.DefaultAuthentication" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.DefaultAuthentication' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.DefaultAuthentication" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.DefaultAuthentication' resource was patched as requested. The 'iam.DefaultAuthentication' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.DefaultAuthentication" } } }, "links": { "GetIamDefaultAuthenticationByMoid": { "operationId": "GetIamDefaultAuthenticationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/DefaultAuthentications/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/DomainGroups": { "get": { "tags": [ "iam" ], "x-intersight-type": "SaaS", "summary": "Read a 'iam.DomainGroup' resource.", "operationId": "GetIamDomainGroupList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "READ.iam.DomainGroup" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iam.DomainGroup' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.DomainGroup.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/DomainGroups/{Moid}": { "get": { "tags": [ "iam" ], "x-intersight-type": "SaaS", "summary": "Read a 'iam.DomainGroup' resource.", "operationId": "GetIamDomainGroupByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "READ.iam.DomainGroup" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iam.DomainGroup' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.DomainGroup" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/DomainNameInfos": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.DomainNameInfo' resource.", "operationId": "GetIamDomainNameInfoList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Add domain names", "PRIVSET.Add identity providers", "PRIVSET.Delete domain names", "PRIVSET.Delete identity providers", "PRIVSET.Edit identity providers", "PRIVSET.Manage Access and Permissions", "PRIVSET.Manage Identity Providers", "PRIVSET.Regenerate domain names", "PRIVSET.Verify domain names", "PRIVSET.View Access and Permissions", "READ.iam.DomainNameInfo", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iam.DomainNameInfo' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.DomainNameInfo.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "iam" ], "summary": "Create a 'iam.DomainNameInfo' resource.", "operationId": "CreateIamDomainNameInfo", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.iam.DomainNameInfo", "PRIVSET.Account Administrator", "PRIVSET.Add domain names", "PRIVSET.Manage Identity Providers", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'iam.DomainNameInfo' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.DomainNameInfo" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.DomainNameInfo' resource was created as requested. The 'iam.DomainNameInfo' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.DomainNameInfo" } } }, "links": { "GetIamDomainNameInfoByMoid": { "operationId": "GetIamDomainNameInfoByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/DomainNameInfos/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/DomainNameInfos/{Moid}": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.DomainNameInfo' resource.", "operationId": "GetIamDomainNameInfoByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Add domain names", "PRIVSET.Add identity providers", "PRIVSET.Delete domain names", "PRIVSET.Delete identity providers", "PRIVSET.Edit identity providers", "PRIVSET.Manage Access and Permissions", "PRIVSET.Manage Identity Providers", "PRIVSET.Regenerate domain names", "PRIVSET.Verify domain names", "PRIVSET.View Access and Permissions", "READ.iam.DomainNameInfo", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iam.DomainNameInfo' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.DomainNameInfo" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetIamDomainNameInfoByMoid": { "operationId": "GetIamDomainNameInfoByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/DomainNameInfos/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "iam" ], "summary": "Update a 'iam.DomainNameInfo' resource.", "operationId": "UpdateIamDomainNameInfo", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Identity Providers", "ROLE.Account Administrator", "UPDATE.iam.DomainNameInfo" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.DomainNameInfo' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.DomainNameInfo" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.DomainNameInfo' resource was modified as requested. The 'iam.DomainNameInfo' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.DomainNameInfo" } } }, "links": { "GetIamDomainNameInfoByMoid": { "operationId": "GetIamDomainNameInfoByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/DomainNameInfos/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "iam" ], "summary": "Update a 'iam.DomainNameInfo' resource.", "operationId": "PatchIamDomainNameInfo", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Identity Providers", "ROLE.Account Administrator", "UPDATE.iam.DomainNameInfo" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.DomainNameInfo' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.DomainNameInfo" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.DomainNameInfo' resource was patched as requested. The 'iam.DomainNameInfo' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.DomainNameInfo" } } }, "links": { "GetIamDomainNameInfoByMoid": { "operationId": "GetIamDomainNameInfoByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/DomainNameInfos/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "iam" ], "summary": "Delete a 'iam.DomainNameInfo' resource.", "operationId": "DeleteIamDomainNameInfo", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.iam.DomainNameInfo", "PRIVSET.Account Administrator", "PRIVSET.Delete domain names", "PRIVSET.Manage Identity Providers", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/EndPointPrivileges": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.EndPointPrivilege' resource.", "operationId": "GetIamEndPointPrivilegeList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "PRIVSET.Read-Only", "PRIVSET.View Access and Permissions", "READ.iam.EndPointPrivilege", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iam.EndPointPrivilege' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.EndPointPrivilege.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/EndPointPrivileges/{Moid}": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.EndPointPrivilege' resource.", "operationId": "GetIamEndPointPrivilegeByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "PRIVSET.Read-Only", "PRIVSET.View Access and Permissions", "READ.iam.EndPointPrivilege", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iam.EndPointPrivilege' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.EndPointPrivilege" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetIamEndPointPrivilegeByMoid": { "operationId": "GetIamEndPointPrivilegeByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/EndPointPrivileges/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/EndPointRoles": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.EndPointRole' resource.", "operationId": "GetIamEndPointRoleList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure LDAP servers", "PRIVSET.Delete LDAP servers", "PRIVSET.Edit LDAP servers", "PRIVSET.Manage Access and Permissions", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only LDAP policies", "PRIVSET.Read-only Local User policies", "PRIVSET.View Access and Permissions", "PRIVSET.View Server Profiles", "READ.iam.EndPointRole", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iam.EndPointRole' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.EndPointRole.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/EndPointRoles/{Moid}": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.EndPointRole' resource.", "operationId": "GetIamEndPointRoleByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure LDAP servers", "PRIVSET.Delete LDAP servers", "PRIVSET.Edit LDAP servers", "PRIVSET.Manage Access and Permissions", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only LDAP policies", "PRIVSET.Read-only Local User policies", "PRIVSET.View Access and Permissions", "PRIVSET.View Server Profiles", "READ.iam.EndPointRole", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iam.EndPointRole' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.EndPointRole" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetIamEndPointRoleByMoid": { "operationId": "GetIamEndPointRoleByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/EndPointRoles/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/EndPointUsers": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.EndPointUser' resource.", "operationId": "GetIamEndPointUserList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only Local User policies", "PRIVSET.View Server Profiles", "READ.iam.EndPointUser", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iam.EndPointUser' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.EndPointUser.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "iam" ], "summary": "Create a 'iam.EndPointUser' resource.", "operationId": "CreateIamEndPointUser", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.iam.EndPointUser", "PRIVSET.Account Administrator", "PRIVSET.Create, clone and edit Local User policies", "PRIVSET.Edit Local User policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'iam.EndPointUser' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.EndPointUser" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.EndPointUser' resource was created as requested. The 'iam.EndPointUser' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.EndPointUser" } } }, "links": { "GetIamEndPointUserByMoid": { "operationId": "GetIamEndPointUserByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/EndPointUsers/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/EndPointUsers/{Moid}": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.EndPointUser' resource.", "operationId": "GetIamEndPointUserByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only Local User policies", "PRIVSET.View Server Profiles", "READ.iam.EndPointUser", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iam.EndPointUser' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.EndPointUser" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetIamEndPointUserByMoid": { "operationId": "GetIamEndPointUserByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/EndPointUsers/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "iam" ], "summary": "Update a 'iam.EndPointUser' resource.", "operationId": "UpdateIamEndPointUser", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Create, clone and edit Local User policies", "PRIVSET.Edit Local User policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator", "UPDATE.iam.EndPointUser" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.EndPointUser' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.EndPointUser" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.EndPointUser' resource was modified as requested. The 'iam.EndPointUser' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.EndPointUser" } } }, "links": { "GetIamEndPointUserByMoid": { "operationId": "GetIamEndPointUserByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/EndPointUsers/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "iam" ], "summary": "Update a 'iam.EndPointUser' resource.", "operationId": "PatchIamEndPointUser", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Create, clone and edit Local User policies", "PRIVSET.Edit Local User policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator", "UPDATE.iam.EndPointUser" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.EndPointUser' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.EndPointUser" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.EndPointUser' resource was patched as requested. The 'iam.EndPointUser' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.EndPointUser" } } }, "links": { "GetIamEndPointUserByMoid": { "operationId": "GetIamEndPointUserByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/EndPointUsers/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "iam" ], "summary": "Delete a 'iam.EndPointUser' resource.", "operationId": "DeleteIamEndPointUser", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.iam.EndPointUser", "PRIVSET.Account Administrator", "PRIVSET.Create, clone and edit Local User policies", "PRIVSET.Delete Local User policies", "PRIVSET.Edit Local User policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/EndPointUserInventories": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.EndPointUserInventory' resource.", "operationId": "GetIamEndPointUserInventoryList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only Local User policies", "PRIVSET.View Server Profiles", "READ.iam.EndPointUserInventory", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iam.EndPointUserInventory' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.EndPointUserInventory.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/EndPointUserInventories/{Moid}": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.EndPointUserInventory' resource.", "operationId": "GetIamEndPointUserInventoryByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only Local User policies", "PRIVSET.View Server Profiles", "READ.iam.EndPointUserInventory", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iam.EndPointUserInventory' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.EndPointUserInventory" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetIamEndPointUserInventoryByMoid": { "operationId": "GetIamEndPointUserInventoryByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/EndPointUserInventories/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/EndPointUserPolicies": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.EndPointUserPolicy' resource.", "operationId": "GetIamEndPointUserPolicyList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Unified Edge Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only Local User policies", "PRIVSET.Read-only UCS domain profile templates", "PRIVSET.View Server Profiles", "PRIVSET.View Unified Edge Profiles", "READ.iam.EndPointUserPolicy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iam.EndPointUserPolicy' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.EndPointUserPolicy.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "iam" ], "summary": "Create a 'iam.EndPointUserPolicy' resource.", "operationId": "CreateIamEndPointUserPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.iam.EndPointUserPolicy", "PRIVSET.Account Administrator", "PRIVSET.Create, clone and edit Local User policies", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Unified Edge Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'iam.EndPointUserPolicy' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.EndPointUserPolicy" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.EndPointUserPolicy' resource was created as requested. The 'iam.EndPointUserPolicy' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.EndPointUserPolicy" } } }, "links": { "GetIamEndPointUserPolicyByMoid": { "operationId": "GetIamEndPointUserPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/EndPointUserPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/EndPointUserPolicies/{Moid}": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.EndPointUserPolicy' resource.", "operationId": "GetIamEndPointUserPolicyByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Unified Edge Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only Local User policies", "PRIVSET.Read-only UCS domain profile templates", "PRIVSET.View Server Profiles", "PRIVSET.View Unified Edge Profiles", "READ.iam.EndPointUserPolicy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iam.EndPointUserPolicy' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.EndPointUserPolicy" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetIamEndPointUserPolicyByMoid": { "operationId": "GetIamEndPointUserPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/EndPointUserPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "iam" ], "summary": "Update a 'iam.EndPointUserPolicy' resource.", "operationId": "UpdateIamEndPointUserPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit Local User policies", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Unified Edge Profiles", "ROLE.Account Administrator", "UPDATE.iam.EndPointUserPolicy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.EndPointUserPolicy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.EndPointUserPolicy" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.EndPointUserPolicy' resource was modified as requested. The 'iam.EndPointUserPolicy' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.EndPointUserPolicy" } } }, "links": { "GetIamEndPointUserPolicyByMoid": { "operationId": "GetIamEndPointUserPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/EndPointUserPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "iam" ], "summary": "Update a 'iam.EndPointUserPolicy' resource.", "operationId": "PatchIamEndPointUserPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit Local User policies", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Unified Edge Profiles", "ROLE.Account Administrator", "UPDATE.iam.EndPointUserPolicy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.EndPointUserPolicy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.EndPointUserPolicy" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.EndPointUserPolicy' resource was patched as requested. The 'iam.EndPointUserPolicy' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.EndPointUserPolicy" } } }, "links": { "GetIamEndPointUserPolicyByMoid": { "operationId": "GetIamEndPointUserPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/EndPointUserPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "iam" ], "summary": "Delete a 'iam.EndPointUserPolicy' resource.", "operationId": "DeleteIamEndPointUserPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.iam.EndPointUserPolicy", "PRIVSET.Account Administrator", "PRIVSET.Delete Local User policies", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Unified Edge Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/EndPointUserPolicyInventories": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.EndPointUserPolicyInventory' resource.", "operationId": "GetIamEndPointUserPolicyInventoryList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Unified Edge Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only Local User policies", "PRIVSET.Read-only UCS domain profile templates", "PRIVSET.View Server Profiles", "PRIVSET.View Unified Edge Profiles", "READ.iam.EndPointUserPolicyInventory", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iam.EndPointUserPolicyInventory' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.EndPointUserPolicyInventory.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/EndPointUserPolicyInventories/{Moid}": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.EndPointUserPolicyInventory' resource.", "operationId": "GetIamEndPointUserPolicyInventoryByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Unified Edge Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only Local User policies", "PRIVSET.Read-only UCS domain profile templates", "PRIVSET.View Server Profiles", "PRIVSET.View Unified Edge Profiles", "READ.iam.EndPointUserPolicyInventory", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iam.EndPointUserPolicyInventory' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.EndPointUserPolicyInventory" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetIamEndPointUserPolicyInventoryByMoid": { "operationId": "GetIamEndPointUserPolicyInventoryByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/EndPointUserPolicyInventories/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/EndPointUserRoles": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.EndPointUserRole' resource.", "operationId": "GetIamEndPointUserRoleList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only Local User policies", "PRIVSET.View Server Profiles", "READ.iam.EndPointUserRole", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iam.EndPointUserRole' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.EndPointUserRole.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "iam" ], "summary": "Create a 'iam.EndPointUserRole' resource.", "operationId": "CreateIamEndPointUserRole", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.iam.EndPointUserRole", "PRIVSET.Account Administrator", "PRIVSET.Create, clone and edit Local User policies", "PRIVSET.Edit Local User policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'iam.EndPointUserRole' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.EndPointUserRole" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.EndPointUserRole' resource was created as requested. The 'iam.EndPointUserRole' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.EndPointUserRole" } } }, "links": { "GetIamEndPointUserRoleByMoid": { "operationId": "GetIamEndPointUserRoleByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/EndPointUserRoles/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/EndPointUserRoles/{Moid}": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.EndPointUserRole' resource.", "operationId": "GetIamEndPointUserRoleByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only Local User policies", "PRIVSET.View Server Profiles", "READ.iam.EndPointUserRole", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iam.EndPointUserRole' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.EndPointUserRole" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetIamEndPointUserRoleByMoid": { "operationId": "GetIamEndPointUserRoleByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/EndPointUserRoles/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "iam" ], "summary": "Update a 'iam.EndPointUserRole' resource.", "operationId": "UpdateIamEndPointUserRole", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Create, clone and edit Local User policies", "PRIVSET.Edit Local User policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator", "UPDATE.iam.EndPointUserRole" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.EndPointUserRole' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.EndPointUserRole" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.EndPointUserRole' resource was modified as requested. The 'iam.EndPointUserRole' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.EndPointUserRole" } } }, "links": { "GetIamEndPointUserRoleByMoid": { "operationId": "GetIamEndPointUserRoleByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/EndPointUserRoles/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "iam" ], "summary": "Update a 'iam.EndPointUserRole' resource.", "operationId": "PatchIamEndPointUserRole", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Create, clone and edit Local User policies", "PRIVSET.Edit Local User policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator", "UPDATE.iam.EndPointUserRole" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.EndPointUserRole' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.EndPointUserRole" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.EndPointUserRole' resource was patched as requested. The 'iam.EndPointUserRole' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.EndPointUserRole" } } }, "links": { "GetIamEndPointUserRoleByMoid": { "operationId": "GetIamEndPointUserRoleByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/EndPointUserRoles/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "iam" ], "summary": "Delete a 'iam.EndPointUserRole' resource.", "operationId": "DeleteIamEndPointUserRole", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.iam.EndPointUserRole", "PRIVSET.Account Administrator", "PRIVSET.Create, clone and edit Local User policies", "PRIVSET.Delete Local User policies", "PRIVSET.Edit Local User policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/EndPointUserRoleInventories": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.EndPointUserRoleInventory' resource.", "operationId": "GetIamEndPointUserRoleInventoryList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only Local User policies", "PRIVSET.View Server Profiles", "READ.iam.EndPointUserRoleInventory", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iam.EndPointUserRoleInventory' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.EndPointUserRoleInventory.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/EndPointUserRoleInventories/{Moid}": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.EndPointUserRoleInventory' resource.", "operationId": "GetIamEndPointUserRoleInventoryByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only Local User policies", "PRIVSET.View Server Profiles", "READ.iam.EndPointUserRoleInventory", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iam.EndPointUserRoleInventory' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.EndPointUserRoleInventory" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetIamEndPointUserRoleInventoryByMoid": { "operationId": "GetIamEndPointUserRoleInventoryByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/EndPointUserRoleInventories/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/GuestAccessSettings": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.GuestAccessSettings' resource.", "operationId": "GetIamGuestAccessSettingsList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Sessions", "PRIVSET.View Access and Permissions", "READ.iam.GuestAccessSettings", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iam.GuestAccessSettings' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.GuestAccessSettings.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "iam" ], "summary": "Create a 'iam.GuestAccessSettings' resource.", "operationId": "CreateIamGuestAccessSettings", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.iam.GuestAccessSettings", "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'iam.GuestAccessSettings' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.GuestAccessSettings" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.GuestAccessSettings' resource was created as requested. The 'iam.GuestAccessSettings' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.GuestAccessSettings" } } }, "links": { "GetIamGuestAccessSettingsByMoid": { "operationId": "GetIamGuestAccessSettingsByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/GuestAccessSettings/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/GuestAccessSettings/{Moid}": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.GuestAccessSettings' resource.", "operationId": "GetIamGuestAccessSettingsByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Sessions", "PRIVSET.View Access and Permissions", "READ.iam.GuestAccessSettings", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iam.GuestAccessSettings' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.GuestAccessSettings" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetIamGuestAccessSettingsByMoid": { "operationId": "GetIamGuestAccessSettingsByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/GuestAccessSettings/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "iam" ], "summary": "Update a 'iam.GuestAccessSettings' resource.", "operationId": "UpdateIamGuestAccessSettings", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "ROLE.Account Administrator", "UPDATE.iam.GuestAccessSettings" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.GuestAccessSettings' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.GuestAccessSettings" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.GuestAccessSettings' resource was modified as requested. The 'iam.GuestAccessSettings' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.GuestAccessSettings" } } }, "links": { "GetIamGuestAccessSettingsByMoid": { "operationId": "GetIamGuestAccessSettingsByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/GuestAccessSettings/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "iam" ], "summary": "Update a 'iam.GuestAccessSettings' resource.", "operationId": "PatchIamGuestAccessSettings", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "ROLE.Account Administrator", "UPDATE.iam.GuestAccessSettings" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.GuestAccessSettings' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.GuestAccessSettings" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.GuestAccessSettings' resource was patched as requested. The 'iam.GuestAccessSettings' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.GuestAccessSettings" } } }, "links": { "GetIamGuestAccessSettingsByMoid": { "operationId": "GetIamGuestAccessSettingsByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/GuestAccessSettings/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "iam" ], "summary": "Delete a 'iam.GuestAccessSettings' resource.", "operationId": "DeleteIamGuestAccessSettings", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.iam.GuestAccessSettings", "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/Idps": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.Idp' resource.", "operationId": "GetIamIdpList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Add identity providers", "PRIVSET.Configure account details", "PRIVSET.Delete identity providers", "PRIVSET.Edit identity providers", "PRIVSET.Manage Access and Permissions", "PRIVSET.Manage Identity Providers", "PRIVSET.View Access and Permissions", "PRIVSET.View sessions", "READ.iam.Idp", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iam.Idp' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.Idp.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "iam" ], "summary": "Create a 'iam.Idp' resource.", "operationId": "CreateIamIdp", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.iam.Idp", "PRIVSET.Account Administrator", "PRIVSET.Add identity providers", "PRIVSET.Manage Identity Providers", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'iam.Idp' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.Idp" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.Idp' resource was created as requested. The 'iam.Idp' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.Idp" } } }, "links": { "GetIamIdpByMoid": { "operationId": "GetIamIdpByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/Idps/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/Idps/{Moid}": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.Idp' resource.", "operationId": "GetIamIdpByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Add identity providers", "PRIVSET.Configure account details", "PRIVSET.Delete identity providers", "PRIVSET.Edit identity providers", "PRIVSET.Manage Access and Permissions", "PRIVSET.Manage Identity Providers", "PRIVSET.View Access and Permissions", "PRIVSET.View sessions", "READ.iam.Idp", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iam.Idp' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.Idp" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetIamIdpByMoid": { "operationId": "GetIamIdpByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/Idps/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "iam" ], "summary": "Update a 'iam.Idp' resource.", "operationId": "UpdateIamIdp", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit identity providers", "PRIVSET.Manage Identity Providers", "ROLE.Account Administrator", "UPDATE.iam.Idp" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.Idp' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.Idp" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.Idp' resource was modified as requested. The 'iam.Idp' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.Idp" } } }, "links": { "GetIamIdpByMoid": { "operationId": "GetIamIdpByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/Idps/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "iam" ], "summary": "Update a 'iam.Idp' resource.", "operationId": "PatchIamIdp", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit identity providers", "PRIVSET.Manage Identity Providers", "ROLE.Account Administrator", "UPDATE.iam.Idp" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.Idp' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.Idp" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.Idp' resource was patched as requested. The 'iam.Idp' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.Idp" } } }, "links": { "GetIamIdpByMoid": { "operationId": "GetIamIdpByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/Idps/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "iam" ], "summary": "Delete a 'iam.Idp' resource.", "operationId": "DeleteIamIdp", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.iam.Idp", "PRIVSET.Account Administrator", "PRIVSET.Delete identity providers", "PRIVSET.Manage Identity Providers", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/IdpReferences": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.IdpReference' resource.", "operationId": "GetIamIdpReferenceList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure MFA", "PRIVSET.Manage Access and Permissions", "PRIVSET.Manage Identity Providers", "PRIVSET.Read-only software repository", "PRIVSET.View Access and Permissions", "PRIVSET.View sessions", "READ.iam.IdpReference", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iam.IdpReference' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.IdpReference.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/IdpReferences/{Moid}": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.IdpReference' resource.", "operationId": "GetIamIdpReferenceByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure MFA", "PRIVSET.Manage Access and Permissions", "PRIVSET.Manage Identity Providers", "PRIVSET.Read-only software repository", "PRIVSET.View Access and Permissions", "PRIVSET.View sessions", "READ.iam.IdpReference", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iam.IdpReference' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.IdpReference" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetIamIdpReferenceByMoid": { "operationId": "GetIamIdpReferenceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/IdpReferences/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "iam" ], "summary": "Update a 'iam.IdpReference' resource.", "operationId": "UpdateIamIdpReference", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Identity Providers", "ROLE.Account Administrator", "UPDATE.iam.IdpReference" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.IdpReference' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.IdpReference" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.IdpReference' resource was modified as requested. The 'iam.IdpReference' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.IdpReference" } } }, "links": { "GetIamIdpReferenceByMoid": { "operationId": "GetIamIdpReferenceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/IdpReferences/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "iam" ], "summary": "Update a 'iam.IdpReference' resource.", "operationId": "PatchIamIdpReference", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Identity Providers", "ROLE.Account Administrator", "UPDATE.iam.IdpReference" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.IdpReference' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.IdpReference" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.IdpReference' resource was patched as requested. The 'iam.IdpReference' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.IdpReference" } } }, "links": { "GetIamIdpReferenceByMoid": { "operationId": "GetIamIdpReferenceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/IdpReferences/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/IpAccessManagements": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.IpAccessManagement' resource.", "operationId": "GetIamIpAccessManagementList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Add trusted IP ranges", "PRIVSET.Delete trusted IP ranges", "PRIVSET.Edit trusted IP ranges", "PRIVSET.Enable/disable IP access management", "PRIVSET.Manage Access and Permissions", "PRIVSET.Manage Sessions", "PRIVSET.View Access and Permissions", "READ.iam.IpAccessManagement", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iam.IpAccessManagement' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.IpAccessManagement.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "iam" ], "summary": "Create a 'iam.IpAccessManagement' resource.", "operationId": "CreateIamIpAccessManagement", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.iam.IpAccessManagement", "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "PRIVSET.Manage Sessions", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'iam.IpAccessManagement' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.IpAccessManagement" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.IpAccessManagement' resource was created as requested. The 'iam.IpAccessManagement' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.IpAccessManagement" } } }, "links": { "GetIamIpAccessManagementByMoid": { "operationId": "GetIamIpAccessManagementByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/IpAccessManagements/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/IpAccessManagements/{Moid}": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.IpAccessManagement' resource.", "operationId": "GetIamIpAccessManagementByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Add trusted IP ranges", "PRIVSET.Delete trusted IP ranges", "PRIVSET.Edit trusted IP ranges", "PRIVSET.Enable/disable IP access management", "PRIVSET.Manage Access and Permissions", "PRIVSET.Manage Sessions", "PRIVSET.View Access and Permissions", "READ.iam.IpAccessManagement", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iam.IpAccessManagement' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.IpAccessManagement" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetIamIpAccessManagementByMoid": { "operationId": "GetIamIpAccessManagementByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/IpAccessManagements/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "iam" ], "summary": "Update a 'iam.IpAccessManagement' resource.", "operationId": "UpdateIamIpAccessManagement", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "PRIVSET.Manage Sessions", "ROLE.Account Administrator", "UPDATE.iam.IpAccessManagement" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.IpAccessManagement' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.IpAccessManagement" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.IpAccessManagement' resource was modified as requested. The 'iam.IpAccessManagement' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.IpAccessManagement" } } }, "links": { "GetIamIpAccessManagementByMoid": { "operationId": "GetIamIpAccessManagementByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/IpAccessManagements/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "iam" ], "summary": "Update a 'iam.IpAccessManagement' resource.", "operationId": "PatchIamIpAccessManagement", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "PRIVSET.Manage Sessions", "ROLE.Account Administrator", "UPDATE.iam.IpAccessManagement" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.IpAccessManagement' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.IpAccessManagement" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.IpAccessManagement' resource was patched as requested. The 'iam.IpAccessManagement' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.IpAccessManagement" } } }, "links": { "GetIamIpAccessManagementByMoid": { "operationId": "GetIamIpAccessManagementByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/IpAccessManagements/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/IpAddresses": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.IpAddress' resource.", "operationId": "GetIamIpAddressList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Add trusted IP ranges", "PRIVSET.Delete trusted IP ranges", "PRIVSET.Edit trusted IP ranges", "PRIVSET.Enable/disable IP access management", "PRIVSET.Manage Access and Permissions", "PRIVSET.Manage Sessions", "PRIVSET.View Access and Permissions", "READ.iam.IpAddress", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iam.IpAddress' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.IpAddress.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "iam" ], "summary": "Create a 'iam.IpAddress' resource.", "operationId": "CreateIamIpAddress", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.iam.IpAddress", "PRIVSET.Account Administrator", "PRIVSET.Add trusted IP ranges", "PRIVSET.Manage Access and Permissions", "PRIVSET.Manage Sessions", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'iam.IpAddress' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.IpAddress" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.IpAddress' resource was created as requested. The 'iam.IpAddress' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.IpAddress" } } }, "links": { "GetIamIpAddressByMoid": { "operationId": "GetIamIpAddressByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/IpAddresses/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/IpAddresses/{Moid}": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.IpAddress' resource.", "operationId": "GetIamIpAddressByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Add trusted IP ranges", "PRIVSET.Delete trusted IP ranges", "PRIVSET.Edit trusted IP ranges", "PRIVSET.Enable/disable IP access management", "PRIVSET.Manage Access and Permissions", "PRIVSET.Manage Sessions", "PRIVSET.View Access and Permissions", "READ.iam.IpAddress", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iam.IpAddress' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.IpAddress" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetIamIpAddressByMoid": { "operationId": "GetIamIpAddressByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/IpAddresses/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "iam" ], "summary": "Update a 'iam.IpAddress' resource.", "operationId": "UpdateIamIpAddress", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit trusted IP ranges", "PRIVSET.Manage Access and Permissions", "PRIVSET.Manage Sessions", "ROLE.Account Administrator", "UPDATE.iam.IpAddress" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.IpAddress' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.IpAddress" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.IpAddress' resource was modified as requested. The 'iam.IpAddress' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.IpAddress" } } }, "links": { "GetIamIpAddressByMoid": { "operationId": "GetIamIpAddressByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/IpAddresses/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "iam" ], "summary": "Update a 'iam.IpAddress' resource.", "operationId": "PatchIamIpAddress", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit trusted IP ranges", "PRIVSET.Manage Access and Permissions", "PRIVSET.Manage Sessions", "ROLE.Account Administrator", "UPDATE.iam.IpAddress" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.IpAddress' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.IpAddress" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.IpAddress' resource was patched as requested. The 'iam.IpAddress' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.IpAddress" } } }, "links": { "GetIamIpAddressByMoid": { "operationId": "GetIamIpAddressByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/IpAddresses/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "iam" ], "summary": "Delete a 'iam.IpAddress' resource.", "operationId": "DeleteIamIpAddress", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.iam.IpAddress", "PRIVSET.Account Administrator", "PRIVSET.Delete trusted IP ranges", "PRIVSET.Manage Access and Permissions", "PRIVSET.Manage Sessions", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/LdapConfigParams": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.LdapConfigParams' resource.", "operationId": "GetIamLdapConfigParamsList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "PRIVSET.Manage Identity Providers", "READ.iam.LdapConfigParams", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iam.LdapConfigParams' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.LdapConfigParams.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/LdapConfigParams/{Moid}": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.LdapConfigParams' resource.", "operationId": "GetIamLdapConfigParamsByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "PRIVSET.Manage Identity Providers", "READ.iam.LdapConfigParams", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iam.LdapConfigParams' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.LdapConfigParams" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetIamLdapConfigParamsByMoid": { "operationId": "GetIamLdapConfigParamsByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/LdapConfigParams/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/LdapGroups": { "post": { "tags": [ "iam" ], "summary": "Create a 'iam.LdapGroup' resource.", "operationId": "CreateIamLdapGroup", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.iam.LdapGroup", "PRIVSET.Account Administrator", "PRIVSET.Create, clone and edit LDAP policies", "PRIVSET.Edit LDAP policies", "PRIVSET.Manage Access and Permissions", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'iam.LdapGroup' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.LdapGroup" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.LdapGroup' resource was created as requested. The 'iam.LdapGroup' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.LdapGroup" } } }, "links": { "GetIamLdapGroupByMoid": { "operationId": "GetIamLdapGroupByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/LdapGroups/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "get": { "tags": [ "iam" ], "summary": "Read a 'iam.LdapGroup' resource.", "operationId": "GetIamLdapGroupList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only LDAP policies", "PRIVSET.View Server Profiles", "PRIVSET.View Switch Profiles", "READ.iam.LdapGroup", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iam.LdapGroup' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.LdapGroup.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/LdapGroups/{Moid}": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.LdapGroup' resource.", "operationId": "GetIamLdapGroupByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only LDAP policies", "PRIVSET.View Server Profiles", "PRIVSET.View Switch Profiles", "READ.iam.LdapGroup", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iam.LdapGroup' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.LdapGroup" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetIamLdapGroupByMoid": { "operationId": "GetIamLdapGroupByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/LdapGroups/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "iam" ], "summary": "Update a 'iam.LdapGroup' resource.", "operationId": "UpdateIamLdapGroup", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Create, clone and edit LDAP policies", "PRIVSET.Edit LDAP policies", "PRIVSET.Manage Access and Permissions", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "ROLE.Account Administrator", "UPDATE.iam.LdapGroup" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.LdapGroup' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.LdapGroup" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.LdapGroup' resource was modified as requested. The 'iam.LdapGroup' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.LdapGroup" } } }, "links": { "GetIamLdapGroupByMoid": { "operationId": "GetIamLdapGroupByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/LdapGroups/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "iam" ], "summary": "Update a 'iam.LdapGroup' resource.", "operationId": "PatchIamLdapGroup", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Create, clone and edit LDAP policies", "PRIVSET.Edit LDAP policies", "PRIVSET.Manage Access and Permissions", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "ROLE.Account Administrator", "UPDATE.iam.LdapGroup" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.LdapGroup' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.LdapGroup" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.LdapGroup' resource was patched as requested. The 'iam.LdapGroup' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.LdapGroup" } } }, "links": { "GetIamLdapGroupByMoid": { "operationId": "GetIamLdapGroupByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/LdapGroups/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "iam" ], "summary": "Delete a 'iam.LdapGroup' resource.", "operationId": "DeleteIamLdapGroup", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.iam.LdapGroup", "PRIVSET.Account Administrator", "PRIVSET.Create, clone and edit LDAP policies", "PRIVSET.Delete LDAP policies", "PRIVSET.Edit LDAP policies", "PRIVSET.Manage Access and Permissions", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/LdapGroupInventories": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.LdapGroupInventory' resource.", "operationId": "GetIamLdapGroupInventoryList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only LDAP policies", "PRIVSET.View Server Profiles", "PRIVSET.View Switch Profiles", "READ.iam.LdapGroupInventory", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iam.LdapGroupInventory' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.LdapGroupInventory.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/LdapGroupInventories/{Moid}": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.LdapGroupInventory' resource.", "operationId": "GetIamLdapGroupInventoryByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only LDAP policies", "PRIVSET.View Server Profiles", "PRIVSET.View Switch Profiles", "READ.iam.LdapGroupInventory", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iam.LdapGroupInventory' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.LdapGroupInventory" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetIamLdapGroupInventoryByMoid": { "operationId": "GetIamLdapGroupInventoryByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/LdapGroupInventories/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/LdapMeta": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.LdapMeta' resource.", "operationId": "GetIamLdapMetaList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "PRIVSET.View Access and Permissions", "READ.iam.LdapMeta", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iam.LdapMeta' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.LdapMeta.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/LdapMeta/{Moid}": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.LdapMeta' resource.", "operationId": "GetIamLdapMetaByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "PRIVSET.View Access and Permissions", "READ.iam.LdapMeta", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iam.LdapMeta' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.LdapMeta" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetIamLdapMetaByMoid": { "operationId": "GetIamLdapMetaByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/LdapMeta/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/LdapPolicies": { "post": { "tags": [ "iam" ], "summary": "Create a 'iam.LdapPolicy' resource.", "operationId": "CreateIamLdapPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.iam.LdapPolicy", "PRIVSET.Account Administrator", "PRIVSET.Configure LDAP servers", "PRIVSET.Create, clone and edit LDAP policies", "PRIVSET.Manage Access and Permissions", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'iam.LdapPolicy' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.LdapPolicy" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.LdapPolicy' resource was created as requested. The 'iam.LdapPolicy' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.LdapPolicy" } } }, "links": { "GetIamLdapPolicyByMoid": { "operationId": "GetIamLdapPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/LdapPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "get": { "tags": [ "iam" ], "summary": "Read a 'iam.LdapPolicy' resource.", "operationId": "GetIamLdapPolicyList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only LDAP policies", "PRIVSET.View Server Profiles", "PRIVSET.View Switch Profiles", "READ.iam.LdapPolicy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iam.LdapPolicy' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.LdapPolicy.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/LdapPolicies/{Moid}": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.LdapPolicy' resource.", "operationId": "GetIamLdapPolicyByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only LDAP policies", "PRIVSET.View Server Profiles", "PRIVSET.View Switch Profiles", "READ.iam.LdapPolicy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iam.LdapPolicy' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.LdapPolicy" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetIamLdapPolicyByMoid": { "operationId": "GetIamLdapPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/LdapPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "iam" ], "summary": "Update a 'iam.LdapPolicy' resource.", "operationId": "UpdateIamLdapPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit LDAP policies", "PRIVSET.Edit LDAP servers", "PRIVSET.Manage Access and Permissions", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "ROLE.Account Administrator", "UPDATE.iam.LdapPolicy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.LdapPolicy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.LdapPolicy" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.LdapPolicy' resource was modified as requested. The 'iam.LdapPolicy' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.LdapPolicy" } } }, "links": { "GetIamLdapPolicyByMoid": { "operationId": "GetIamLdapPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/LdapPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "iam" ], "summary": "Update a 'iam.LdapPolicy' resource.", "operationId": "PatchIamLdapPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit LDAP policies", "PRIVSET.Edit LDAP servers", "PRIVSET.Manage Access and Permissions", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "ROLE.Account Administrator", "UPDATE.iam.LdapPolicy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.LdapPolicy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.LdapPolicy" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.LdapPolicy' resource was patched as requested. The 'iam.LdapPolicy' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.LdapPolicy" } } }, "links": { "GetIamLdapPolicyByMoid": { "operationId": "GetIamLdapPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/LdapPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "iam" ], "summary": "Delete a 'iam.LdapPolicy' resource.", "operationId": "DeleteIamLdapPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.iam.LdapPolicy", "PRIVSET.Account Administrator", "PRIVSET.Delete LDAP policies", "PRIVSET.Delete LDAP servers", "PRIVSET.Manage Access and Permissions", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/LdapPolicyInventories": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.LdapPolicyInventory' resource.", "operationId": "GetIamLdapPolicyInventoryList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only LDAP policies", "PRIVSET.View Server Profiles", "PRIVSET.View Switch Profiles", "READ.iam.LdapPolicyInventory", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iam.LdapPolicyInventory' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.LdapPolicyInventory.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/LdapPolicyInventories/{Moid}": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.LdapPolicyInventory' resource.", "operationId": "GetIamLdapPolicyInventoryByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only LDAP policies", "PRIVSET.View Server Profiles", "PRIVSET.View Switch Profiles", "READ.iam.LdapPolicyInventory", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iam.LdapPolicyInventory' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.LdapPolicyInventory" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetIamLdapPolicyInventoryByMoid": { "operationId": "GetIamLdapPolicyInventoryByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/LdapPolicyInventories/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/LdapProviders": { "post": { "tags": [ "iam" ], "summary": "Create a 'iam.LdapProvider' resource.", "operationId": "CreateIamLdapProvider", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.iam.LdapProvider", "PRIVSET.Account Administrator", "PRIVSET.Configure LDAP servers", "PRIVSET.Create, clone and edit LDAP policies", "PRIVSET.Edit LDAP policies", "PRIVSET.Manage Access and Permissions", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'iam.LdapProvider' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.LdapProvider" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.LdapProvider' resource was created as requested. The 'iam.LdapProvider' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.LdapProvider" } } }, "links": { "GetIamLdapProviderByMoid": { "operationId": "GetIamLdapProviderByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/LdapProviders/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "get": { "tags": [ "iam" ], "summary": "Read a 'iam.LdapProvider' resource.", "operationId": "GetIamLdapProviderList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure LDAP servers", "PRIVSET.Delete LDAP servers", "PRIVSET.Edit LDAP servers", "PRIVSET.Manage Access and Permissions", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only LDAP policies", "PRIVSET.View Server Profiles", "PRIVSET.View Switch Profiles", "READ.iam.LdapProvider", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iam.LdapProvider' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.LdapProvider.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/LdapProviders/{Moid}": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.LdapProvider' resource.", "operationId": "GetIamLdapProviderByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure LDAP servers", "PRIVSET.Delete LDAP servers", "PRIVSET.Edit LDAP servers", "PRIVSET.Manage Access and Permissions", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only LDAP policies", "PRIVSET.View Server Profiles", "PRIVSET.View Switch Profiles", "READ.iam.LdapProvider", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iam.LdapProvider' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.LdapProvider" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetIamLdapProviderByMoid": { "operationId": "GetIamLdapProviderByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/LdapProviders/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "iam" ], "summary": "Update a 'iam.LdapProvider' resource.", "operationId": "UpdateIamLdapProvider", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure LDAP servers", "PRIVSET.Create, clone and edit LDAP policies", "PRIVSET.Edit LDAP policies", "PRIVSET.Edit LDAP servers", "PRIVSET.Manage Access and Permissions", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "ROLE.Account Administrator", "UPDATE.iam.LdapProvider" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.LdapProvider' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.LdapProvider" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.LdapProvider' resource was modified as requested. The 'iam.LdapProvider' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.LdapProvider" } } }, "links": { "GetIamLdapProviderByMoid": { "operationId": "GetIamLdapProviderByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/LdapProviders/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "iam" ], "summary": "Update a 'iam.LdapProvider' resource.", "operationId": "PatchIamLdapProvider", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure LDAP servers", "PRIVSET.Create, clone and edit LDAP policies", "PRIVSET.Edit LDAP policies", "PRIVSET.Edit LDAP servers", "PRIVSET.Manage Access and Permissions", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "ROLE.Account Administrator", "UPDATE.iam.LdapProvider" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.LdapProvider' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.LdapProvider" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.LdapProvider' resource was patched as requested. The 'iam.LdapProvider' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.LdapProvider" } } }, "links": { "GetIamLdapProviderByMoid": { "operationId": "GetIamLdapProviderByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/LdapProviders/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "iam" ], "summary": "Delete a 'iam.LdapProvider' resource.", "operationId": "DeleteIamLdapProvider", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.iam.LdapProvider", "PRIVSET.Account Administrator", "PRIVSET.Create, clone and edit LDAP policies", "PRIVSET.Delete LDAP policies", "PRIVSET.Delete LDAP servers", "PRIVSET.Edit LDAP policies", "PRIVSET.Manage Access and Permissions", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/LdapProviderInventories": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.LdapProviderInventory' resource.", "operationId": "GetIamLdapProviderInventoryList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure LDAP servers", "PRIVSET.Delete LDAP servers", "PRIVSET.Edit LDAP servers", "PRIVSET.Manage Access and Permissions", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only LDAP policies", "PRIVSET.View Server Profiles", "PRIVSET.View Switch Profiles", "READ.iam.LdapProviderInventory", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iam.LdapProviderInventory' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.LdapProviderInventory.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/LdapProviderInventories/{Moid}": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.LdapProviderInventory' resource.", "operationId": "GetIamLdapProviderInventoryByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure LDAP servers", "PRIVSET.Delete LDAP servers", "PRIVSET.Edit LDAP servers", "PRIVSET.Manage Access and Permissions", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only LDAP policies", "PRIVSET.View Server Profiles", "PRIVSET.View Switch Profiles", "READ.iam.LdapProviderInventory", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iam.LdapProviderInventory' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.LdapProviderInventory" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetIamLdapProviderInventoryByMoid": { "operationId": "GetIamLdapProviderInventoryByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/LdapProviderInventories/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/LocalUserPasswords": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.LocalUserPassword' resource.", "operationId": "GetIamLocalUserPasswordList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Global Read Privileges", "PRIVSET.Global System Privileges", "READ.iam.LocalUserPassword" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iam.LocalUserPassword' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.LocalUserPassword.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "iam" ], "summary": "Create a 'iam.LocalUserPassword' resource.", "operationId": "CreateIamLocalUserPassword", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.iam.LocalUserPassword", "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'iam.LocalUserPassword' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.LocalUserPassword" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.LocalUserPassword' resource was created as requested. The 'iam.LocalUserPassword' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.LocalUserPassword" } } }, "links": { "GetIamLocalUserPasswordByMoid": { "operationId": "GetIamLocalUserPasswordByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/LocalUserPasswords/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/LocalUserPasswords/{Moid}": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.LocalUserPassword' resource.", "operationId": "GetIamLocalUserPasswordByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Global Read Privileges", "PRIVSET.Global System Privileges", "READ.iam.LocalUserPassword" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iam.LocalUserPassword' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.LocalUserPassword" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetIamLocalUserPasswordByMoid": { "operationId": "GetIamLocalUserPasswordByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/LocalUserPasswords/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "iam" ], "summary": "Update a 'iam.LocalUserPassword' resource.", "operationId": "UpdateIamLocalUserPassword", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Global System Privileges", "PRIVSET.Global Write Privileges", "UPDATE.iam.LocalUserPassword" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.LocalUserPassword' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.LocalUserPassword" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.LocalUserPassword' resource was modified as requested. The 'iam.LocalUserPassword' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.LocalUserPassword" } } }, "links": { "GetIamLocalUserPasswordByMoid": { "operationId": "GetIamLocalUserPasswordByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/LocalUserPasswords/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "iam" ], "summary": "Update a 'iam.LocalUserPassword' resource.", "operationId": "PatchIamLocalUserPassword", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Global System Privileges", "PRIVSET.Global Write Privileges", "UPDATE.iam.LocalUserPassword" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.LocalUserPassword' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.LocalUserPassword" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.LocalUserPassword' resource was patched as requested. The 'iam.LocalUserPassword' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.LocalUserPassword" } } }, "links": { "GetIamLocalUserPasswordByMoid": { "operationId": "GetIamLocalUserPasswordByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/LocalUserPasswords/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/LocalUserPasswordPolicies": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.LocalUserPasswordPolicy' resource.", "operationId": "GetIamLocalUserPasswordPolicyList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure Local Users Password Policy", "PRIVSET.Manage Access and Permissions", "PRIVSET.View Access and Permissions", "READ.iam.LocalUserPasswordPolicy", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iam.LocalUserPasswordPolicy' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.LocalUserPasswordPolicy.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/LocalUserPasswordPolicies/{Moid}": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.LocalUserPasswordPolicy' resource.", "operationId": "GetIamLocalUserPasswordPolicyByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure Local Users Password Policy", "PRIVSET.Manage Access and Permissions", "PRIVSET.View Access and Permissions", "READ.iam.LocalUserPasswordPolicy", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iam.LocalUserPasswordPolicy' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.LocalUserPasswordPolicy" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetIamLocalUserPasswordPolicyByMoid": { "operationId": "GetIamLocalUserPasswordPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/LocalUserPasswordPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "iam" ], "summary": "Update a 'iam.LocalUserPasswordPolicy' resource.", "operationId": "UpdateIamLocalUserPasswordPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure Local Users Password Policy", "PRIVSET.Manage Access and Permissions", "ROLE.Account Administrator", "UPDATE.iam.LocalUserPasswordPolicy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.LocalUserPasswordPolicy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.LocalUserPasswordPolicy" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.LocalUserPasswordPolicy' resource was modified as requested. The 'iam.LocalUserPasswordPolicy' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.LocalUserPasswordPolicy" } } }, "links": { "GetIamLocalUserPasswordPolicyByMoid": { "operationId": "GetIamLocalUserPasswordPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/LocalUserPasswordPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "iam" ], "summary": "Update a 'iam.LocalUserPasswordPolicy' resource.", "operationId": "PatchIamLocalUserPasswordPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure Local Users Password Policy", "PRIVSET.Manage Access and Permissions", "ROLE.Account Administrator", "UPDATE.iam.LocalUserPasswordPolicy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.LocalUserPasswordPolicy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.LocalUserPasswordPolicy" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.LocalUserPasswordPolicy' resource was patched as requested. The 'iam.LocalUserPasswordPolicy' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.LocalUserPasswordPolicy" } } }, "links": { "GetIamLocalUserPasswordPolicyByMoid": { "operationId": "GetIamLocalUserPasswordPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/LocalUserPasswordPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/OAuthTokens": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.OAuthToken' resource.", "operationId": "GetIamOAuthTokenList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Delete OAuth 2.0 tokens", "PRIVSET.Manage Auth Tokens", "PRIVSET.Read-Only", "READ.iam.OAuthToken", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iam.OAuthToken' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.OAuthToken.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/OAuthTokens/{Moid}": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.OAuthToken' resource.", "operationId": "GetIamOAuthTokenByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Delete OAuth 2.0 tokens", "PRIVSET.Manage Auth Tokens", "PRIVSET.Read-Only", "READ.iam.OAuthToken", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iam.OAuthToken' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.OAuthToken" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetIamOAuthTokenByMoid": { "operationId": "GetIamOAuthTokenByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/OAuthTokens/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "iam" ], "summary": "Delete a 'iam.OAuthToken' resource.", "operationId": "DeleteIamOAuthToken", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.iam.OAuthToken", "PRIVSET.Account Administrator", "PRIVSET.Delete OAuth 2.0 tokens", "PRIVSET.Manage Auth Tokens", "PRIVSET.Read-Only", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/PasswordHistorySettingCollections": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.PasswordHistorySettingCollection' resource.", "operationId": "GetIamPasswordHistorySettingCollectionList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.View Server Profiles", "READ.iam.PasswordHistorySettingCollection", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iam.PasswordHistorySettingCollection' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.PasswordHistorySettingCollection.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/PasswordHistorySettingCollections/{Moid}": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.PasswordHistorySettingCollection' resource.", "operationId": "GetIamPasswordHistorySettingCollectionByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.View Server Profiles", "READ.iam.PasswordHistorySettingCollection", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iam.PasswordHistorySettingCollection' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.PasswordHistorySettingCollection" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetIamPasswordHistorySettingCollectionByMoid": { "operationId": "GetIamPasswordHistorySettingCollectionByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/PasswordHistorySettingCollections/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/Permissions": { "post": { "tags": [ "iam" ], "x-intersight-type": "SaaS", "summary": "Create a 'iam.Permission' resource.", "operationId": "CreateIamPermission", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.iam.Permission", "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'iam.Permission' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.Permission" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.Permission' resource was created as requested. The 'iam.Permission' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.Permission" } } }, "links": { "GetIamPermissionByMoid": { "operationId": "GetIamPermissionByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/Permissions/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "get": { "tags": [ "iam" ], "x-intersight-type": "SaaS", "summary": "Read a 'iam.Permission' resource.", "operationId": "GetIamPermissionList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "PRIVSET.View Access and Permissions", "READ.iam.Permission", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iam.Permission' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.Permission.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/Permissions/{Moid}": { "post": { "tags": [ "iam" ], "x-intersight-type": "SaaS", "summary": "Update a 'iam.Permission' resource.", "operationId": "UpdateIamPermission", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "ROLE.Account Administrator", "UPDATE.iam.Permission" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.Permission' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.Permission" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.Permission' resource was modified as requested. The 'iam.Permission' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.Permission" } } }, "links": { "GetIamPermissionByMoid": { "operationId": "GetIamPermissionByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/Permissions/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "iam" ], "x-intersight-type": "SaaS", "summary": "Update a 'iam.Permission' resource.", "operationId": "PatchIamPermission", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "ROLE.Account Administrator", "UPDATE.iam.Permission" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.Permission' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.Permission" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.Permission' resource was patched as requested. The 'iam.Permission' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.Permission" } } }, "links": { "GetIamPermissionByMoid": { "operationId": "GetIamPermissionByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/Permissions/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "iam" ], "x-intersight-type": "SaaS", "summary": "Delete a 'iam.Permission' resource.", "operationId": "DeleteIamPermission", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.iam.Permission", "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "get": { "tags": [ "iam" ], "x-intersight-type": "SaaS", "summary": "Read a 'iam.Permission' resource.", "operationId": "GetIamPermissionByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "PRIVSET.View Access and Permissions", "READ.iam.Permission", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iam.Permission' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.Permission" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetIamPermissionByMoid": { "operationId": "GetIamPermissionByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/Permissions/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/PrivateKeySpecs": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.PrivateKeySpec' resource.", "operationId": "GetIamPrivateKeySpecList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-only SSL Certificates", "READ.iam.PrivateKeySpec", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iam.PrivateKeySpec' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.PrivateKeySpec.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "iam" ], "summary": "Create a 'iam.PrivateKeySpec' resource.", "operationId": "CreateIamPrivateKeySpec", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.iam.PrivateKeySpec", "PRIVSET.Account Administrator", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'iam.PrivateKeySpec' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.PrivateKeySpec" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.PrivateKeySpec' resource was created as requested. The 'iam.PrivateKeySpec' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.PrivateKeySpec" } } }, "links": { "GetIamPrivateKeySpecByMoid": { "operationId": "GetIamPrivateKeySpecByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/PrivateKeySpecs/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/PrivateKeySpecs/{Moid}": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.PrivateKeySpec' resource.", "operationId": "GetIamPrivateKeySpecByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-only SSL Certificates", "READ.iam.PrivateKeySpec", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iam.PrivateKeySpec' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.PrivateKeySpec" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetIamPrivateKeySpecByMoid": { "operationId": "GetIamPrivateKeySpecByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/PrivateKeySpecs/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "iam" ], "summary": "Update a 'iam.PrivateKeySpec' resource.", "operationId": "UpdateIamPrivateKeySpec", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.iam.PrivateKeySpec" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.PrivateKeySpec' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.PrivateKeySpec" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.PrivateKeySpec' resource was modified as requested. The 'iam.PrivateKeySpec' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.PrivateKeySpec" } } }, "links": { "GetIamPrivateKeySpecByMoid": { "operationId": "GetIamPrivateKeySpecByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/PrivateKeySpecs/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "iam" ], "summary": "Update a 'iam.PrivateKeySpec' resource.", "operationId": "PatchIamPrivateKeySpec", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.iam.PrivateKeySpec" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.PrivateKeySpec' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.PrivateKeySpec" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.PrivateKeySpec' resource was patched as requested. The 'iam.PrivateKeySpec' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.PrivateKeySpec" } } }, "links": { "GetIamPrivateKeySpecByMoid": { "operationId": "GetIamPrivateKeySpecByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/PrivateKeySpecs/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "iam" ], "summary": "Delete a 'iam.PrivateKeySpec' resource.", "operationId": "DeleteIamPrivateKeySpec", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.iam.PrivateKeySpec", "PRIVSET.Account Administrator", "PRIVSET.Delete CSR", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/Privileges": { "get": { "tags": [ "iam" ], "x-intersight-type": "SaaS", "summary": "Read a 'iam.Privilege' resource.", "operationId": "GetIamPrivilegeList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "PRIVSET.View Access and Permissions", "READ.iam.Privilege", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iam.Privilege' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.Privilege.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/Privileges/{Moid}": { "get": { "tags": [ "iam" ], "x-intersight-type": "SaaS", "summary": "Read a 'iam.Privilege' resource.", "operationId": "GetIamPrivilegeByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "PRIVSET.View Access and Permissions", "READ.iam.Privilege", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iam.Privilege' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.Privilege" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetIamPrivilegeByMoid": { "operationId": "GetIamPrivilegeByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/Privileges/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/PrivilegeSets": { "get": { "tags": [ "iam" ], "x-intersight-type": "SaaS", "summary": "Read a 'iam.PrivilegeSet' resource.", "operationId": "GetIamPrivilegeSetList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "PRIVSET.User Access Administrator", "PRIVSET.View Access and Permissions", "READ.iam.PrivilegeSet", "ROLE.Account Administrator", "ROLE.User Access Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iam.PrivilegeSet' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.PrivilegeSet.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "iam" ], "x-intersight-type": "SaaS", "summary": "Create a 'iam.PrivilegeSet' resource.", "operationId": "CreateIamPrivilegeSet", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.iam.PrivilegeSet", "PRIVSET.Account Administrator", "PRIVSET.User Access Administrator", "ROLE.Account Administrator", "ROLE.User Access Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'iam.PrivilegeSet' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.PrivilegeSet" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.PrivilegeSet' resource was created as requested. The 'iam.PrivilegeSet' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.PrivilegeSet" } } }, "links": { "GetIamPrivilegeSetByMoid": { "operationId": "GetIamPrivilegeSetByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/PrivilegeSets/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/PrivilegeSets/{Moid}": { "get": { "tags": [ "iam" ], "x-intersight-type": "SaaS", "summary": "Read a 'iam.PrivilegeSet' resource.", "operationId": "GetIamPrivilegeSetByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "PRIVSET.User Access Administrator", "PRIVSET.View Access and Permissions", "READ.iam.PrivilegeSet", "ROLE.Account Administrator", "ROLE.User Access Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iam.PrivilegeSet' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.PrivilegeSet" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetIamPrivilegeSetByMoid": { "operationId": "GetIamPrivilegeSetByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/PrivilegeSets/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "iam" ], "x-intersight-type": "SaaS", "summary": "Update a 'iam.PrivilegeSet' resource.", "operationId": "UpdateIamPrivilegeSet", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.User Access Administrator", "ROLE.Account Administrator", "ROLE.User Access Administrator", "UPDATE.iam.PrivilegeSet" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.PrivilegeSet' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.PrivilegeSet" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.PrivilegeSet' resource was modified as requested. The 'iam.PrivilegeSet' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.PrivilegeSet" } } }, "links": { "GetIamPrivilegeSetByMoid": { "operationId": "GetIamPrivilegeSetByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/PrivilegeSets/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "iam" ], "x-intersight-type": "SaaS", "summary": "Update a 'iam.PrivilegeSet' resource.", "operationId": "PatchIamPrivilegeSet", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.User Access Administrator", "ROLE.Account Administrator", "ROLE.User Access Administrator", "UPDATE.iam.PrivilegeSet" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.PrivilegeSet' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.PrivilegeSet" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.PrivilegeSet' resource was patched as requested. The 'iam.PrivilegeSet' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.PrivilegeSet" } } }, "links": { "GetIamPrivilegeSetByMoid": { "operationId": "GetIamPrivilegeSetByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/PrivilegeSets/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "iam" ], "x-intersight-type": "SaaS", "summary": "Delete a 'iam.PrivilegeSet' resource.", "operationId": "DeleteIamPrivilegeSet", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.iam.PrivilegeSet", "PRIVSET.Account Administrator", "PRIVSET.User Access Administrator", "ROLE.Account Administrator", "ROLE.User Access Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/PrivilegeSetMetaInfos": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.PrivilegeSetMetaInfo' resource.", "operationId": "GetIamPrivilegeSetMetaInfoList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "PRIVSET.View Access and Permissions", "READ.iam.PrivilegeSetMetaInfo", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iam.PrivilegeSetMetaInfo' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.PrivilegeSetMetaInfo.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "iam" ], "summary": "Create a 'iam.PrivilegeSetMetaInfo' resource.", "operationId": "CreateIamPrivilegeSetMetaInfo", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.iam.PrivilegeSetMetaInfo", "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'iam.PrivilegeSetMetaInfo' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.PrivilegeSetMetaInfo" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.PrivilegeSetMetaInfo' resource was created as requested. The 'iam.PrivilegeSetMetaInfo' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.PrivilegeSetMetaInfo" } } }, "links": { "GetIamPrivilegeSetMetaInfoByMoid": { "operationId": "GetIamPrivilegeSetMetaInfoByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/PrivilegeSetMetaInfos/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/PrivilegeSetMetaInfos/{Moid}": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.PrivilegeSetMetaInfo' resource.", "operationId": "GetIamPrivilegeSetMetaInfoByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "PRIVSET.View Access and Permissions", "READ.iam.PrivilegeSetMetaInfo", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iam.PrivilegeSetMetaInfo' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.PrivilegeSetMetaInfo" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetIamPrivilegeSetMetaInfoByMoid": { "operationId": "GetIamPrivilegeSetMetaInfoByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/PrivilegeSetMetaInfos/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/Qualifiers": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.Qualifier' resource.", "operationId": "GetIamQualifierList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "PRIVSET.View Access and Permissions", "READ.iam.Qualifier", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iam.Qualifier' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.Qualifier.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "iam" ], "summary": "Create a 'iam.Qualifier' resource.", "operationId": "CreateIamQualifier", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.iam.Qualifier", "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'iam.Qualifier' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.Qualifier" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.Qualifier' resource was created as requested. The 'iam.Qualifier' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.Qualifier" } } }, "links": { "GetIamQualifierByMoid": { "operationId": "GetIamQualifierByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/Qualifiers/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/Qualifiers/{Moid}": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.Qualifier' resource.", "operationId": "GetIamQualifierByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "PRIVSET.View Access and Permissions", "READ.iam.Qualifier", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iam.Qualifier' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.Qualifier" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetIamQualifierByMoid": { "operationId": "GetIamQualifierByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/Qualifiers/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "iam" ], "summary": "Update a 'iam.Qualifier' resource.", "operationId": "UpdateIamQualifier", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "ROLE.Account Administrator", "UPDATE.iam.Qualifier" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.Qualifier' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.Qualifier" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.Qualifier' resource was modified as requested. The 'iam.Qualifier' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.Qualifier" } } }, "links": { "GetIamQualifierByMoid": { "operationId": "GetIamQualifierByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/Qualifiers/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "iam" ], "summary": "Update a 'iam.Qualifier' resource.", "operationId": "PatchIamQualifier", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "ROLE.Account Administrator", "UPDATE.iam.Qualifier" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.Qualifier' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.Qualifier" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.Qualifier' resource was patched as requested. The 'iam.Qualifier' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.Qualifier" } } }, "links": { "GetIamQualifierByMoid": { "operationId": "GetIamQualifierByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/Qualifiers/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "iam" ], "summary": "Delete a 'iam.Qualifier' resource.", "operationId": "DeleteIamQualifier", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.iam.Qualifier", "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/ResourceLimits": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.ResourceLimits' resource.", "operationId": "GetIamResourceLimitsList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure account details", "PRIVSET.Create OAuth 2.0 grant type applications", "PRIVSET.Delete API keys", "PRIVSET.Delete OAuth 2.0 grant type applications", "PRIVSET.Edit API keys", "PRIVSET.Edit OAuth 2.0 grant type applications", "PRIVSET.Enable and disable API keys", "PRIVSET.Enable and disable OAuth 2.0 grant type applications", "PRIVSET.Generate API keys", "PRIVSET.Manage API Keys", "PRIVSET.Manage Auth Tokens", "PRIVSET.Manage Sessions", "PRIVSET.Read-Only", "PRIVSET.View Access and Permissions", "PRIVSET.Workload Optimizer Administrator", "PRIVSET.Workload Optimizer Advisor", "PRIVSET.Workload Optimizer Automator", "PRIVSET.Workload Optimizer Deployer", "PRIVSET.Workload Optimizer Observer", "READ.iam.ResourceLimits", "ROLE.Account Administrator", "ROLE.Read-Only", "ROLE.Workload Optimizer Administrator", "ROLE.Workload Optimizer Advisor", "ROLE.Workload Optimizer Automator", "ROLE.Workload Optimizer Deployer", "ROLE.Workload Optimizer Observer" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iam.ResourceLimits' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.ResourceLimits.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/ResourceLimits/{Moid}": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.ResourceLimits' resource.", "operationId": "GetIamResourceLimitsByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure account details", "PRIVSET.Create OAuth 2.0 grant type applications", "PRIVSET.Delete API keys", "PRIVSET.Delete OAuth 2.0 grant type applications", "PRIVSET.Edit API keys", "PRIVSET.Edit OAuth 2.0 grant type applications", "PRIVSET.Enable and disable API keys", "PRIVSET.Enable and disable OAuth 2.0 grant type applications", "PRIVSET.Generate API keys", "PRIVSET.Manage API Keys", "PRIVSET.Manage Auth Tokens", "PRIVSET.Manage Sessions", "PRIVSET.Read-Only", "PRIVSET.View Access and Permissions", "PRIVSET.Workload Optimizer Administrator", "PRIVSET.Workload Optimizer Advisor", "PRIVSET.Workload Optimizer Automator", "PRIVSET.Workload Optimizer Deployer", "PRIVSET.Workload Optimizer Observer", "READ.iam.ResourceLimits", "ROLE.Account Administrator", "ROLE.Read-Only", "ROLE.Workload Optimizer Administrator", "ROLE.Workload Optimizer Advisor", "ROLE.Workload Optimizer Automator", "ROLE.Workload Optimizer Deployer", "ROLE.Workload Optimizer Observer" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iam.ResourceLimits' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.ResourceLimits" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetIamResourceLimitsByMoid": { "operationId": "GetIamResourceLimitsByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/ResourceLimits/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "iam" ], "summary": "Update a 'iam.ResourceLimits' resource.", "operationId": "UpdateIamResourceLimits", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure account details", "PRIVSET.Manage Access and Permissions", "ROLE.Account Administrator", "UPDATE.iam.ResourceLimits" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.ResourceLimits' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.ResourceLimits" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.ResourceLimits' resource was modified as requested. The 'iam.ResourceLimits' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.ResourceLimits" } } }, "links": { "GetIamResourceLimitsByMoid": { "operationId": "GetIamResourceLimitsByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/ResourceLimits/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "iam" ], "summary": "Update a 'iam.ResourceLimits' resource.", "operationId": "PatchIamResourceLimits", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure account details", "PRIVSET.Manage Access and Permissions", "ROLE.Account Administrator", "UPDATE.iam.ResourceLimits" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.ResourceLimits' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.ResourceLimits" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.ResourceLimits' resource was patched as requested. The 'iam.ResourceLimits' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.ResourceLimits" } } }, "links": { "GetIamResourceLimitsByMoid": { "operationId": "GetIamResourceLimitsByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/ResourceLimits/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/ResourcePermissions": { "get": { "tags": [ "iam" ], "x-intersight-type": "SaaS", "summary": "Read a 'iam.ResourcePermission' resource.", "operationId": "GetIamResourcePermissionList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "READ.iam.ResourcePermission" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iam.ResourcePermission' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.ResourcePermission.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/ResourcePermissions/{Moid}": { "get": { "tags": [ "iam" ], "x-intersight-type": "SaaS", "summary": "Read a 'iam.ResourcePermission' resource.", "operationId": "GetIamResourcePermissionByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "READ.iam.ResourcePermission" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iam.ResourcePermission' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.ResourcePermission" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetIamResourcePermissionByMoid": { "operationId": "GetIamResourcePermissionByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/ResourcePermissions/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/ResourceRoles": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.ResourceRoles' resource.", "operationId": "GetIamResourceRolesList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "PRIVSET.View Access and Permissions", "READ.iam.ResourceRoles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iam.ResourceRoles' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.ResourceRoles.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "iam" ], "summary": "Create a 'iam.ResourceRoles' resource.", "operationId": "CreateIamResourceRoles", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.iam.ResourceRoles", "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'iam.ResourceRoles' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.ResourceRoles" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.ResourceRoles' resource was created as requested. The 'iam.ResourceRoles' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.ResourceRoles" } } }, "links": { "GetIamResourceRolesByMoid": { "operationId": "GetIamResourceRolesByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/ResourceRoles/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/ResourceRoles/{Moid}": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.ResourceRoles' resource.", "operationId": "GetIamResourceRolesByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "PRIVSET.View Access and Permissions", "READ.iam.ResourceRoles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iam.ResourceRoles' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.ResourceRoles" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetIamResourceRolesByMoid": { "operationId": "GetIamResourceRolesByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/ResourceRoles/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "iam" ], "summary": "Update a 'iam.ResourceRoles' resource.", "operationId": "UpdateIamResourceRoles", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "ROLE.Account Administrator", "UPDATE.iam.ResourceRoles" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.ResourceRoles' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.ResourceRoles" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.ResourceRoles' resource was modified as requested. The 'iam.ResourceRoles' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.ResourceRoles" } } }, "links": { "GetIamResourceRolesByMoid": { "operationId": "GetIamResourceRolesByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/ResourceRoles/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "iam" ], "summary": "Update a 'iam.ResourceRoles' resource.", "operationId": "PatchIamResourceRoles", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "ROLE.Account Administrator", "UPDATE.iam.ResourceRoles" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.ResourceRoles' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.ResourceRoles" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.ResourceRoles' resource was patched as requested. The 'iam.ResourceRoles' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.ResourceRoles" } } }, "links": { "GetIamResourceRolesByMoid": { "operationId": "GetIamResourceRolesByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/ResourceRoles/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "iam" ], "summary": "Delete a 'iam.ResourceRoles' resource.", "operationId": "DeleteIamResourceRoles", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.iam.ResourceRoles", "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/Roles": { "get": { "tags": [ "iam" ], "x-intersight-type": "SaaS", "summary": "Read a 'iam.Role' resource.", "operationId": "GetIamRoleList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "PRIVSET.View Access and Permissions", "READ.iam.Role", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iam.Role' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.Role.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/Roles/{Moid}": { "get": { "tags": [ "iam" ], "x-intersight-type": "SaaS", "summary": "Read a 'iam.Role' resource.", "operationId": "GetIamRoleByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "PRIVSET.View Access and Permissions", "READ.iam.Role", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iam.Role' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.Role" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetIamRoleByMoid": { "operationId": "GetIamRoleByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/Roles/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/SecurityHolders": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.SecurityHolder' resource.", "operationId": "GetIamSecurityHolderList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "PRIVSET.View Access and Permissions", "READ.iam.SecurityHolder", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iam.SecurityHolder' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.SecurityHolder.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/SecurityHolders/{Moid}": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.SecurityHolder' resource.", "operationId": "GetIamSecurityHolderByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "PRIVSET.View Access and Permissions", "READ.iam.SecurityHolder", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iam.SecurityHolder' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.SecurityHolder" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetIamSecurityHolderByMoid": { "operationId": "GetIamSecurityHolderByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/SecurityHolders/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/ServiceProviders": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.ServiceProvider' resource.", "operationId": "GetIamServiceProviderList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Identity Providers", "READ.iam.ServiceProvider", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iam.ServiceProvider' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.ServiceProvider.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/ServiceProviders/{Moid}": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.ServiceProvider' resource.", "operationId": "GetIamServiceProviderByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Identity Providers", "READ.iam.ServiceProvider", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iam.ServiceProvider' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.ServiceProvider" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetIamServiceProviderByMoid": { "operationId": "GetIamServiceProviderByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/ServiceProviders/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/Sessions": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.Session' resource.", "operationId": "GetIamSessionList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Sessions", "PRIVSET.View Access and Permissions", "PRIVSET.View sessions", "READ.iam.Session", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iam.Session' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.Session.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/Sessions/{Moid}": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.Session' resource.", "operationId": "GetIamSessionByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Sessions", "PRIVSET.View Access and Permissions", "PRIVSET.View sessions", "READ.iam.Session", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iam.Session' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.Session" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetIamSessionByMoid": { "operationId": "GetIamSessionByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/Sessions/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "iam" ], "summary": "Delete a 'iam.Session' resource.", "operationId": "DeleteIamSession", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.iam.Session", "PRIVSET.Account Administrator", "PRIVSET.Manage Sessions", "PRIVSET.Terminate sessions", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/SessionLimits": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.SessionLimits' resource.", "operationId": "GetIamSessionLimitsList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure account details", "PRIVSET.Manage Sessions", "PRIVSET.View Access and Permissions", "PRIVSET.View sessions", "READ.iam.SessionLimits", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iam.SessionLimits' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.SessionLimits.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "iam" ], "summary": "Create a 'iam.SessionLimits' resource.", "operationId": "CreateIamSessionLimits", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.iam.SessionLimits", "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "PRIVSET.Manage Sessions", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'iam.SessionLimits' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.SessionLimits" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.SessionLimits' resource was created as requested. The 'iam.SessionLimits' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.SessionLimits" } } }, "links": { "GetIamSessionLimitsByMoid": { "operationId": "GetIamSessionLimitsByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/SessionLimits/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/SessionLimits/{Moid}": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.SessionLimits' resource.", "operationId": "GetIamSessionLimitsByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure account details", "PRIVSET.Manage Sessions", "PRIVSET.View Access and Permissions", "PRIVSET.View sessions", "READ.iam.SessionLimits", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iam.SessionLimits' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.SessionLimits" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetIamSessionLimitsByMoid": { "operationId": "GetIamSessionLimitsByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/SessionLimits/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "iam" ], "summary": "Update a 'iam.SessionLimits' resource.", "operationId": "UpdateIamSessionLimits", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure account details", "PRIVSET.Manage Access and Permissions", "PRIVSET.Manage Sessions", "ROLE.Account Administrator", "UPDATE.iam.SessionLimits" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.SessionLimits' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.SessionLimits" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.SessionLimits' resource was modified as requested. The 'iam.SessionLimits' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.SessionLimits" } } }, "links": { "GetIamSessionLimitsByMoid": { "operationId": "GetIamSessionLimitsByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/SessionLimits/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "iam" ], "summary": "Update a 'iam.SessionLimits' resource.", "operationId": "PatchIamSessionLimits", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure account details", "PRIVSET.Manage Access and Permissions", "PRIVSET.Manage Sessions", "ROLE.Account Administrator", "UPDATE.iam.SessionLimits" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.SessionLimits' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.SessionLimits" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.SessionLimits' resource was patched as requested. The 'iam.SessionLimits' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.SessionLimits" } } }, "links": { "GetIamSessionLimitsByMoid": { "operationId": "GetIamSessionLimitsByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/SessionLimits/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "iam" ], "summary": "Delete a 'iam.SessionLimits' resource.", "operationId": "DeleteIamSessionLimits", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.iam.SessionLimits", "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "PRIVSET.Manage Sessions", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/SharingRules": { "post": { "tags": [ "iam" ], "x-intersight-type": "SaaS", "summary": "Create a 'iam.SharingRule' resource.", "operationId": "CreateIamSharingRule", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.iam.SharingRule", "PRIVSET.Account Administrator", "PRIVSET.Manage Organizations", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'iam.SharingRule' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.SharingRule" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.SharingRule' resource was created as requested. The 'iam.SharingRule' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.SharingRule" } } }, "links": { "GetIamSharingRuleByMoid": { "operationId": "GetIamSharingRuleByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/SharingRules/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "get": { "tags": [ "iam" ], "x-intersight-type": "SaaS", "summary": "Read a 'iam.SharingRule' resource.", "operationId": "GetIamSharingRuleList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Organizations", "PRIVSET.Read-Only", "PRIVSET.View Organizations", "READ.iam.SharingRule", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iam.SharingRule' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.SharingRule.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/SharingRules/{Moid}": { "post": { "tags": [ "iam" ], "x-intersight-type": "SaaS", "summary": "Update a 'iam.SharingRule' resource.", "operationId": "UpdateIamSharingRule", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Organizations", "ROLE.Account Administrator", "UPDATE.iam.SharingRule" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.SharingRule' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.SharingRule" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.SharingRule' resource was modified as requested. The 'iam.SharingRule' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.SharingRule" } } }, "links": { "GetIamSharingRuleByMoid": { "operationId": "GetIamSharingRuleByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/SharingRules/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "iam" ], "x-intersight-type": "SaaS", "summary": "Update a 'iam.SharingRule' resource.", "operationId": "PatchIamSharingRule", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Organizations", "ROLE.Account Administrator", "UPDATE.iam.SharingRule" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.SharingRule' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.SharingRule" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.SharingRule' resource was patched as requested. The 'iam.SharingRule' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.SharingRule" } } }, "links": { "GetIamSharingRuleByMoid": { "operationId": "GetIamSharingRuleByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/SharingRules/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "iam" ], "x-intersight-type": "SaaS", "summary": "Delete a 'iam.SharingRule' resource.", "operationId": "DeleteIamSharingRule", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.iam.SharingRule", "PRIVSET.Account Administrator", "PRIVSET.Manage Organizations", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "get": { "tags": [ "iam" ], "x-intersight-type": "SaaS", "summary": "Read a 'iam.SharingRule' resource.", "operationId": "GetIamSharingRuleByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Organizations", "PRIVSET.Read-Only", "PRIVSET.View Organizations", "READ.iam.SharingRule", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iam.SharingRule' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.SharingRule" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetIamSharingRuleByMoid": { "operationId": "GetIamSharingRuleByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/SharingRules/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/Systems": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.System' resource.", "operationId": "GetIamSystemList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "READ.iam.System" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iam.System' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.System.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/Systems/{Moid}": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.System' resource.", "operationId": "GetIamSystemByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "READ.iam.System" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iam.System' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.System" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetIamSystemByMoid": { "operationId": "GetIamSystemByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/Systems/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/TestIdpConfigurations": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.TestIdpConfiguration' resource.", "operationId": "GetIamTestIdpConfigurationList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure LDAP servers", "PRIVSET.Delete LDAP servers", "PRIVSET.Edit LDAP servers", "PRIVSET.Manage Access and Permissions", "PRIVSET.View Access and Permissions", "READ.iam.TestIdpConfiguration", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iam.TestIdpConfiguration' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.TestIdpConfiguration.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/TestIdpConfigurations/{Moid}": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.TestIdpConfiguration' resource.", "operationId": "GetIamTestIdpConfigurationByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure LDAP servers", "PRIVSET.Delete LDAP servers", "PRIVSET.Edit LDAP servers", "PRIVSET.Manage Access and Permissions", "PRIVSET.View Access and Permissions", "READ.iam.TestIdpConfiguration", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iam.TestIdpConfiguration' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.TestIdpConfiguration" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetIamTestIdpConfigurationByMoid": { "operationId": "GetIamTestIdpConfigurationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/TestIdpConfigurations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "iam" ], "summary": "Update a 'iam.TestIdpConfiguration' resource.", "operationId": "UpdateIamTestIdpConfiguration", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "ROLE.Account Administrator", "UPDATE.iam.TestIdpConfiguration" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.TestIdpConfiguration' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.TestIdpConfiguration" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.TestIdpConfiguration' resource was modified as requested. The 'iam.TestIdpConfiguration' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.TestIdpConfiguration" } } }, "links": { "GetIamTestIdpConfigurationByMoid": { "operationId": "GetIamTestIdpConfigurationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/TestIdpConfigurations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "iam" ], "summary": "Update a 'iam.TestIdpConfiguration' resource.", "operationId": "PatchIamTestIdpConfiguration", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "ROLE.Account Administrator", "UPDATE.iam.TestIdpConfiguration" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.TestIdpConfiguration' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.TestIdpConfiguration" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.TestIdpConfiguration' resource was patched as requested. The 'iam.TestIdpConfiguration' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.TestIdpConfiguration" } } }, "links": { "GetIamTestIdpConfigurationByMoid": { "operationId": "GetIamTestIdpConfigurationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/TestIdpConfigurations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/TrustPoints": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.TrustPoint' resource.", "operationId": "GetIamTrustPointList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Add trusted certificates", "PRIVSET.Delete trusted certificates", "PRIVSET.Devices", "PRIVSET.Manage Access and Permissions", "PRIVSET.Manage Identity Providers", "PRIVSET.Read-only SMTP policies", "PRIVSET.View Access and Permissions", "READ.iam.TrustPoint", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iam.TrustPoint' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.TrustPoint.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "iam" ], "summary": "Create a 'iam.TrustPoint' resource.", "operationId": "CreateIamTrustPoint", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.iam.TrustPoint", "PRIVSET.Account Administrator", "PRIVSET.Add trusted certificates", "PRIVSET.Devices", "PRIVSET.Manage Access and Permissions", "PRIVSET.Manage Identity Providers", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'iam.TrustPoint' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.TrustPoint" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.TrustPoint' resource was created as requested. The 'iam.TrustPoint' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.TrustPoint" } } }, "links": { "GetIamTrustPointByMoid": { "operationId": "GetIamTrustPointByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/TrustPoints/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/TrustPoints/{Moid}": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.TrustPoint' resource.", "operationId": "GetIamTrustPointByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Add trusted certificates", "PRIVSET.Delete trusted certificates", "PRIVSET.Devices", "PRIVSET.Manage Access and Permissions", "PRIVSET.Manage Identity Providers", "PRIVSET.Read-only SMTP policies", "PRIVSET.View Access and Permissions", "READ.iam.TrustPoint", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iam.TrustPoint' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.TrustPoint" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetIamTrustPointByMoid": { "operationId": "GetIamTrustPointByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/TrustPoints/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "iam" ], "summary": "Delete a 'iam.TrustPoint' resource.", "operationId": "DeleteIamTrustPoint", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.iam.TrustPoint", "PRIVSET.Account Administrator", "PRIVSET.Delete trusted certificates", "PRIVSET.Devices", "PRIVSET.Manage Access and Permissions", "PRIVSET.Manage Identity Providers", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/Users": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.User' resource.", "operationId": "GetIamUserList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Add notification rule or webhook", "PRIVSET.Delete notification rule or webhook", "PRIVSET.Edit notification rule or webhook", "PRIVSET.Manage Access and Permissions", "PRIVSET.View Access and Permissions", "PRIVSET.View sessions", "READ.iam.User", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iam.User' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.User.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "iam" ], "summary": "Create a 'iam.User' resource.", "operationId": "CreateIamUser", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.iam.User", "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'iam.User' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.User" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.User' resource was created as requested. The 'iam.User' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.User" } } }, "links": { "GetIamUserByMoid": { "operationId": "GetIamUserByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/Users/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/Users/{Moid}": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.User' resource.", "operationId": "GetIamUserByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Add notification rule or webhook", "PRIVSET.Delete notification rule or webhook", "PRIVSET.Edit notification rule or webhook", "PRIVSET.Manage Access and Permissions", "PRIVSET.View Access and Permissions", "PRIVSET.View sessions", "READ.iam.User", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iam.User' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.User" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetIamUserByMoid": { "operationId": "GetIamUserByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/Users/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "iam" ], "summary": "Update a 'iam.User' resource.", "operationId": "UpdateIamUser", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "ROLE.Account Administrator", "UPDATE.iam.User" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.User' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.User" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.User' resource was modified as requested. The 'iam.User' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.User" } } }, "links": { "GetIamUserByMoid": { "operationId": "GetIamUserByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/Users/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "iam" ], "summary": "Update a 'iam.User' resource.", "operationId": "PatchIamUser", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "ROLE.Account Administrator", "UPDATE.iam.User" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.User' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.User" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.User' resource was patched as requested. The 'iam.User' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.User" } } }, "links": { "GetIamUserByMoid": { "operationId": "GetIamUserByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/Users/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "iam" ], "summary": "Delete a 'iam.User' resource.", "operationId": "DeleteIamUser", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.iam.User", "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/UserGroups": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.UserGroup' resource.", "operationId": "GetIamUserGroupList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "PRIVSET.View Access and Permissions", "READ.iam.UserGroup", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iam.UserGroup' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.UserGroup.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "iam" ], "summary": "Create a 'iam.UserGroup' resource.", "operationId": "CreateIamUserGroup", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.iam.UserGroup", "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'iam.UserGroup' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.UserGroup" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.UserGroup' resource was created as requested. The 'iam.UserGroup' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.UserGroup" } } }, "links": { "GetIamUserGroupByMoid": { "operationId": "GetIamUserGroupByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/UserGroups/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/UserGroups/{Moid}": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.UserGroup' resource.", "operationId": "GetIamUserGroupByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "PRIVSET.View Access and Permissions", "READ.iam.UserGroup", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iam.UserGroup' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.UserGroup" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetIamUserGroupByMoid": { "operationId": "GetIamUserGroupByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/UserGroups/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "iam" ], "summary": "Delete a 'iam.UserGroup' resource.", "operationId": "DeleteIamUserGroup", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.iam.UserGroup", "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "iam" ], "summary": "Update a 'iam.UserGroup' resource.", "operationId": "UpdateIamUserGroup", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "ROLE.Account Administrator", "UPDATE.iam.UserGroup" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.UserGroup' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.UserGroup" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.UserGroup' resource was modified as requested. The 'iam.UserGroup' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.UserGroup" } } }, "links": { "GetIamUserGroupByMoid": { "operationId": "GetIamUserGroupByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/UserGroups/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "iam" ], "summary": "Update a 'iam.UserGroup' resource.", "operationId": "PatchIamUserGroup", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "ROLE.Account Administrator", "UPDATE.iam.UserGroup" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.UserGroup' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.UserGroup" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.UserGroup' resource was patched as requested. The 'iam.UserGroup' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.UserGroup" } } }, "links": { "GetIamUserGroupByMoid": { "operationId": "GetIamUserGroupByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/UserGroups/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/UserPreferences": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.UserPreference' resource.", "operationId": "GetIamUserPreferenceList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Global Read Privileges", "PRIVSET.Global System Privileges", "READ.iam.UserPreference" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iam.UserPreference' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.UserPreference.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/UserPreferences/{Moid}": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.UserPreference' resource.", "operationId": "GetIamUserPreferenceByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Global Read Privileges", "PRIVSET.Global System Privileges", "READ.iam.UserPreference" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iam.UserPreference' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.UserPreference" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetIamUserPreferenceByMoid": { "operationId": "GetIamUserPreferenceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/UserPreferences/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "iam" ], "summary": "Update a 'iam.UserPreference' resource.", "operationId": "UpdateIamUserPreference", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Global System Privileges", "PRIVSET.Global Write Privileges", "UPDATE.iam.UserPreference" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.UserPreference' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.UserPreference" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.UserPreference' resource was modified as requested. The 'iam.UserPreference' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.UserPreference" } } }, "links": { "GetIamUserPreferenceByMoid": { "operationId": "GetIamUserPreferenceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/UserPreferences/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "iam" ], "summary": "Update a 'iam.UserPreference' resource.", "operationId": "PatchIamUserPreference", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Global System Privileges", "PRIVSET.Global Write Privileges", "UPDATE.iam.UserPreference" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.UserPreference' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.UserPreference" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.UserPreference' resource was patched as requested. The 'iam.UserPreference' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.UserPreference" } } }, "links": { "GetIamUserPreferenceByMoid": { "operationId": "GetIamUserPreferenceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/UserPreferences/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/UserQualifiers": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.UserQualifier' resource.", "operationId": "GetIamUserQualifierList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "PRIVSET.View Access and Permissions", "READ.iam.UserQualifier", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iam.UserQualifier' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.UserQualifier.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "iam" ], "summary": "Create a 'iam.UserQualifier' resource.", "operationId": "CreateIamUserQualifier", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.iam.UserQualifier", "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'iam.UserQualifier' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.UserQualifier" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.UserQualifier' resource was created as requested. The 'iam.UserQualifier' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.UserQualifier" } } }, "links": { "GetIamUserQualifierByMoid": { "operationId": "GetIamUserQualifierByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/UserQualifiers/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/UserQualifiers/{Moid}": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.UserQualifier' resource.", "operationId": "GetIamUserQualifierByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "PRIVSET.View Access and Permissions", "READ.iam.UserQualifier", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iam.UserQualifier' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.UserQualifier" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetIamUserQualifierByMoid": { "operationId": "GetIamUserQualifierByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/UserQualifiers/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "iam" ], "summary": "Update a 'iam.UserQualifier' resource.", "operationId": "UpdateIamUserQualifier", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "ROLE.Account Administrator", "UPDATE.iam.UserQualifier" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.UserQualifier' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.UserQualifier" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.UserQualifier' resource was modified as requested. The 'iam.UserQualifier' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.UserQualifier" } } }, "links": { "GetIamUserQualifierByMoid": { "operationId": "GetIamUserQualifierByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/UserQualifiers/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "iam" ], "summary": "Update a 'iam.UserQualifier' resource.", "operationId": "PatchIamUserQualifier", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "ROLE.Account Administrator", "UPDATE.iam.UserQualifier" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.UserQualifier' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.UserQualifier" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.UserQualifier' resource was patched as requested. The 'iam.UserQualifier' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.UserQualifier" } } }, "links": { "GetIamUserQualifierByMoid": { "operationId": "GetIamUserQualifierByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/UserQualifiers/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "iam" ], "summary": "Delete a 'iam.UserQualifier' resource.", "operationId": "DeleteIamUserQualifier", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.iam.UserQualifier", "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/UserSettings": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.UserSetting' resource.", "operationId": "GetIamUserSettingList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Global Read Privileges", "PRIVSET.Global System Privileges", "READ.iam.UserSetting" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iam.UserSetting' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.UserSetting.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "iam" ], "summary": "Create a 'iam.UserSetting' resource.", "operationId": "CreateIamUserSetting", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.iam.UserSetting", "PRIVSET.Global System Privileges", "PRIVSET.Global Write Privileges" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'iam.UserSetting' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.UserSetting" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.UserSetting' resource was created as requested. The 'iam.UserSetting' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.UserSetting" } } }, "links": { "GetIamUserSettingByMoid": { "operationId": "GetIamUserSettingByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/UserSettings/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/UserSettings/{Moid}": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.UserSetting' resource.", "operationId": "GetIamUserSettingByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Global Read Privileges", "PRIVSET.Global System Privileges", "READ.iam.UserSetting" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iam.UserSetting' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.UserSetting" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetIamUserSettingByMoid": { "operationId": "GetIamUserSettingByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/UserSettings/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "iam" ], "summary": "Update a 'iam.UserSetting' resource.", "operationId": "UpdateIamUserSetting", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Global System Privileges", "PRIVSET.Global Write Privileges", "UPDATE.iam.UserSetting" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.UserSetting' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.UserSetting" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.UserSetting' resource was modified as requested. The 'iam.UserSetting' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.UserSetting" } } }, "links": { "GetIamUserSettingByMoid": { "operationId": "GetIamUserSettingByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/UserSettings/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "iam" ], "summary": "Update a 'iam.UserSetting' resource.", "operationId": "PatchIamUserSetting", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Global System Privileges", "PRIVSET.Global Write Privileges", "UPDATE.iam.UserSetting" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.UserSetting' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.UserSetting" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.UserSetting' resource was patched as requested. The 'iam.UserSetting' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.UserSetting" } } }, "links": { "GetIamUserSettingByMoid": { "operationId": "GetIamUserSettingByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/UserSettings/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/license/AccountLicenseData": { "get": { "tags": [ "license" ], "summary": "Read a 'license.AccountLicenseData' resource.", "operationId": "GetLicenseAccountLicenseDataList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Catalog User", "PRIVSET.Global Read Privileges", "PRIVSET.Read-Only", "PRIVSET.View Licensing Status", "READ.license.AccountLicenseData", "ROLE.Account Administrator", "ROLE.Catalog User", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'license.AccountLicenseData' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.AccountLicenseData.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/license/AccountLicenseData/{Moid}": { "get": { "tags": [ "license" ], "summary": "Read a 'license.AccountLicenseData' resource.", "operationId": "GetLicenseAccountLicenseDataByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Catalog User", "PRIVSET.Global Read Privileges", "PRIVSET.Read-Only", "PRIVSET.View Licensing Status", "READ.license.AccountLicenseData", "ROLE.Account Administrator", "ROLE.Catalog User", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'license.AccountLicenseData' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.AccountLicenseData" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetLicenseAccountLicenseDataByMoid": { "operationId": "GetLicenseAccountLicenseDataByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/license/AccountLicenseData/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "license" ], "summary": "Update a 'license.AccountLicenseData' resource.", "operationId": "UpdateLicenseAccountLicenseData", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage products", "ROLE.Account Administrator", "UPDATE.license.AccountLicenseData" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'license.AccountLicenseData' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.AccountLicenseData" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'license.AccountLicenseData' resource was modified as requested. The 'license.AccountLicenseData' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.AccountLicenseData" } } }, "links": { "GetLicenseAccountLicenseDataByMoid": { "operationId": "GetLicenseAccountLicenseDataByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/license/AccountLicenseData/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "license" ], "summary": "Update a 'license.AccountLicenseData' resource.", "operationId": "PatchLicenseAccountLicenseData", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage products", "ROLE.Account Administrator", "UPDATE.license.AccountLicenseData" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'license.AccountLicenseData' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.AccountLicenseData" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'license.AccountLicenseData' resource was patched as requested. The 'license.AccountLicenseData' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.AccountLicenseData" } } }, "links": { "GetLicenseAccountLicenseDataByMoid": { "operationId": "GetLicenseAccountLicenseDataByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/license/AccountLicenseData/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/license/CustomerOps": { "get": { "tags": [ "license" ], "summary": "Read a 'license.CustomerOp' resource.", "operationId": "GetLicenseCustomerOpList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Read-only licensing", "PRIVSET.View Licensing Status", "READ.license.CustomerOp", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'license.CustomerOp' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.CustomerOp.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/license/CustomerOps/{Moid}": { "get": { "tags": [ "license" ], "summary": "Read a 'license.CustomerOp' resource.", "operationId": "GetLicenseCustomerOpByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Read-only licensing", "PRIVSET.View Licensing Status", "READ.license.CustomerOp", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'license.CustomerOp' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.CustomerOp" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetLicenseCustomerOpByMoid": { "operationId": "GetLicenseCustomerOpByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/license/CustomerOps/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "license" ], "summary": "Update a 'license.CustomerOp' resource.", "operationId": "UpdateLicenseCustomerOp", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage products", "ROLE.Account Administrator", "UPDATE.license.CustomerOp" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'license.CustomerOp' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.CustomerOp" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'license.CustomerOp' resource was modified as requested. The 'license.CustomerOp' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.CustomerOp" } } }, "links": { "GetLicenseCustomerOpByMoid": { "operationId": "GetLicenseCustomerOpByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/license/CustomerOps/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "license" ], "summary": "Update a 'license.CustomerOp' resource.", "operationId": "PatchLicenseCustomerOp", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage products", "ROLE.Account Administrator", "UPDATE.license.CustomerOp" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'license.CustomerOp' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.CustomerOp" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'license.CustomerOp' resource was patched as requested. The 'license.CustomerOp' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.CustomerOp" } } }, "links": { "GetLicenseCustomerOpByMoid": { "operationId": "GetLicenseCustomerOpByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/license/CustomerOps/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/license/ErpCustomerOps": { "get": { "tags": [ "license" ], "summary": "Read a 'license.ErpCustomerOp' resource.", "operationId": "GetLicenseErpCustomerOpList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Read-only licensing", "PRIVSET.View Licensing Status", "READ.license.ErpCustomerOp", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'license.ErpCustomerOp' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.ErpCustomerOp.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/license/ErpCustomerOps/{Moid}": { "get": { "tags": [ "license" ], "summary": "Read a 'license.ErpCustomerOp' resource.", "operationId": "GetLicenseErpCustomerOpByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Read-only licensing", "PRIVSET.View Licensing Status", "READ.license.ErpCustomerOp", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'license.ErpCustomerOp' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.ErpCustomerOp" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetLicenseErpCustomerOpByMoid": { "operationId": "GetLicenseErpCustomerOpByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/license/ErpCustomerOps/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "license" ], "summary": "Update a 'license.ErpCustomerOp' resource.", "operationId": "UpdateLicenseErpCustomerOp", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.license.ErpCustomerOp" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'license.ErpCustomerOp' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.ErpCustomerOp" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'license.ErpCustomerOp' resource was modified as requested. The 'license.ErpCustomerOp' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.ErpCustomerOp" } } }, "links": { "GetLicenseErpCustomerOpByMoid": { "operationId": "GetLicenseErpCustomerOpByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/license/ErpCustomerOps/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "license" ], "summary": "Update a 'license.ErpCustomerOp' resource.", "operationId": "PatchLicenseErpCustomerOp", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.license.ErpCustomerOp" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'license.ErpCustomerOp' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.ErpCustomerOp" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'license.ErpCustomerOp' resource was patched as requested. The 'license.ErpCustomerOp' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.ErpCustomerOp" } } }, "links": { "GetLicenseErpCustomerOpByMoid": { "operationId": "GetLicenseErpCustomerOpByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/license/ErpCustomerOps/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/license/ErpLicenseCounts": { "get": { "tags": [ "license" ], "summary": "Read a 'license.ErpLicenseCount' resource.", "operationId": "GetLicenseErpLicenseCountList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Read-only licensing", "PRIVSET.View Licensing Status", "READ.license.ErpLicenseCount", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'license.ErpLicenseCount' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.ErpLicenseCount.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "license" ], "summary": "Create a 'license.ErpLicenseCount' resource.", "operationId": "CreateLicenseErpLicenseCount", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.license.ErpLicenseCount" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'license.ErpLicenseCount' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.ErpLicenseCount" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'license.ErpLicenseCount' resource was created as requested. The 'license.ErpLicenseCount' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.ErpLicenseCount" } } }, "links": { "GetLicenseErpLicenseCountByMoid": { "operationId": "GetLicenseErpLicenseCountByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/license/ErpLicenseCounts/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/license/ErpLicenseCounts/{Moid}": { "get": { "tags": [ "license" ], "summary": "Read a 'license.ErpLicenseCount' resource.", "operationId": "GetLicenseErpLicenseCountByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Read-only licensing", "PRIVSET.View Licensing Status", "READ.license.ErpLicenseCount", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'license.ErpLicenseCount' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.ErpLicenseCount" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetLicenseErpLicenseCountByMoid": { "operationId": "GetLicenseErpLicenseCountByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/license/ErpLicenseCounts/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/license/IksCustomerOps": { "get": { "tags": [ "license" ], "summary": "Read a 'license.IksCustomerOp' resource.", "operationId": "GetLicenseIksCustomerOpList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Read-only licensing", "PRIVSET.View Licensing Status", "READ.license.IksCustomerOp", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'license.IksCustomerOp' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.IksCustomerOp.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/license/IksCustomerOps/{Moid}": { "get": { "tags": [ "license" ], "summary": "Read a 'license.IksCustomerOp' resource.", "operationId": "GetLicenseIksCustomerOpByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Read-only licensing", "PRIVSET.View Licensing Status", "READ.license.IksCustomerOp", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'license.IksCustomerOp' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.IksCustomerOp" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetLicenseIksCustomerOpByMoid": { "operationId": "GetLicenseIksCustomerOpByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/license/IksCustomerOps/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "license" ], "summary": "Update a 'license.IksCustomerOp' resource.", "operationId": "UpdateLicenseIksCustomerOp", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.license.IksCustomerOp" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'license.IksCustomerOp' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.IksCustomerOp" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'license.IksCustomerOp' resource was modified as requested. The 'license.IksCustomerOp' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.IksCustomerOp" } } }, "links": { "GetLicenseIksCustomerOpByMoid": { "operationId": "GetLicenseIksCustomerOpByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/license/IksCustomerOps/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "license" ], "summary": "Update a 'license.IksCustomerOp' resource.", "operationId": "PatchLicenseIksCustomerOp", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.license.IksCustomerOp" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'license.IksCustomerOp' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.IksCustomerOp" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'license.IksCustomerOp' resource was patched as requested. The 'license.IksCustomerOp' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.IksCustomerOp" } } }, "links": { "GetLicenseIksCustomerOpByMoid": { "operationId": "GetLicenseIksCustomerOpByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/license/IksCustomerOps/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/license/IksLicenseCounts": { "get": { "tags": [ "license" ], "summary": "Read a 'license.IksLicenseCount' resource.", "operationId": "GetLicenseIksLicenseCountList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Read-only licensing", "PRIVSET.View Licensing Status", "READ.license.IksLicenseCount", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'license.IksLicenseCount' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.IksLicenseCount.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "license" ], "summary": "Create a 'license.IksLicenseCount' resource.", "operationId": "CreateLicenseIksLicenseCount", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.license.IksLicenseCount" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'license.IksLicenseCount' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.IksLicenseCount" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'license.IksLicenseCount' resource was created as requested. The 'license.IksLicenseCount' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.IksLicenseCount" } } }, "links": { "GetLicenseIksLicenseCountByMoid": { "operationId": "GetLicenseIksLicenseCountByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/license/IksLicenseCounts/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/license/IksLicenseCounts/{Moid}": { "get": { "tags": [ "license" ], "summary": "Read a 'license.IksLicenseCount' resource.", "operationId": "GetLicenseIksLicenseCountByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Read-only licensing", "PRIVSET.View Licensing Status", "READ.license.IksLicenseCount", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'license.IksLicenseCount' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.IksLicenseCount" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetLicenseIksLicenseCountByMoid": { "operationId": "GetLicenseIksLicenseCountByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/license/IksLicenseCounts/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "license" ], "summary": "Update a 'license.IksLicenseCount' resource.", "operationId": "UpdateLicenseIksLicenseCount", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.license.IksLicenseCount" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'license.IksLicenseCount' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.IksLicenseCount" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'license.IksLicenseCount' resource was modified as requested. The 'license.IksLicenseCount' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.IksLicenseCount" } } }, "links": { "GetLicenseIksLicenseCountByMoid": { "operationId": "GetLicenseIksLicenseCountByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/license/IksLicenseCounts/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "license" ], "summary": "Update a 'license.IksLicenseCount' resource.", "operationId": "PatchLicenseIksLicenseCount", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.license.IksLicenseCount" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'license.IksLicenseCount' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.IksLicenseCount" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'license.IksLicenseCount' resource was patched as requested. The 'license.IksLicenseCount' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.IksLicenseCount" } } }, "links": { "GetLicenseIksLicenseCountByMoid": { "operationId": "GetLicenseIksLicenseCountByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/license/IksLicenseCounts/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/license/IncCustomerOps": { "get": { "tags": [ "license" ], "summary": "Read a 'license.IncCustomerOp' resource.", "operationId": "GetLicenseIncCustomerOpList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Read-only licensing", "PRIVSET.View Licensing Status", "READ.license.IncCustomerOp", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'license.IncCustomerOp' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.IncCustomerOp.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/license/IncCustomerOps/{Moid}": { "get": { "tags": [ "license" ], "summary": "Read a 'license.IncCustomerOp' resource.", "operationId": "GetLicenseIncCustomerOpByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Read-only licensing", "PRIVSET.View Licensing Status", "READ.license.IncCustomerOp", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'license.IncCustomerOp' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.IncCustomerOp" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetLicenseIncCustomerOpByMoid": { "operationId": "GetLicenseIncCustomerOpByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/license/IncCustomerOps/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "license" ], "summary": "Update a 'license.IncCustomerOp' resource.", "operationId": "UpdateLicenseIncCustomerOp", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.license.IncCustomerOp" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'license.IncCustomerOp' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.IncCustomerOp" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'license.IncCustomerOp' resource was modified as requested. The 'license.IncCustomerOp' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.IncCustomerOp" } } }, "links": { "GetLicenseIncCustomerOpByMoid": { "operationId": "GetLicenseIncCustomerOpByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/license/IncCustomerOps/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "license" ], "summary": "Update a 'license.IncCustomerOp' resource.", "operationId": "PatchLicenseIncCustomerOp", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.license.IncCustomerOp" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'license.IncCustomerOp' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.IncCustomerOp" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'license.IncCustomerOp' resource was patched as requested. The 'license.IncCustomerOp' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.IncCustomerOp" } } }, "links": { "GetLicenseIncCustomerOpByMoid": { "operationId": "GetLicenseIncCustomerOpByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/license/IncCustomerOps/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/license/IncLicenseCounts": { "get": { "tags": [ "license" ], "summary": "Read a 'license.IncLicenseCount' resource.", "operationId": "GetLicenseIncLicenseCountList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Read-only licensing", "PRIVSET.View Licensing Status", "READ.license.IncLicenseCount", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'license.IncLicenseCount' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.IncLicenseCount.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "license" ], "summary": "Create a 'license.IncLicenseCount' resource.", "operationId": "CreateLicenseIncLicenseCount", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.license.IncLicenseCount" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'license.IncLicenseCount' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.IncLicenseCount" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'license.IncLicenseCount' resource was created as requested. The 'license.IncLicenseCount' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.IncLicenseCount" } } }, "links": { "GetLicenseIncLicenseCountByMoid": { "operationId": "GetLicenseIncLicenseCountByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/license/IncLicenseCounts/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/license/IncLicenseCounts/{Moid}": { "get": { "tags": [ "license" ], "summary": "Read a 'license.IncLicenseCount' resource.", "operationId": "GetLicenseIncLicenseCountByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Read-only licensing", "PRIVSET.View Licensing Status", "READ.license.IncLicenseCount", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'license.IncLicenseCount' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.IncLicenseCount" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetLicenseIncLicenseCountByMoid": { "operationId": "GetLicenseIncLicenseCountByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/license/IncLicenseCounts/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "license" ], "summary": "Update a 'license.IncLicenseCount' resource.", "operationId": "UpdateLicenseIncLicenseCount", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.license.IncLicenseCount" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'license.IncLicenseCount' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.IncLicenseCount" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'license.IncLicenseCount' resource was modified as requested. The 'license.IncLicenseCount' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.IncLicenseCount" } } }, "links": { "GetLicenseIncLicenseCountByMoid": { "operationId": "GetLicenseIncLicenseCountByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/license/IncLicenseCounts/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "license" ], "summary": "Update a 'license.IncLicenseCount' resource.", "operationId": "PatchLicenseIncLicenseCount", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.license.IncLicenseCount" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'license.IncLicenseCount' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.IncLicenseCount" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'license.IncLicenseCount' resource was patched as requested. The 'license.IncLicenseCount' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.IncLicenseCount" } } }, "links": { "GetLicenseIncLicenseCountByMoid": { "operationId": "GetLicenseIncLicenseCountByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/license/IncLicenseCounts/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/license/IwoCustomerOps": { "get": { "tags": [ "license" ], "summary": "Read a 'license.IwoCustomerOp' resource.", "operationId": "GetLicenseIwoCustomerOpList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Read-only licensing", "PRIVSET.View Licensing Status", "READ.license.IwoCustomerOp", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'license.IwoCustomerOp' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.IwoCustomerOp.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/license/IwoCustomerOps/{Moid}": { "get": { "tags": [ "license" ], "summary": "Read a 'license.IwoCustomerOp' resource.", "operationId": "GetLicenseIwoCustomerOpByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Read-only licensing", "PRIVSET.View Licensing Status", "READ.license.IwoCustomerOp", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'license.IwoCustomerOp' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.IwoCustomerOp" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetLicenseIwoCustomerOpByMoid": { "operationId": "GetLicenseIwoCustomerOpByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/license/IwoCustomerOps/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "license" ], "summary": "Update a 'license.IwoCustomerOp' resource.", "operationId": "UpdateLicenseIwoCustomerOp", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage products", "ROLE.Account Administrator", "UPDATE.license.IwoCustomerOp" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'license.IwoCustomerOp' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.IwoCustomerOp" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'license.IwoCustomerOp' resource was modified as requested. The 'license.IwoCustomerOp' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.IwoCustomerOp" } } }, "links": { "GetLicenseIwoCustomerOpByMoid": { "operationId": "GetLicenseIwoCustomerOpByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/license/IwoCustomerOps/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "license" ], "summary": "Update a 'license.IwoCustomerOp' resource.", "operationId": "PatchLicenseIwoCustomerOp", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage products", "ROLE.Account Administrator", "UPDATE.license.IwoCustomerOp" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'license.IwoCustomerOp' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.IwoCustomerOp" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'license.IwoCustomerOp' resource was patched as requested. The 'license.IwoCustomerOp' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.IwoCustomerOp" } } }, "links": { "GetLicenseIwoCustomerOpByMoid": { "operationId": "GetLicenseIwoCustomerOpByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/license/IwoCustomerOps/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/license/IwoLicenseCounts": { "get": { "tags": [ "license" ], "summary": "Read a 'license.IwoLicenseCount' resource.", "operationId": "GetLicenseIwoLicenseCountList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Read-only licensing", "PRIVSET.View Licensing Status", "READ.license.IwoLicenseCount", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'license.IwoLicenseCount' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.IwoLicenseCount.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "license" ], "summary": "Create a 'license.IwoLicenseCount' resource.", "operationId": "CreateLicenseIwoLicenseCount", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.license.IwoLicenseCount" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'license.IwoLicenseCount' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.IwoLicenseCount" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'license.IwoLicenseCount' resource was created as requested. The 'license.IwoLicenseCount' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.IwoLicenseCount" } } }, "links": { "GetLicenseIwoLicenseCountByMoid": { "operationId": "GetLicenseIwoLicenseCountByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/license/IwoLicenseCounts/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/license/IwoLicenseCounts/{Moid}": { "get": { "tags": [ "license" ], "summary": "Read a 'license.IwoLicenseCount' resource.", "operationId": "GetLicenseIwoLicenseCountByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Read-only licensing", "PRIVSET.View Licensing Status", "READ.license.IwoLicenseCount", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'license.IwoLicenseCount' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.IwoLicenseCount" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetLicenseIwoLicenseCountByMoid": { "operationId": "GetLicenseIwoLicenseCountByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/license/IwoLicenseCounts/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "license" ], "summary": "Update a 'license.IwoLicenseCount' resource.", "operationId": "UpdateLicenseIwoLicenseCount", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.license.IwoLicenseCount" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'license.IwoLicenseCount' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.IwoLicenseCount" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'license.IwoLicenseCount' resource was modified as requested. The 'license.IwoLicenseCount' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.IwoLicenseCount" } } }, "links": { "GetLicenseIwoLicenseCountByMoid": { "operationId": "GetLicenseIwoLicenseCountByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/license/IwoLicenseCounts/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "license" ], "summary": "Update a 'license.IwoLicenseCount' resource.", "operationId": "PatchLicenseIwoLicenseCount", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.license.IwoLicenseCount" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'license.IwoLicenseCount' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.IwoLicenseCount" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'license.IwoLicenseCount' resource was patched as requested. The 'license.IwoLicenseCount' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.IwoLicenseCount" } } }, "links": { "GetLicenseIwoLicenseCountByMoid": { "operationId": "GetLicenseIwoLicenseCountByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/license/IwoLicenseCounts/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/license/LicenseInfos": { "get": { "tags": [ "license" ], "x-intersight-type": "SaaS", "summary": "Read a 'license.LicenseInfo' resource.", "operationId": "GetLicenseLicenseInfoList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Catalog User", "PRIVSET.Global Read Privileges", "PRIVSET.Read-Only", "PRIVSET.View Licensing Status", "READ.license.LicenseInfo", "ROLE.Account Administrator", "ROLE.Catalog User", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'license.LicenseInfo' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.LicenseInfo.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "license" ], "x-intersight-type": "SaaS", "summary": "Create a 'license.LicenseInfo' resource.", "operationId": "CreateLicenseLicenseInfo", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.license.LicenseInfo" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'license.LicenseInfo' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.LicenseInfo" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'license.LicenseInfo' resource was created as requested. The 'license.LicenseInfo' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.LicenseInfo" } } }, "links": { "GetLicenseLicenseInfoByMoid": { "operationId": "GetLicenseLicenseInfoByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/license/LicenseInfos/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/license/LicenseInfos/{Moid}": { "get": { "tags": [ "license" ], "x-intersight-type": "SaaS", "summary": "Read a 'license.LicenseInfo' resource.", "operationId": "GetLicenseLicenseInfoByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Catalog User", "PRIVSET.Global Read Privileges", "PRIVSET.Read-Only", "PRIVSET.View Licensing Status", "READ.license.LicenseInfo", "ROLE.Account Administrator", "ROLE.Catalog User", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'license.LicenseInfo' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.LicenseInfo" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetLicenseLicenseInfoByMoid": { "operationId": "GetLicenseLicenseInfoByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/license/LicenseInfos/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "license" ], "x-intersight-type": "SaaS", "summary": "Update a 'license.LicenseInfo' resource.", "operationId": "UpdateLicenseLicenseInfo", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.license.LicenseInfo" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'license.LicenseInfo' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.LicenseInfo" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'license.LicenseInfo' resource was modified as requested. The 'license.LicenseInfo' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.LicenseInfo" } } }, "links": { "GetLicenseLicenseInfoByMoid": { "operationId": "GetLicenseLicenseInfoByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/license/LicenseInfos/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "license" ], "x-intersight-type": "SaaS", "summary": "Update a 'license.LicenseInfo' resource.", "operationId": "PatchLicenseLicenseInfo", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.license.LicenseInfo" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'license.LicenseInfo' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.LicenseInfo" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'license.LicenseInfo' resource was patched as requested. The 'license.LicenseInfo' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.LicenseInfo" } } }, "links": { "GetLicenseLicenseInfoByMoid": { "operationId": "GetLicenseLicenseInfoByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/license/LicenseInfos/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/license/LicenseInfoViews": { "get": { "tags": [ "license" ], "summary": "Read a 'license.LicenseInfoView' resource.", "operationId": "GetLicenseLicenseInfoViewList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Global Read Privileges", "PRIVSET.Read-Only", "PRIVSET.Read-only licensing", "PRIVSET.View Licensing Status", "READ.license.LicenseInfoView", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'license.LicenseInfoView' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.LicenseInfoView.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/license/LicenseInfoViews/{Moid}": { "get": { "tags": [ "license" ], "summary": "Read a 'license.LicenseInfoView' resource.", "operationId": "GetLicenseLicenseInfoViewByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Global Read Privileges", "PRIVSET.Read-Only", "PRIVSET.Read-only licensing", "PRIVSET.View Licensing Status", "READ.license.LicenseInfoView", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'license.LicenseInfoView' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.LicenseInfoView" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetLicenseLicenseInfoViewByMoid": { "operationId": "GetLicenseLicenseInfoViewByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/license/LicenseInfoViews/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/license/LicenseRegistrationStatuses": { "get": { "tags": [ "license" ], "summary": "Read a 'license.LicenseRegistrationStatus' resource.", "operationId": "GetLicenseLicenseRegistrationStatusList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Read-only licensing", "PRIVSET.View Licensing Status", "READ.license.LicenseRegistrationStatus", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'license.LicenseRegistrationStatus' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.LicenseRegistrationStatus.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/license/LicenseRegistrationStatuses/{Moid}": { "get": { "tags": [ "license" ], "summary": "Read a 'license.LicenseRegistrationStatus' resource.", "operationId": "GetLicenseLicenseRegistrationStatusByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Read-only licensing", "PRIVSET.View Licensing Status", "READ.license.LicenseRegistrationStatus", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'license.LicenseRegistrationStatus' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.LicenseRegistrationStatus" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetLicenseLicenseRegistrationStatusByMoid": { "operationId": "GetLicenseLicenseRegistrationStatusByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/license/LicenseRegistrationStatuses/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "license" ], "summary": "Update a 'license.LicenseRegistrationStatus' resource.", "operationId": "UpdateLicenseLicenseRegistrationStatus", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.license.LicenseRegistrationStatus" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'license.LicenseRegistrationStatus' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.LicenseRegistrationStatus" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'license.LicenseRegistrationStatus' resource was modified as requested. The 'license.LicenseRegistrationStatus' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.LicenseRegistrationStatus" } } }, "links": { "GetLicenseLicenseRegistrationStatusByMoid": { "operationId": "GetLicenseLicenseRegistrationStatusByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/license/LicenseRegistrationStatuses/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "license" ], "summary": "Update a 'license.LicenseRegistrationStatus' resource.", "operationId": "PatchLicenseLicenseRegistrationStatus", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.license.LicenseRegistrationStatus" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'license.LicenseRegistrationStatus' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.LicenseRegistrationStatus" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'license.LicenseRegistrationStatus' resource was patched as requested. The 'license.LicenseRegistrationStatus' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.LicenseRegistrationStatus" } } }, "links": { "GetLicenseLicenseRegistrationStatusByMoid": { "operationId": "GetLicenseLicenseRegistrationStatusByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/license/LicenseRegistrationStatuses/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/license/LicenseReservationOps": { "get": { "tags": [ "license" ], "summary": "Read a 'license.LicenseReservationOp' resource.", "operationId": "GetLicenseLicenseReservationOpList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Read-only licensing", "PRIVSET.View Licensing Status", "READ.license.LicenseReservationOp", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'license.LicenseReservationOp' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.LicenseReservationOp.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "license" ], "summary": "Create a 'license.LicenseReservationOp' resource.", "operationId": "CreateLicenseLicenseReservationOp", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.license.LicenseReservationOp", "PRIVSET.Account Administrator", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'license.LicenseReservationOp' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.LicenseReservationOp" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'license.LicenseReservationOp' resource was created as requested. The 'license.LicenseReservationOp' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.LicenseReservationOp" } } }, "links": { "GetLicenseLicenseReservationOpByMoid": { "operationId": "GetLicenseLicenseReservationOpByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/license/LicenseReservationOps/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/license/LicenseReservationOps/{Moid}": { "get": { "tags": [ "license" ], "summary": "Read a 'license.LicenseReservationOp' resource.", "operationId": "GetLicenseLicenseReservationOpByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Read-only licensing", "PRIVSET.View Licensing Status", "READ.license.LicenseReservationOp", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'license.LicenseReservationOp' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.LicenseReservationOp" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetLicenseLicenseReservationOpByMoid": { "operationId": "GetLicenseLicenseReservationOpByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/license/LicenseReservationOps/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "license" ], "summary": "Update a 'license.LicenseReservationOp' resource.", "operationId": "UpdateLicenseLicenseReservationOp", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.license.LicenseReservationOp" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'license.LicenseReservationOp' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.LicenseReservationOp" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'license.LicenseReservationOp' resource was modified as requested. The 'license.LicenseReservationOp' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.LicenseReservationOp" } } }, "links": { "GetLicenseLicenseReservationOpByMoid": { "operationId": "GetLicenseLicenseReservationOpByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/license/LicenseReservationOps/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "license" ], "summary": "Update a 'license.LicenseReservationOp' resource.", "operationId": "PatchLicenseLicenseReservationOp", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.license.LicenseReservationOp" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'license.LicenseReservationOp' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.LicenseReservationOp" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'license.LicenseReservationOp' resource was patched as requested. The 'license.LicenseReservationOp' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.LicenseReservationOp" } } }, "links": { "GetLicenseLicenseReservationOpByMoid": { "operationId": "GetLicenseLicenseReservationOpByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/license/LicenseReservationOps/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/license/SmartlicenseTokens": { "get": { "tags": [ "license" ], "summary": "Read a 'license.SmartlicenseToken' resource.", "operationId": "GetLicenseSmartlicenseTokenList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Read-only licensing", "PRIVSET.View Licensing Status", "READ.license.SmartlicenseToken", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'license.SmartlicenseToken' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.SmartlicenseToken.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/license/SmartlicenseTokens/{Moid}": { "get": { "tags": [ "license" ], "summary": "Read a 'license.SmartlicenseToken' resource.", "operationId": "GetLicenseSmartlicenseTokenByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Read-only licensing", "PRIVSET.View Licensing Status", "READ.license.SmartlicenseToken", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'license.SmartlicenseToken' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.SmartlicenseToken" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetLicenseSmartlicenseTokenByMoid": { "operationId": "GetLicenseSmartlicenseTokenByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/license/SmartlicenseTokens/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "license" ], "summary": "Update a 'license.SmartlicenseToken' resource.", "operationId": "UpdateLicenseSmartlicenseToken", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.license.SmartlicenseToken" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'license.SmartlicenseToken' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.SmartlicenseToken" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'license.SmartlicenseToken' resource was modified as requested. The 'license.SmartlicenseToken' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.SmartlicenseToken" } } }, "links": { "GetLicenseSmartlicenseTokenByMoid": { "operationId": "GetLicenseSmartlicenseTokenByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/license/SmartlicenseTokens/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "license" ], "summary": "Update a 'license.SmartlicenseToken' resource.", "operationId": "PatchLicenseSmartlicenseToken", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.license.SmartlicenseToken" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'license.SmartlicenseToken' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.SmartlicenseToken" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'license.SmartlicenseToken' resource was patched as requested. The 'license.SmartlicenseToken' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.SmartlicenseToken" } } }, "links": { "GetLicenseSmartlicenseTokenByMoid": { "operationId": "GetLicenseSmartlicenseTokenByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/license/SmartlicenseTokens/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/meraki/Devices": { "get": { "tags": [ "meraki" ], "x-intersight-type": "SaaS", "summary": "Read a 'meraki.Device' resource.", "operationId": "GetMerakiDeviceList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.meraki.Device", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'meraki.Device' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/meraki.Device.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/meraki/Devices/{Moid}": { "get": { "tags": [ "meraki" ], "x-intersight-type": "SaaS", "summary": "Read a 'meraki.Device' resource.", "operationId": "GetMerakiDeviceByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.meraki.Device", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'meraki.Device' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/meraki.Device" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetMerakiDeviceByMoid": { "operationId": "GetMerakiDeviceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/meraki/Devices/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/meraki/Networks": { "get": { "tags": [ "meraki" ], "x-intersight-type": "SaaS", "summary": "Read a 'meraki.Network' resource.", "operationId": "GetMerakiNetworkList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.meraki.Network", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'meraki.Network' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/meraki.Network.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/meraki/Networks/{Moid}": { "get": { "tags": [ "meraki" ], "x-intersight-type": "SaaS", "summary": "Read a 'meraki.Network' resource.", "operationId": "GetMerakiNetworkByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.meraki.Network", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'meraki.Network' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/meraki.Network" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetMerakiNetworkByMoid": { "operationId": "GetMerakiNetworkByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/meraki/Networks/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/meraki/Organizations": { "get": { "tags": [ "meraki" ], "x-intersight-type": "SaaS", "summary": "Read a 'meraki.Organization' resource.", "operationId": "GetMerakiOrganizationList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.meraki.Organization", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'meraki.Organization' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/meraki.Organization.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/meraki/Organizations/{Moid}": { "get": { "tags": [ "meraki" ], "x-intersight-type": "SaaS", "summary": "Read a 'meraki.Organization' resource.", "operationId": "GetMerakiOrganizationByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.meraki.Organization", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'meraki.Organization' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/meraki.Organization" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetMerakiOrganizationByMoid": { "operationId": "GetMerakiOrganizationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/meraki/Organizations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/meraki/PortProfiles": { "get": { "tags": [ "meraki" ], "x-intersight-type": "SaaS", "summary": "Read a 'meraki.PortProfile' resource.", "operationId": "GetMerakiPortProfileList", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.meraki.PortProfile", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'meraki.PortProfile' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/meraki.PortProfile.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/meraki/PortProfiles/{Moid}": { "get": { "tags": [ "meraki" ], "x-intersight-type": "SaaS", "summary": "Read a 'meraki.PortProfile' resource.", "operationId": "GetMerakiPortProfileByMoid", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.meraki.PortProfile", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'meraki.PortProfile' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/meraki.PortProfile" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetMerakiPortProfileByMoid": { "operationId": "GetMerakiPortProfileByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/meraki/PortProfiles/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/meraki/Tags": { "get": { "tags": [ "meraki" ], "x-intersight-type": "SaaS", "summary": "Read a 'meraki.Tag' resource.", "operationId": "GetMerakiTagList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.meraki.Tag", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'meraki.Tag' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/meraki.Tag.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/meraki/Tags/{Moid}": { "get": { "tags": [ "meraki" ], "x-intersight-type": "SaaS", "summary": "Read a 'meraki.Tag' resource.", "operationId": "GetMerakiTagByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.meraki.Tag", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'meraki.Tag' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/meraki.Tag" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetMerakiTagByMoid": { "operationId": "GetMerakiTagByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/meraki/Tags/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/meta/Definitions": { "get": { "tags": [ "meta" ], "x-intersight-type": "SaaS", "summary": "Read a 'meta.Definition' resource.", "operationId": "GetMetaDefinitionList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Global Read Privileges", "PRIVSET.Global System Privileges", "READ.meta.Definition" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'meta.Definition' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/meta.Definition.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/meta/Definitions/{Moid}": { "get": { "tags": [ "meta" ], "x-intersight-type": "SaaS", "summary": "Read a 'meta.Definition' resource.", "operationId": "GetMetaDefinitionByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Global Read Privileges", "PRIVSET.Global System Privileges", "READ.meta.Definition" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'meta.Definition' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/meta.Definition" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetMetaDefinitionByMoid": { "operationId": "GetMetaDefinitionByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/meta/Definitions/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/notification/AccountSubscriptions": { "get": { "tags": [ "notification" ], "summary": "Read a 'notification.AccountSubscription' resource.", "operationId": "GetNotificationAccountSubscriptionList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Add notification rule or webhook", "PRIVSET.Delete notification rule or webhook", "PRIVSET.Edit notification rule or webhook", "READ.notification.AccountSubscription", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'notification.AccountSubscription' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/notification.AccountSubscription.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "notification" ], "summary": "Create a 'notification.AccountSubscription' resource.", "operationId": "CreateNotificationAccountSubscription", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.notification.AccountSubscription", "PRIVSET.Account Administrator", "PRIVSET.Add notification rule or webhook", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'notification.AccountSubscription' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/notification.AccountSubscription" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'notification.AccountSubscription' resource was created as requested. The 'notification.AccountSubscription' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/notification.AccountSubscription" } } }, "links": { "GetNotificationAccountSubscriptionByMoid": { "operationId": "GetNotificationAccountSubscriptionByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/notification/AccountSubscriptions/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/notification/AccountSubscriptions/{Moid}": { "get": { "tags": [ "notification" ], "summary": "Read a 'notification.AccountSubscription' resource.", "operationId": "GetNotificationAccountSubscriptionByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Add notification rule or webhook", "PRIVSET.Delete notification rule or webhook", "PRIVSET.Edit notification rule or webhook", "READ.notification.AccountSubscription", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'notification.AccountSubscription' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/notification.AccountSubscription" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetNotificationAccountSubscriptionByMoid": { "operationId": "GetNotificationAccountSubscriptionByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/notification/AccountSubscriptions/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "notification" ], "summary": "Update a 'notification.AccountSubscription' resource.", "operationId": "UpdateNotificationAccountSubscription", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit notification rule or webhook", "ROLE.Account Administrator", "UPDATE.notification.AccountSubscription" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'notification.AccountSubscription' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/notification.AccountSubscription" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'notification.AccountSubscription' resource was modified as requested. The 'notification.AccountSubscription' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/notification.AccountSubscription" } } }, "links": { "GetNotificationAccountSubscriptionByMoid": { "operationId": "GetNotificationAccountSubscriptionByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/notification/AccountSubscriptions/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "notification" ], "summary": "Update a 'notification.AccountSubscription' resource.", "operationId": "PatchNotificationAccountSubscription", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit notification rule or webhook", "ROLE.Account Administrator", "UPDATE.notification.AccountSubscription" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'notification.AccountSubscription' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/notification.AccountSubscription" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'notification.AccountSubscription' resource was patched as requested. The 'notification.AccountSubscription' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/notification.AccountSubscription" } } }, "links": { "GetNotificationAccountSubscriptionByMoid": { "operationId": "GetNotificationAccountSubscriptionByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/notification/AccountSubscriptions/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "notification" ], "summary": "Delete a 'notification.AccountSubscription' resource.", "operationId": "DeleteNotificationAccountSubscription", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.notification.AccountSubscription", "PRIVSET.Account Administrator", "PRIVSET.Delete notification rule or webhook", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/oauth/AccessTokens": { "get": { "tags": [ "oauth" ], "summary": "Read a 'oauth.AccessToken' resource.", "operationId": "GetOauthAccessTokenList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Enable subscription information", "READ.oauth.AccessToken", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'oauth.AccessToken' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/oauth.AccessToken.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/oauth/AccessTokens/{Moid}": { "get": { "tags": [ "oauth" ], "summary": "Read a 'oauth.AccessToken' resource.", "operationId": "GetOauthAccessTokenByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Enable subscription information", "READ.oauth.AccessToken", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'oauth.AccessToken' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/oauth.AccessToken" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetOauthAccessTokenByMoid": { "operationId": "GetOauthAccessTokenByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/oauth/AccessTokens/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "oauth" ], "summary": "Delete a 'oauth.AccessToken' resource.", "operationId": "DeleteOauthAccessToken", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.oauth.AccessToken", "PRIVSET.Account Administrator", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/oauth/Authorizations": { "post": { "tags": [ "oauth" ], "summary": "Create a 'oauth.Authorization' resource.", "operationId": "CreateOauthAuthorization", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.oauth.Authorization", "PRIVSET.Account Administrator", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'oauth.Authorization' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/oauth.Authorization" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'oauth.Authorization' resource was created as requested. The 'oauth.Authorization' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/oauth.Authorization" } } }, "links": { "GetOauthAuthorizationByMoid": { "operationId": "GetOauthAuthorizationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/oauth/Authorizations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "get": { "tags": [ "oauth" ], "summary": "Read a 'oauth.Authorization' resource.", "operationId": "GetOauthAuthorizationList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Enable subscription information", "PRIVSET.Read-Only", "READ.oauth.Authorization", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'oauth.Authorization' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/oauth.Authorization.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/oauth/Authorizations/{Moid}": { "post": { "tags": [ "oauth" ], "summary": "Update a 'oauth.Authorization' resource.", "operationId": "UpdateOauthAuthorization", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Enable subscription information", "ROLE.Account Administrator", "UPDATE.oauth.Authorization" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'oauth.Authorization' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/oauth.Authorization" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'oauth.Authorization' resource was modified as requested. The 'oauth.Authorization' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/oauth.Authorization" } } }, "links": { "GetOauthAuthorizationByMoid": { "operationId": "GetOauthAuthorizationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/oauth/Authorizations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "oauth" ], "summary": "Update a 'oauth.Authorization' resource.", "operationId": "PatchOauthAuthorization", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Enable subscription information", "ROLE.Account Administrator", "UPDATE.oauth.Authorization" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'oauth.Authorization' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/oauth.Authorization" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'oauth.Authorization' resource was patched as requested. The 'oauth.Authorization' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/oauth.Authorization" } } }, "links": { "GetOauthAuthorizationByMoid": { "operationId": "GetOauthAuthorizationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/oauth/Authorizations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "get": { "tags": [ "oauth" ], "summary": "Read a 'oauth.Authorization' resource.", "operationId": "GetOauthAuthorizationByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Enable subscription information", "PRIVSET.Read-Only", "READ.oauth.Authorization", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'oauth.Authorization' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/oauth.Authorization" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetOauthAuthorizationByMoid": { "operationId": "GetOauthAuthorizationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/oauth/Authorizations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/openapi/ApiMethodMeta": { "get": { "tags": [ "openapi" ], "x-intersight-type": "SaaS", "summary": "Read a 'openapi.ApiMethodMeta' resource.", "operationId": "GetOpenapiApiMethodMetaList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Workflow Designer", "READ.openapi.ApiMethodMeta", "ROLE.Account Administrator", "ROLE.Read-Only", "ROLE.Workflow Designer" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'openapi.ApiMethodMeta' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/openapi.ApiMethodMeta.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/openapi/ApiMethodMeta/{Moid}": { "get": { "tags": [ "openapi" ], "x-intersight-type": "SaaS", "summary": "Read a 'openapi.ApiMethodMeta' resource.", "operationId": "GetOpenapiApiMethodMetaByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Workflow Designer", "READ.openapi.ApiMethodMeta", "ROLE.Account Administrator", "ROLE.Read-Only", "ROLE.Workflow Designer" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'openapi.ApiMethodMeta' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/openapi.ApiMethodMeta" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetOpenapiApiMethodMetaByMoid": { "operationId": "GetOpenapiApiMethodMetaByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/openapi/ApiMethodMeta/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "openapi" ], "x-intersight-type": "SaaS", "summary": "Delete a 'openapi.ApiMethodMeta' resource.", "operationId": "DeleteOpenapiApiMethodMeta", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.openapi.ApiMethodMeta", "PRIVSET.Account Administrator", "PRIVSET.Workflow Designer", "ROLE.Account Administrator", "ROLE.Workflow Designer" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/openapi/OpenApiSpecifications": { "get": { "tags": [ "openapi" ], "summary": "Read a 'openapi.OpenApiSpecification' resource.", "operationId": "GetOpenapiOpenApiSpecificationList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Workflow Designer", "READ.openapi.OpenApiSpecification", "ROLE.Account Administrator", "ROLE.Read-Only", "ROLE.Workflow Designer" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'openapi.OpenApiSpecification' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/openapi.OpenApiSpecification.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "openapi" ], "summary": "Create a 'openapi.OpenApiSpecification' resource.", "operationId": "CreateOpenapiOpenApiSpecification", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.openapi.OpenApiSpecification", "PRIVSET.Account Administrator", "PRIVSET.Workflow Designer", "ROLE.Account Administrator", "ROLE.Workflow Designer" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'openapi.OpenApiSpecification' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/openapi.OpenApiSpecification" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'openapi.OpenApiSpecification' resource was created as requested. The 'openapi.OpenApiSpecification' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/openapi.OpenApiSpecification" } } }, "links": { "GetOpenapiOpenApiSpecificationByMoid": { "operationId": "GetOpenapiOpenApiSpecificationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/openapi/OpenApiSpecifications/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/openapi/OpenApiSpecifications/{Moid}": { "get": { "tags": [ "openapi" ], "summary": "Read a 'openapi.OpenApiSpecification' resource.", "operationId": "GetOpenapiOpenApiSpecificationByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Workflow Designer", "READ.openapi.OpenApiSpecification", "ROLE.Account Administrator", "ROLE.Read-Only", "ROLE.Workflow Designer" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'openapi.OpenApiSpecification' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/openapi.OpenApiSpecification" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetOpenapiOpenApiSpecificationByMoid": { "operationId": "GetOpenapiOpenApiSpecificationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/openapi/OpenApiSpecifications/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "openapi" ], "summary": "Update a 'openapi.OpenApiSpecification' resource.", "operationId": "UpdateOpenapiOpenApiSpecification", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Workflow Designer", "ROLE.Account Administrator", "ROLE.Workflow Designer", "UPDATE.openapi.OpenApiSpecification" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'openapi.OpenApiSpecification' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/openapi.OpenApiSpecification" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'openapi.OpenApiSpecification' resource was modified as requested. The 'openapi.OpenApiSpecification' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/openapi.OpenApiSpecification" } } }, "links": { "GetOpenapiOpenApiSpecificationByMoid": { "operationId": "GetOpenapiOpenApiSpecificationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/openapi/OpenApiSpecifications/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "openapi" ], "summary": "Update a 'openapi.OpenApiSpecification' resource.", "operationId": "PatchOpenapiOpenApiSpecification", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Workflow Designer", "ROLE.Account Administrator", "ROLE.Workflow Designer", "UPDATE.openapi.OpenApiSpecification" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'openapi.OpenApiSpecification' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/openapi.OpenApiSpecification" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'openapi.OpenApiSpecification' resource was patched as requested. The 'openapi.OpenApiSpecification' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/openapi.OpenApiSpecification" } } }, "links": { "GetOpenapiOpenApiSpecificationByMoid": { "operationId": "GetOpenapiOpenApiSpecificationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/openapi/OpenApiSpecifications/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "openapi" ], "summary": "Delete a 'openapi.OpenApiSpecification' resource.", "operationId": "DeleteOpenapiOpenApiSpecification", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.openapi.OpenApiSpecification", "PRIVSET.Account Administrator", "PRIVSET.Workflow Designer", "ROLE.Account Administrator", "ROLE.Workflow Designer" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/openapi/ProcessFiles": { "get": { "tags": [ "openapi" ], "x-intersight-type": "SaaS", "summary": "Read a 'openapi.ProcessFile' resource.", "operationId": "GetOpenapiProcessFileList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Workflow Designer", "READ.openapi.ProcessFile", "ROLE.Account Administrator", "ROLE.Read-Only", "ROLE.Workflow Designer" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'openapi.ProcessFile' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/openapi.ProcessFile.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "openapi" ], "x-intersight-type": "SaaS", "summary": "Create a 'openapi.ProcessFile' resource.", "operationId": "CreateOpenapiProcessFile", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.openapi.ProcessFile", "PRIVSET.Account Administrator", "PRIVSET.Workflow Designer", "ROLE.Account Administrator", "ROLE.Workflow Designer" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'openapi.ProcessFile' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/openapi.ProcessFile" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'openapi.ProcessFile' resource was created as requested. The 'openapi.ProcessFile' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/openapi.ProcessFile" } } }, "links": { "GetOpenapiProcessFileByMoid": { "operationId": "GetOpenapiProcessFileByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/openapi/ProcessFiles/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/openapi/ProcessFiles/{Moid}": { "get": { "tags": [ "openapi" ], "x-intersight-type": "SaaS", "summary": "Read a 'openapi.ProcessFile' resource.", "operationId": "GetOpenapiProcessFileByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Workflow Designer", "READ.openapi.ProcessFile", "ROLE.Account Administrator", "ROLE.Read-Only", "ROLE.Workflow Designer" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'openapi.ProcessFile' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/openapi.ProcessFile" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetOpenapiProcessFileByMoid": { "operationId": "GetOpenapiProcessFileByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/openapi/ProcessFiles/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "openapi" ], "x-intersight-type": "SaaS", "summary": "Delete a 'openapi.ProcessFile' resource.", "operationId": "DeleteOpenapiProcessFile", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.openapi.ProcessFile", "PRIVSET.Account Administrator", "PRIVSET.Workflow Designer", "ROLE.Account Administrator", "ROLE.Workflow Designer" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/openapi/TaskGenerationRequests": { "get": { "tags": [ "openapi" ], "x-intersight-type": "SaaS", "summary": "Read a 'openapi.TaskGenerationRequest' resource.", "operationId": "GetOpenapiTaskGenerationRequestList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Workflow Designer", "READ.openapi.TaskGenerationRequest", "ROLE.Account Administrator", "ROLE.Read-Only", "ROLE.Workflow Designer" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'openapi.TaskGenerationRequest' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/openapi.TaskGenerationRequest.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "openapi" ], "x-intersight-type": "SaaS", "summary": "Create a 'openapi.TaskGenerationRequest' resource.", "operationId": "CreateOpenapiTaskGenerationRequest", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.openapi.TaskGenerationRequest", "PRIVSET.Account Administrator", "PRIVSET.Workflow Designer", "ROLE.Account Administrator", "ROLE.Workflow Designer" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'openapi.TaskGenerationRequest' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/openapi.TaskGenerationRequest" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'openapi.TaskGenerationRequest' resource was created as requested. The 'openapi.TaskGenerationRequest' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/openapi.TaskGenerationRequest" } } }, "links": { "GetOpenapiTaskGenerationRequestByMoid": { "operationId": "GetOpenapiTaskGenerationRequestByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/openapi/TaskGenerationRequests/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/openapi/TaskGenerationRequests/{Moid}": { "get": { "tags": [ "openapi" ], "x-intersight-type": "SaaS", "summary": "Read a 'openapi.TaskGenerationRequest' resource.", "operationId": "GetOpenapiTaskGenerationRequestByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Workflow Designer", "READ.openapi.TaskGenerationRequest", "ROLE.Account Administrator", "ROLE.Read-Only", "ROLE.Workflow Designer" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'openapi.TaskGenerationRequest' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/openapi.TaskGenerationRequest" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetOpenapiTaskGenerationRequestByMoid": { "operationId": "GetOpenapiTaskGenerationRequestByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/openapi/TaskGenerationRequests/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "openapi" ], "x-intersight-type": "SaaS", "summary": "Update a 'openapi.TaskGenerationRequest' resource.", "operationId": "UpdateOpenapiTaskGenerationRequest", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Workflow Designer", "ROLE.Account Administrator", "ROLE.Workflow Designer", "UPDATE.openapi.TaskGenerationRequest" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'openapi.TaskGenerationRequest' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/openapi.TaskGenerationRequest" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'openapi.TaskGenerationRequest' resource was modified as requested. The 'openapi.TaskGenerationRequest' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/openapi.TaskGenerationRequest" } } }, "links": { "GetOpenapiTaskGenerationRequestByMoid": { "operationId": "GetOpenapiTaskGenerationRequestByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/openapi/TaskGenerationRequests/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "openapi" ], "x-intersight-type": "SaaS", "summary": "Update a 'openapi.TaskGenerationRequest' resource.", "operationId": "PatchOpenapiTaskGenerationRequest", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Workflow Designer", "ROLE.Account Administrator", "ROLE.Workflow Designer", "UPDATE.openapi.TaskGenerationRequest" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'openapi.TaskGenerationRequest' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/openapi.TaskGenerationRequest" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'openapi.TaskGenerationRequest' resource was patched as requested. The 'openapi.TaskGenerationRequest' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/openapi.TaskGenerationRequest" } } }, "links": { "GetOpenapiTaskGenerationRequestByMoid": { "operationId": "GetOpenapiTaskGenerationRequestByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/openapi/TaskGenerationRequests/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "openapi" ], "x-intersight-type": "SaaS", "summary": "Delete a 'openapi.TaskGenerationRequest' resource.", "operationId": "DeleteOpenapiTaskGenerationRequest", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.openapi.TaskGenerationRequest", "PRIVSET.Account Administrator", "PRIVSET.Workflow Designer", "ROLE.Account Administrator", "ROLE.Workflow Designer" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/openapi/TaskGenerationResults": { "get": { "tags": [ "openapi" ], "x-intersight-type": "SaaS", "summary": "Read a 'openapi.TaskGenerationResult' resource.", "operationId": "GetOpenapiTaskGenerationResultList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Workflow Designer", "READ.openapi.TaskGenerationResult", "ROLE.Account Administrator", "ROLE.Read-Only", "ROLE.Workflow Designer" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'openapi.TaskGenerationResult' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/openapi.TaskGenerationResult.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/openapi/TaskGenerationResults/{Moid}": { "get": { "tags": [ "openapi" ], "x-intersight-type": "SaaS", "summary": "Read a 'openapi.TaskGenerationResult' resource.", "operationId": "GetOpenapiTaskGenerationResultByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Workflow Designer", "READ.openapi.TaskGenerationResult", "ROLE.Account Administrator", "ROLE.Read-Only", "ROLE.Workflow Designer" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'openapi.TaskGenerationResult' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/openapi.TaskGenerationResult" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetOpenapiTaskGenerationResultByMoid": { "operationId": "GetOpenapiTaskGenerationResultByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/openapi/TaskGenerationResults/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "openapi" ], "x-intersight-type": "SaaS", "summary": "Delete a 'openapi.TaskGenerationResult' resource.", "operationId": "DeleteOpenapiTaskGenerationResult", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.openapi.TaskGenerationResult", "PRIVSET.Account Administrator", "PRIVSET.Workflow Designer", "ROLE.Account Administrator", "ROLE.Workflow Designer" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/oprs/Deployments": { "get": { "tags": [ "oprs" ], "x-intersight-type": "SaaS", "summary": "Read a 'oprs.Deployment' resource.", "operationId": "GetOprsDeploymentList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Hypervisors", "PRIVSET.Read-Only", "PRIVSET.View Hypervisors", "READ.oprs.Deployment", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'oprs.Deployment' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/oprs.Deployment.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "oprs" ], "x-intersight-type": "SaaS", "summary": "Create a 'oprs.Deployment' resource.", "operationId": "CreateOprsDeployment", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.oprs.Deployment", "PRIVSET.Account Administrator", "PRIVSET.Manage Hypervisors", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'oprs.Deployment' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/oprs.Deployment" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'oprs.Deployment' resource was created as requested. The 'oprs.Deployment' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/oprs.Deployment" } } }, "links": { "GetOprsDeploymentByMoid": { "operationId": "GetOprsDeploymentByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/oprs/Deployments/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/oprs/Deployments/{Moid}": { "get": { "tags": [ "oprs" ], "x-intersight-type": "SaaS", "summary": "Read a 'oprs.Deployment' resource.", "operationId": "GetOprsDeploymentByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Hypervisors", "PRIVSET.Read-Only", "PRIVSET.View Hypervisors", "READ.oprs.Deployment", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'oprs.Deployment' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/oprs.Deployment" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetOprsDeploymentByMoid": { "operationId": "GetOprsDeploymentByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/oprs/Deployments/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "oprs" ], "x-intersight-type": "SaaS", "summary": "Update a 'oprs.Deployment' resource.", "operationId": "UpdateOprsDeployment", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Hypervisors", "ROLE.Account Administrator", "UPDATE.oprs.Deployment" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'oprs.Deployment' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/oprs.Deployment" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'oprs.Deployment' resource was modified as requested. The 'oprs.Deployment' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/oprs.Deployment" } } }, "links": { "GetOprsDeploymentByMoid": { "operationId": "GetOprsDeploymentByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/oprs/Deployments/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "oprs" ], "x-intersight-type": "SaaS", "summary": "Update a 'oprs.Deployment' resource.", "operationId": "PatchOprsDeployment", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Hypervisors", "ROLE.Account Administrator", "UPDATE.oprs.Deployment" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'oprs.Deployment' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/oprs.Deployment" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'oprs.Deployment' resource was patched as requested. The 'oprs.Deployment' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/oprs.Deployment" } } }, "links": { "GetOprsDeploymentByMoid": { "operationId": "GetOprsDeploymentByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/oprs/Deployments/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "oprs" ], "x-intersight-type": "SaaS", "summary": "Delete a 'oprs.Deployment' resource.", "operationId": "DeleteOprsDeployment", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.oprs.Deployment", "PRIVSET.Account Administrator", "PRIVSET.Manage Hypervisors", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/oprs/SyncTargetListMessages": { "get": { "tags": [ "oprs" ], "x-intersight-type": "SaaS", "summary": "Read a 'oprs.SyncTargetListMessage' resource.", "operationId": "GetOprsSyncTargetListMessageList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.oprs.SyncTargetListMessage", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'oprs.SyncTargetListMessage' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/oprs.SyncTargetListMessage.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "oprs" ], "x-intersight-type": "SaaS", "summary": "Create a 'oprs.SyncTargetListMessage' resource.", "operationId": "CreateOprsSyncTargetListMessage", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.oprs.SyncTargetListMessage", "PRIVSET.Account Administrator", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'oprs.SyncTargetListMessage' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/oprs.SyncTargetListMessage" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'oprs.SyncTargetListMessage' resource was created as requested. The 'oprs.SyncTargetListMessage' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/oprs.SyncTargetListMessage" } } }, "links": { "GetOprsSyncTargetListMessageByMoid": { "operationId": "GetOprsSyncTargetListMessageByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/oprs/SyncTargetListMessages/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/oprs/SyncTargetListMessages/{Moid}": { "get": { "tags": [ "oprs" ], "x-intersight-type": "SaaS", "summary": "Read a 'oprs.SyncTargetListMessage' resource.", "operationId": "GetOprsSyncTargetListMessageByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.oprs.SyncTargetListMessage", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'oprs.SyncTargetListMessage' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/oprs.SyncTargetListMessage" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetOprsSyncTargetListMessageByMoid": { "operationId": "GetOprsSyncTargetListMessageByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/oprs/SyncTargetListMessages/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "oprs" ], "x-intersight-type": "SaaS", "summary": "Update a 'oprs.SyncTargetListMessage' resource.", "operationId": "UpdateOprsSyncTargetListMessage", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.oprs.SyncTargetListMessage" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'oprs.SyncTargetListMessage' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/oprs.SyncTargetListMessage" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'oprs.SyncTargetListMessage' resource was modified as requested. The 'oprs.SyncTargetListMessage' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/oprs.SyncTargetListMessage" } } }, "links": { "GetOprsSyncTargetListMessageByMoid": { "operationId": "GetOprsSyncTargetListMessageByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/oprs/SyncTargetListMessages/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "oprs" ], "x-intersight-type": "SaaS", "summary": "Update a 'oprs.SyncTargetListMessage' resource.", "operationId": "PatchOprsSyncTargetListMessage", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.oprs.SyncTargetListMessage" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'oprs.SyncTargetListMessage' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/oprs.SyncTargetListMessage" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'oprs.SyncTargetListMessage' resource was patched as requested. The 'oprs.SyncTargetListMessage' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/oprs.SyncTargetListMessage" } } }, "links": { "GetOprsSyncTargetListMessageByMoid": { "operationId": "GetOprsSyncTargetListMessageByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/oprs/SyncTargetListMessages/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "oprs" ], "x-intersight-type": "SaaS", "summary": "Delete a 'oprs.SyncTargetListMessage' resource.", "operationId": "DeleteOprsSyncTargetListMessage", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.oprs.SyncTargetListMessage", "PRIVSET.Account Administrator", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/organization/Organizations": { "post": { "tags": [ "organization" ], "x-intersight-type": "SaaS", "summary": "Create a 'organization.Organization' resource.", "operationId": "CreateOrganizationOrganization", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.organization.Organization", "PRIVSET.Account Administrator", "PRIVSET.Manage Organizations", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'organization.Organization' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/organization.Organization" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'organization.Organization' resource was created as requested. The 'organization.Organization' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/organization.Organization" } } }, "links": { "GetOrganizationOrganizationByMoid": { "operationId": "GetOrganizationOrganizationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/organization/Organizations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "get": { "tags": [ "organization" ], "x-intersight-type": "SaaS", "summary": "Read a 'organization.Organization' resource.", "operationId": "GetOrganizationOrganizationList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Catalog User", "PRIVSET.Manage Organizations", "PRIVSET.Read Organizations", "PRIVSET.Read-Only", "PRIVSET.View Organizations", "READ.organization.Organization", "ROLE.Account Administrator", "ROLE.Catalog User", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'organization.Organization' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/organization.Organization.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/organization/Organizations/{Moid}": { "post": { "tags": [ "organization" ], "x-intersight-type": "SaaS", "summary": "Update a 'organization.Organization' resource.", "operationId": "UpdateOrganizationOrganization", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Organizations", "ROLE.Account Administrator", "UPDATE.organization.Organization" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'organization.Organization' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/organization.Organization" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'organization.Organization' resource was modified as requested. The 'organization.Organization' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/organization.Organization" } } }, "links": { "GetOrganizationOrganizationByMoid": { "operationId": "GetOrganizationOrganizationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/organization/Organizations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "organization" ], "x-intersight-type": "SaaS", "summary": "Update a 'organization.Organization' resource.", "operationId": "PatchOrganizationOrganization", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Organizations", "ROLE.Account Administrator", "UPDATE.organization.Organization" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'organization.Organization' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/organization.Organization" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'organization.Organization' resource was patched as requested. The 'organization.Organization' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/organization.Organization" } } }, "links": { "GetOrganizationOrganizationByMoid": { "operationId": "GetOrganizationOrganizationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/organization/Organizations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "organization" ], "x-intersight-type": "SaaS", "summary": "Delete a 'organization.Organization' resource.", "operationId": "DeleteOrganizationOrganization", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.organization.Organization", "PRIVSET.Account Administrator", "PRIVSET.Manage Organizations", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "get": { "tags": [ "organization" ], "x-intersight-type": "SaaS", "summary": "Read a 'organization.Organization' resource.", "operationId": "GetOrganizationOrganizationByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Catalog User", "PRIVSET.Manage Organizations", "PRIVSET.Read Organizations", "PRIVSET.Read-Only", "PRIVSET.View Organizations", "READ.organization.Organization", "ROLE.Account Administrator", "ROLE.Catalog User", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'organization.Organization' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/organization.Organization" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetOrganizationOrganizationByMoid": { "operationId": "GetOrganizationOrganizationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/organization/Organizations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/resource/Groups": { "post": { "tags": [ "resource" ], "summary": "Create a 'resource.Group' resource.", "operationId": "CreateResourceGroup", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.resource.Group", "PRIVSET.Account Administrator", "PRIVSET.Manage Organizations", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'resource.Group' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/resource.Group" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'resource.Group' resource was created as requested. The 'resource.Group' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/resource.Group" } } }, "links": { "GetResourceGroupByMoid": { "operationId": "GetResourceGroupByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/resource/Groups/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "get": { "tags": [ "resource" ], "summary": "Read a 'resource.Group' resource.", "operationId": "GetResourceGroupList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Organizations", "PRIVSET.Read Organizations", "PRIVSET.Read-Only", "PRIVSET.View Organizations", "READ.resource.Group", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'resource.Group' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/resource.Group.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/resource/Groups/{Moid}": { "post": { "tags": [ "resource" ], "summary": "Update a 'resource.Group' resource.", "operationId": "UpdateResourceGroup", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Organizations", "ROLE.Account Administrator", "UPDATE.resource.Group" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'resource.Group' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/resource.Group" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'resource.Group' resource was modified as requested. The 'resource.Group' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/resource.Group" } } }, "links": { "GetResourceGroupByMoid": { "operationId": "GetResourceGroupByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/resource/Groups/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "resource" ], "summary": "Update a 'resource.Group' resource.", "operationId": "PatchResourceGroup", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Organizations", "ROLE.Account Administrator", "UPDATE.resource.Group" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'resource.Group' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/resource.Group" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'resource.Group' resource was patched as requested. The 'resource.Group' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/resource.Group" } } }, "links": { "GetResourceGroupByMoid": { "operationId": "GetResourceGroupByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/resource/Groups/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "resource" ], "summary": "Delete a 'resource.Group' resource.", "operationId": "DeleteResourceGroup", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.resource.Group", "PRIVSET.Account Administrator", "PRIVSET.Manage Organizations", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "get": { "tags": [ "resource" ], "summary": "Read a 'resource.Group' resource.", "operationId": "GetResourceGroupByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Organizations", "PRIVSET.Read Organizations", "PRIVSET.Read-Only", "PRIVSET.View Organizations", "READ.resource.Group", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'resource.Group' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/resource.Group" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetResourceGroupByMoid": { "operationId": "GetResourceGroupByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/resource/Groups/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/resource/GroupMembers": { "get": { "tags": [ "resource" ], "summary": "Read a 'resource.GroupMember' resource.", "operationId": "GetResourceGroupMemberList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Organizations", "PRIVSET.Read Organizations", "PRIVSET.Read-Only", "PRIVSET.View Organizations", "READ.resource.GroupMember", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'resource.GroupMember' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/resource.GroupMember.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/resource/GroupMembers/{Moid}": { "get": { "tags": [ "resource" ], "summary": "Read a 'resource.GroupMember' resource.", "operationId": "GetResourceGroupMemberByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Organizations", "PRIVSET.Read Organizations", "PRIVSET.Read-Only", "PRIVSET.View Organizations", "READ.resource.GroupMember", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'resource.GroupMember' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/resource.GroupMember" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetResourceGroupMemberByMoid": { "operationId": "GetResourceGroupMemberByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/resource/GroupMembers/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/resource/LicenseResourceCounts": { "get": { "tags": [ "resource" ], "summary": "Read a 'resource.LicenseResourceCount' resource.", "operationId": "GetResourceLicenseResourceCountList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "READ.resource.LicenseResourceCount" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'resource.LicenseResourceCount' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/resource.LicenseResourceCount.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/resource/LicenseResourceCounts/{Moid}": { "get": { "tags": [ "resource" ], "summary": "Read a 'resource.LicenseResourceCount' resource.", "operationId": "GetResourceLicenseResourceCountByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "READ.resource.LicenseResourceCount" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'resource.LicenseResourceCount' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/resource.LicenseResourceCount" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetResourceLicenseResourceCountByMoid": { "operationId": "GetResourceLicenseResourceCountByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/resource/LicenseResourceCounts/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/resource/Memberships": { "get": { "tags": [ "resource" ], "x-intersight-type": "SaaS", "summary": "Read a 'resource.Membership' resource.", "operationId": "GetResourceMembershipList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Organizations", "PRIVSET.Read Organizations", "PRIVSET.Read-Only", "PRIVSET.View Organizations", "READ.resource.Membership", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'resource.Membership' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/resource.Membership.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/resource/Memberships/{Moid}": { "get": { "tags": [ "resource" ], "x-intersight-type": "SaaS", "summary": "Read a 'resource.Membership' resource.", "operationId": "GetResourceMembershipByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Organizations", "PRIVSET.Read Organizations", "PRIVSET.Read-Only", "PRIVSET.View Organizations", "READ.resource.Membership", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'resource.Membership' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/resource.Membership" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetResourceMembershipByMoid": { "operationId": "GetResourceMembershipByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/resource/Memberships/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "resource" ], "x-intersight-type": "SaaS", "summary": "Update a 'resource.Membership' resource.", "operationId": "UpdateResourceMembership", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.resource.Membership" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'resource.Membership' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/resource.Membership" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'resource.Membership' resource was modified as requested. The 'resource.Membership' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/resource.Membership" } } }, "links": { "GetResourceMembershipByMoid": { "operationId": "GetResourceMembershipByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/resource/Memberships/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "resource" ], "x-intersight-type": "SaaS", "summary": "Update a 'resource.Membership' resource.", "operationId": "PatchResourceMembership", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.resource.Membership" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'resource.Membership' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/resource.Membership" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'resource.Membership' resource was patched as requested. The 'resource.Membership' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/resource.Membership" } } }, "links": { "GetResourceMembershipByMoid": { "operationId": "GetResourceMembershipByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/resource/Memberships/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/resource/MembershipHolders": { "get": { "tags": [ "resource" ], "summary": "Read a 'resource.MembershipHolder' resource.", "operationId": "GetResourceMembershipHolderList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "READ.resource.MembershipHolder" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'resource.MembershipHolder' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/resource.MembershipHolder.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/resource/MembershipHolders/{Moid}": { "get": { "tags": [ "resource" ], "summary": "Read a 'resource.MembershipHolder' resource.", "operationId": "GetResourceMembershipHolderByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "READ.resource.MembershipHolder" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'resource.MembershipHolder' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/resource.MembershipHolder" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetResourceMembershipHolderByMoid": { "operationId": "GetResourceMembershipHolderByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/resource/MembershipHolders/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/resource/Reservations": { "get": { "tags": [ "resource" ], "summary": "Read a 'resource.Reservation' resource.", "operationId": "GetResourceReservationList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Organizations", "PRIVSET.Read Organizations", "PRIVSET.Read-Only", "PRIVSET.Read-only Fabric Interconnects", "PRIVSET.Read-only chassis", "PRIVSET.Read-only servers", "PRIVSET.View Organizations", "READ.resource.Reservation", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'resource.Reservation' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/resource.Reservation.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "resource" ], "summary": "Create a 'resource.Reservation' resource.", "operationId": "CreateResourceReservation", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.resource.Reservation", "PRIVSET.Account Administrator", "PRIVSET.Claim targets", "PRIVSET.Manage Organizations", "PRIVSET.View Organizations", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'resource.Reservation' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/resource.Reservation" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'resource.Reservation' resource was created as requested. The 'resource.Reservation' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/resource.Reservation" } } }, "links": { "GetResourceReservationByMoid": { "operationId": "GetResourceReservationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/resource/Reservations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/resource/Reservations/{Moid}": { "get": { "tags": [ "resource" ], "summary": "Read a 'resource.Reservation' resource.", "operationId": "GetResourceReservationByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Organizations", "PRIVSET.Read Organizations", "PRIVSET.Read-Only", "PRIVSET.Read-only Fabric Interconnects", "PRIVSET.Read-only chassis", "PRIVSET.Read-only servers", "PRIVSET.View Organizations", "READ.resource.Reservation", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'resource.Reservation' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/resource.Reservation" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetResourceReservationByMoid": { "operationId": "GetResourceReservationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/resource/Reservations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "resource" ], "summary": "Update a 'resource.Reservation' resource.", "operationId": "UpdateResourceReservation", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Claim targets", "PRIVSET.Manage Organizations", "PRIVSET.Unclaim targets", "PRIVSET.View Organizations", "ROLE.Account Administrator", "UPDATE.resource.Reservation" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'resource.Reservation' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/resource.Reservation" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'resource.Reservation' resource was modified as requested. The 'resource.Reservation' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/resource.Reservation" } } }, "links": { "GetResourceReservationByMoid": { "operationId": "GetResourceReservationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/resource/Reservations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "resource" ], "summary": "Update a 'resource.Reservation' resource.", "operationId": "PatchResourceReservation", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Claim targets", "PRIVSET.Manage Organizations", "PRIVSET.Unclaim targets", "PRIVSET.View Organizations", "ROLE.Account Administrator", "UPDATE.resource.Reservation" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'resource.Reservation' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/resource.Reservation" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'resource.Reservation' resource was patched as requested. The 'resource.Reservation' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/resource.Reservation" } } }, "links": { "GetResourceReservationByMoid": { "operationId": "GetResourceReservationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/resource/Reservations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "resource" ], "summary": "Delete a 'resource.Reservation' resource.", "operationId": "DeleteResourceReservation", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.resource.Reservation", "PRIVSET.Account Administrator", "PRIVSET.Manage Organizations", "PRIVSET.Unclaim targets", "PRIVSET.View Organizations", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/resource/SelectionCriteria": { "get": { "tags": [ "resource" ], "summary": "Read a 'resource.SelectionCriteria' resource.", "operationId": "GetResourceSelectionCriteriaList", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Catalog Administrator", "PRIVSET.Read Organizations", "PRIVSET.Read-Only", "PRIVSET.Service Designer", "PRIVSET.Service Operator", "READ.resource.SelectionCriteria", "ROLE.Account Administrator", "ROLE.Catalog Administrator", "ROLE.Read-Only", "ROLE.Service Designer", "ROLE.Service Operator" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'resource.SelectionCriteria' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/resource.SelectionCriteria.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "resource" ], "summary": "Create a 'resource.SelectionCriteria' resource.", "operationId": "CreateResourceSelectionCriteria", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.resource.SelectionCriteria", "PRIVSET.Account Administrator", "PRIVSET.Catalog Administrator", "PRIVSET.Service Designer", "ROLE.Account Administrator", "ROLE.Catalog Administrator", "ROLE.Service Designer" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'resource.SelectionCriteria' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/resource.SelectionCriteria" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'resource.SelectionCriteria' resource was created as requested. The 'resource.SelectionCriteria' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/resource.SelectionCriteria" } } }, "links": { "GetResourceSelectionCriteriaByMoid": { "operationId": "GetResourceSelectionCriteriaByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/resource/SelectionCriteria/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/resource/SelectionCriteria/{Moid}": { "get": { "tags": [ "resource" ], "summary": "Read a 'resource.SelectionCriteria' resource.", "operationId": "GetResourceSelectionCriteriaByMoid", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Catalog Administrator", "PRIVSET.Read Organizations", "PRIVSET.Read-Only", "PRIVSET.Service Designer", "PRIVSET.Service Operator", "READ.resource.SelectionCriteria", "ROLE.Account Administrator", "ROLE.Catalog Administrator", "ROLE.Read-Only", "ROLE.Service Designer", "ROLE.Service Operator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'resource.SelectionCriteria' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/resource.SelectionCriteria" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetResourceSelectionCriteriaByMoid": { "operationId": "GetResourceSelectionCriteriaByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/resource/SelectionCriteria/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "resource" ], "summary": "Update a 'resource.SelectionCriteria' resource.", "operationId": "UpdateResourceSelectionCriteria", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Catalog Administrator", "PRIVSET.Service Designer", "ROLE.Account Administrator", "ROLE.Catalog Administrator", "ROLE.Service Designer", "UPDATE.resource.SelectionCriteria" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'resource.SelectionCriteria' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/resource.SelectionCriteria" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'resource.SelectionCriteria' resource was modified as requested. The 'resource.SelectionCriteria' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/resource.SelectionCriteria" } } }, "links": { "GetResourceSelectionCriteriaByMoid": { "operationId": "GetResourceSelectionCriteriaByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/resource/SelectionCriteria/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "resource" ], "summary": "Update a 'resource.SelectionCriteria' resource.", "operationId": "PatchResourceSelectionCriteria", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Catalog Administrator", "PRIVSET.Service Designer", "ROLE.Account Administrator", "ROLE.Catalog Administrator", "ROLE.Service Designer", "UPDATE.resource.SelectionCriteria" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'resource.SelectionCriteria' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/resource.SelectionCriteria" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'resource.SelectionCriteria' resource was patched as requested. The 'resource.SelectionCriteria' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/resource.SelectionCriteria" } } }, "links": { "GetResourceSelectionCriteriaByMoid": { "operationId": "GetResourceSelectionCriteriaByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/resource/SelectionCriteria/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "resource" ], "summary": "Delete a 'resource.SelectionCriteria' resource.", "operationId": "DeleteResourceSelectionCriteria", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.resource.SelectionCriteria", "PRIVSET.Account Administrator", "PRIVSET.Catalog Administrator", "PRIVSET.Service Designer", "ROLE.Account Administrator", "ROLE.Catalog Administrator", "ROLE.Service Designer" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/resource/SharedResourcesInfoHolders": { "get": { "tags": [ "resource" ], "summary": "Read a 'resource.SharedResourcesInfoHolder' resource.", "operationId": "GetResourceSharedResourcesInfoHolderList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read Organizations", "PRIVSET.Read-Only", "PRIVSET.View Organizations", "READ.resource.SharedResourcesInfoHolder", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'resource.SharedResourcesInfoHolder' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/resource.SharedResourcesInfoHolder.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/resource/SharedResourcesInfoHolders/{Moid}": { "get": { "tags": [ "resource" ], "summary": "Read a 'resource.SharedResourcesInfoHolder' resource.", "operationId": "GetResourceSharedResourcesInfoHolderByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read Organizations", "PRIVSET.Read-Only", "PRIVSET.View Organizations", "READ.resource.SharedResourcesInfoHolder", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'resource.SharedResourcesInfoHolder' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/resource.SharedResourcesInfoHolder" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetResourceSharedResourcesInfoHolderByMoid": { "operationId": "GetResourceSharedResourcesInfoHolderByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/resource/SharedResourcesInfoHolders/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/servicenow/ChangeRequests": { "get": { "tags": [ "servicenow" ], "x-intersight-type": "SaaS", "summary": "Read a 'servicenow.ChangeRequest' resource.", "operationId": "GetServicenowChangeRequestList", "deprecated": true, "x-sunset": "2026-12-19", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.servicenow.ChangeRequest", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'servicenow.ChangeRequest' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/servicenow.ChangeRequest.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/servicenow/ChangeRequests/{Moid}": { "get": { "tags": [ "servicenow" ], "x-intersight-type": "SaaS", "summary": "Read a 'servicenow.ChangeRequest' resource.", "operationId": "GetServicenowChangeRequestByMoid", "deprecated": true, "x-sunset": "2026-12-19", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.servicenow.ChangeRequest", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'servicenow.ChangeRequest' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/servicenow.ChangeRequest" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetServicenowChangeRequestByMoid": { "operationId": "GetServicenowChangeRequestByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/servicenow/ChangeRequests/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/servicenow/ChangeRequestDocs": { "get": { "tags": [ "servicenow" ], "x-intersight-type": "SaaS", "summary": "Read a 'servicenow.ChangeRequestDoc' resource.", "operationId": "GetServicenowChangeRequestDocList", "deprecated": true, "x-sunset": "2026-12-19", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.servicenow.ChangeRequestDoc", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'servicenow.ChangeRequestDoc' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/servicenow.ChangeRequestDoc.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/servicenow/ChangeRequestDocs/{Moid}": { "get": { "tags": [ "servicenow" ], "x-intersight-type": "SaaS", "summary": "Read a 'servicenow.ChangeRequestDoc' resource.", "operationId": "GetServicenowChangeRequestDocByMoid", "deprecated": true, "x-sunset": "2026-12-19", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.servicenow.ChangeRequestDoc", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'servicenow.ChangeRequestDoc' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/servicenow.ChangeRequestDoc" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetServicenowChangeRequestDocByMoid": { "operationId": "GetServicenowChangeRequestDocByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/servicenow/ChangeRequestDocs/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/servicenow/Incidents": { "get": { "tags": [ "servicenow" ], "x-intersight-type": "SaaS", "summary": "Read a 'servicenow.Incident' resource.", "operationId": "GetServicenowIncidentList", "deprecated": true, "x-sunset": "2026-12-19", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.servicenow.Incident", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'servicenow.Incident' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/servicenow.Incident.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/servicenow/Incidents/{Moid}": { "get": { "tags": [ "servicenow" ], "x-intersight-type": "SaaS", "summary": "Read a 'servicenow.Incident' resource.", "operationId": "GetServicenowIncidentByMoid", "deprecated": true, "x-sunset": "2026-12-19", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.servicenow.Incident", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'servicenow.Incident' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/servicenow.Incident" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetServicenowIncidentByMoid": { "operationId": "GetServicenowIncidentByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/servicenow/Incidents/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/servicenow/IncidentDocs": { "get": { "tags": [ "servicenow" ], "x-intersight-type": "SaaS", "summary": "Read a 'servicenow.IncidentDoc' resource.", "operationId": "GetServicenowIncidentDocList", "deprecated": true, "x-sunset": "2026-12-19", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.servicenow.IncidentDoc", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'servicenow.IncidentDoc' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/servicenow.IncidentDoc.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/servicenow/IncidentDocs/{Moid}": { "get": { "tags": [ "servicenow" ], "x-intersight-type": "SaaS", "summary": "Read a 'servicenow.IncidentDoc' resource.", "operationId": "GetServicenowIncidentDocByMoid", "deprecated": true, "x-sunset": "2026-12-19", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.servicenow.IncidentDoc", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'servicenow.IncidentDoc' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/servicenow.IncidentDoc" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetServicenowIncidentDocByMoid": { "operationId": "GetServicenowIncidentDocByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/servicenow/IncidentDocs/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/task/CatalystSdwanScopedInventories": { "post": { "tags": [ "task" ], "x-intersight-type": "SaaS", "summary": "Create a 'task.CatalystSdwanScopedInventory' resource.", "operationId": "CreateTaskCatalystSdwanScopedInventory", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.task.CatalystSdwanScopedInventory", "PRIVSET.Account Administrator", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'task.CatalystSdwanScopedInventory' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/task.CatalystSdwanScopedInventory" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'task.CatalystSdwanScopedInventory' resource was created as requested. The 'task.CatalystSdwanScopedInventory' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/task.CatalystSdwanScopedInventory" } } }, "links": { "GetTaskCatalystSdwanScopedInventoryByMoid": { "operationId": "GetTaskCatalystSdwanScopedInventoryByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/task/CatalystSdwanScopedInventories/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/task/FabricMosScopedInventories": { "post": { "tags": [ "task" ], "summary": "Create a 'task.FabricMosScopedInventory' resource.", "operationId": "CreateTaskFabricMosScopedInventory", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.task.FabricMosScopedInventory", "PRIVSET.Account Administrator", "PRIVSET.SAN Administrator", "ROLE.Account Administrator", "ROLE.SAN Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'task.FabricMosScopedInventory' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/task.FabricMosScopedInventory" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'task.FabricMosScopedInventory' resource was created as requested. The 'task.FabricMosScopedInventory' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/task.FabricMosScopedInventory" } } }, "links": { "GetTaskFabricMosScopedInventoryByMoid": { "operationId": "GetTaskFabricMosScopedInventoryByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/task/FabricMosScopedInventories/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/task/HciScopedInventories": { "post": { "tags": [ "task" ], "summary": "Create a 'task.HciScopedInventory' resource.", "operationId": "CreateTaskHciScopedInventory", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.task.HciScopedInventory", "PRIVSET.Account Administrator", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'task.HciScopedInventory' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/task.HciScopedInventory" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'task.HciScopedInventory' resource was created as requested. The 'task.HciScopedInventory' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/task.HciScopedInventory" } } }, "links": { "GetTaskHciScopedInventoryByMoid": { "operationId": "GetTaskHciScopedInventoryByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/task/HciScopedInventories/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/task/HitachiScopedInventories": { "post": { "tags": [ "task" ], "summary": "Create a 'task.HitachiScopedInventory' resource.", "operationId": "CreateTaskHitachiScopedInventory", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.task.HitachiScopedInventory", "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'task.HitachiScopedInventory' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/task.HitachiScopedInventory" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'task.HitachiScopedInventory' resource was created as requested. The 'task.HitachiScopedInventory' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/task.HitachiScopedInventory" } } }, "links": { "GetTaskHitachiScopedInventoryByMoid": { "operationId": "GetTaskHitachiScopedInventoryByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/task/HitachiScopedInventories/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/task/HyperFlexManagementScopedInventories": { "post": { "tags": [ "task" ], "summary": "Create a 'task.HyperFlexManagementScopedInventory' resource.", "operationId": "CreateTaskHyperFlexManagementScopedInventory", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.task.HyperFlexManagementScopedInventory", "PRIVSET.Account Administrator", "PRIVSET.Manage HyperFlex Clusters", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'task.HyperFlexManagementScopedInventory' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/task.HyperFlexManagementScopedInventory" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'task.HyperFlexManagementScopedInventory' resource was created as requested. The 'task.HyperFlexManagementScopedInventory' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/task.HyperFlexManagementScopedInventory" } } }, "links": { "GetTaskHyperFlexManagementScopedInventoryByMoid": { "operationId": "GetTaskHyperFlexManagementScopedInventoryByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/task/HyperFlexManagementScopedInventories/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/task/HyperflexScopedInventories": { "post": { "tags": [ "task" ], "summary": "Create a 'task.HyperflexScopedInventory' resource.", "operationId": "CreateTaskHyperflexScopedInventory", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.task.HyperflexScopedInventory", "PRIVSET.Account Administrator", "PRIVSET.Manage HyperFlex Clusters", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'task.HyperflexScopedInventory' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/task.HyperflexScopedInventory" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'task.HyperflexScopedInventory' resource was created as requested. The 'task.HyperflexScopedInventory' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/task.HyperflexScopedInventory" } } }, "links": { "GetTaskHyperflexScopedInventoryByMoid": { "operationId": "GetTaskHyperflexScopedInventoryByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/task/HyperflexScopedInventories/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/task/MdsScopedInventories": { "post": { "tags": [ "task" ], "summary": "Create a 'task.MdsScopedInventory' resource.", "operationId": "CreateTaskMdsScopedInventory", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.task.MdsScopedInventory", "PRIVSET.Account Administrator", "PRIVSET.Network Administrator", "PRIVSET.SAN Administrator", "ROLE.Account Administrator", "ROLE.Network Administrator", "ROLE.SAN Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'task.MdsScopedInventory' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/task.MdsScopedInventory" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'task.MdsScopedInventory' resource was created as requested. The 'task.MdsScopedInventory' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/task.MdsScopedInventory" } } }, "links": { "GetTaskMdsScopedInventoryByMoid": { "operationId": "GetTaskMdsScopedInventoryByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/task/MdsScopedInventories/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/task/MdsSystemScopedInventories": { "post": { "tags": [ "task" ], "summary": "Create a 'task.MdsSystemScopedInventory' resource.", "operationId": "CreateTaskMdsSystemScopedInventory", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.task.MdsSystemScopedInventory", "PRIVSET.Account Administrator", "PRIVSET.Network Administrator", "PRIVSET.SAN Administrator", "ROLE.Account Administrator", "ROLE.Network Administrator", "ROLE.SAN Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'task.MdsSystemScopedInventory' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/task.MdsSystemScopedInventory" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'task.MdsSystemScopedInventory' resource was created as requested. The 'task.MdsSystemScopedInventory' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/task.MdsSystemScopedInventory" } } }, "links": { "GetTaskMdsSystemScopedInventoryByMoid": { "operationId": "GetTaskMdsSystemScopedInventoryByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/task/MdsSystemScopedInventories/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/task/MerakiScopedInventories": { "post": { "tags": [ "task" ], "x-intersight-type": "SaaS", "summary": "Create a 'task.MerakiScopedInventory' resource.", "operationId": "CreateTaskMerakiScopedInventory", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.task.MerakiScopedInventory", "PRIVSET.Account Administrator", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'task.MerakiScopedInventory' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/task.MerakiScopedInventory" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'task.MerakiScopedInventory' resource was created as requested. The 'task.MerakiScopedInventory' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/task.MerakiScopedInventory" } } }, "links": { "GetTaskMerakiScopedInventoryByMoid": { "operationId": "GetTaskMerakiScopedInventoryByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/task/MerakiScopedInventories/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/task/NetAppScopedInventories": { "post": { "tags": [ "task" ], "summary": "Create a 'task.NetAppScopedInventory' resource.", "operationId": "CreateTaskNetAppScopedInventory", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.task.NetAppScopedInventory", "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'task.NetAppScopedInventory' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/task.NetAppScopedInventory" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'task.NetAppScopedInventory' resource was created as requested. The 'task.NetAppScopedInventory' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/task.NetAppScopedInventory" } } }, "links": { "GetTaskNetAppScopedInventoryByMoid": { "operationId": "GetTaskNetAppScopedInventoryByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/task/NetAppScopedInventories/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/task/NexusScopedInventories": { "post": { "tags": [ "task" ], "summary": "Create a 'task.NexusScopedInventory' resource.", "operationId": "CreateTaskNexusScopedInventory", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.task.NexusScopedInventory", "PRIVSET.Account Administrator", "PRIVSET.Network Administrator", "ROLE.Account Administrator", "ROLE.Network Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'task.NexusScopedInventory' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/task.NexusScopedInventory" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'task.NexusScopedInventory' resource was created as requested. The 'task.NexusScopedInventory' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/task.NexusScopedInventory" } } }, "links": { "GetTaskNexusScopedInventoryByMoid": { "operationId": "GetTaskNexusScopedInventoryByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/task/NexusScopedInventories/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/task/NexusSystemScopedInventories": { "post": { "tags": [ "task" ], "summary": "Create a 'task.NexusSystemScopedInventory' resource.", "operationId": "CreateTaskNexusSystemScopedInventory", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.task.NexusSystemScopedInventory", "PRIVSET.Account Administrator", "PRIVSET.Network Administrator", "ROLE.Account Administrator", "ROLE.Network Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'task.NexusSystemScopedInventory' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/task.NexusSystemScopedInventory" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'task.NexusSystemScopedInventory' resource was created as requested. The 'task.NexusSystemScopedInventory' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/task.NexusSystemScopedInventory" } } }, "links": { "GetTaskNexusSystemScopedInventoryByMoid": { "operationId": "GetTaskNexusSystemScopedInventoryByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/task/NexusSystemScopedInventories/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/task/NexusVlanScopedInventories": { "post": { "tags": [ "task" ], "summary": "Create a 'task.NexusVlanScopedInventory' resource.", "operationId": "CreateTaskNexusVlanScopedInventory", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.task.NexusVlanScopedInventory", "PRIVSET.Account Administrator", "PRIVSET.Network Administrator", "ROLE.Account Administrator", "ROLE.Network Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'task.NexusVlanScopedInventory' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/task.NexusVlanScopedInventory" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'task.NexusVlanScopedInventory' resource was created as requested. The 'task.NexusVlanScopedInventory' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/task.NexusVlanScopedInventory" } } }, "links": { "GetTaskNexusVlanScopedInventoryByMoid": { "operationId": "GetTaskNexusVlanScopedInventoryByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/task/NexusVlanScopedInventories/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/task/PureFlashBladeScopedInventories": { "post": { "tags": [ "task" ], "summary": "Create a 'task.PureFlashBladeScopedInventory' resource.", "operationId": "CreateTaskPureFlashBladeScopedInventory", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.task.PureFlashBladeScopedInventory", "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'task.PureFlashBladeScopedInventory' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/task.PureFlashBladeScopedInventory" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'task.PureFlashBladeScopedInventory' resource was created as requested. The 'task.PureFlashBladeScopedInventory' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/task.PureFlashBladeScopedInventory" } } }, "links": { "GetTaskPureFlashBladeScopedInventoryByMoid": { "operationId": "GetTaskPureFlashBladeScopedInventoryByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/task/PureFlashBladeScopedInventories/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/task/PureScopedInventories": { "post": { "tags": [ "task" ], "summary": "Create a 'task.PureScopedInventory' resource.", "operationId": "CreateTaskPureScopedInventory", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.task.PureScopedInventory", "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'task.PureScopedInventory' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/task.PureScopedInventory" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'task.PureScopedInventory' resource was created as requested. The 'task.PureScopedInventory' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/task.PureScopedInventory" } } }, "links": { "GetTaskPureScopedInventoryByMoid": { "operationId": "GetTaskPureScopedInventoryByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/task/PureScopedInventories/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/task/ServerScopedInventories": { "post": { "tags": [ "task" ], "summary": "Create a 'task.ServerScopedInventory' resource.", "operationId": "CreateTaskServerScopedInventory", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.task.ServerScopedInventory", "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'task.ServerScopedInventory' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/task.ServerScopedInventory" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'task.ServerScopedInventory' resource was created as requested. The 'task.ServerScopedInventory' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/task.ServerScopedInventory" } } }, "links": { "GetTaskServerScopedInventoryByMoid": { "operationId": "GetTaskServerScopedInventoryByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/task/ServerScopedInventories/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/ucsd/BackupInfos": { "get": { "tags": [ "ucsd" ], "summary": "Read a 'ucsd.BackupInfo' resource.", "operationId": "GetUcsdBackupInfoList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.ucsd.BackupInfo", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'ucsd.BackupInfo' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ucsd.BackupInfo.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/ucsd/BackupInfos/{Moid}": { "get": { "tags": [ "ucsd" ], "summary": "Read a 'ucsd.BackupInfo' resource.", "operationId": "GetUcsdBackupInfoByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.ucsd.BackupInfo", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'ucsd.BackupInfo' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ucsd.BackupInfo" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetUcsdBackupInfoByMoid": { "operationId": "GetUcsdBackupInfoByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/ucsd/BackupInfos/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "ucsd" ], "summary": "Delete a 'ucsd.BackupInfo' resource.", "operationId": "DeleteUcsdBackupInfo", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.ucsd.BackupInfo", "PRIVSET.Account Administrator", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/webhook/Endpoints": { "post": { "tags": [ "webhook" ], "x-intersight-type": "SaaS", "summary": "Create a 'webhook.Endpoint' resource.", "operationId": "CreateWebhookEndpoint", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.webhook.Endpoint", "PRIVSET.Account Administrator", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'webhook.Endpoint' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook.Endpoint" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'webhook.Endpoint' resource was created as requested. The 'webhook.Endpoint' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook.Endpoint" } } }, "links": { "GetWebhookEndpointByMoid": { "operationId": "GetWebhookEndpointByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/webhook/Endpoints/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "get": { "tags": [ "webhook" ], "x-intersight-type": "SaaS", "summary": "Read a 'webhook.Endpoint' resource.", "operationId": "GetWebhookEndpointList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.webhook.Endpoint", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'webhook.Endpoint' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook.Endpoint.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/webhook/Endpoints/{Moid}": { "get": { "tags": [ "webhook" ], "x-intersight-type": "SaaS", "summary": "Read a 'webhook.Endpoint' resource.", "operationId": "GetWebhookEndpointByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.webhook.Endpoint", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'webhook.Endpoint' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook.Endpoint" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetWebhookEndpointByMoid": { "operationId": "GetWebhookEndpointByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/webhook/Endpoints/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "webhook" ], "x-intersight-type": "SaaS", "summary": "Update a 'webhook.Endpoint' resource.", "operationId": "UpdateWebhookEndpoint", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.webhook.Endpoint" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'webhook.Endpoint' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook.Endpoint" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'webhook.Endpoint' resource was modified as requested. The 'webhook.Endpoint' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook.Endpoint" } } }, "links": { "GetWebhookEndpointByMoid": { "operationId": "GetWebhookEndpointByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/webhook/Endpoints/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "webhook" ], "x-intersight-type": "SaaS", "summary": "Update a 'webhook.Endpoint' resource.", "operationId": "PatchWebhookEndpoint", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.webhook.Endpoint" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'webhook.Endpoint' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook.Endpoint" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'webhook.Endpoint' resource was patched as requested. The 'webhook.Endpoint' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook.Endpoint" } } }, "links": { "GetWebhookEndpointByMoid": { "operationId": "GetWebhookEndpointByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/webhook/Endpoints/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "webhook" ], "x-intersight-type": "SaaS", "summary": "Delete a 'webhook.Endpoint' resource.", "operationId": "DeleteWebhookEndpoint", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.webhook.Endpoint", "PRIVSET.Account Administrator", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/webhook/Schemas": { "post": { "tags": [ "webhook" ], "x-intersight-type": "SaaS", "summary": "Create a 'webhook.Schema' resource.", "operationId": "CreateWebhookSchema", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.webhook.Schema", "PRIVSET.Account Administrator", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'webhook.Schema' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook.Schema" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'webhook.Schema' resource was created as requested. The 'webhook.Schema' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook.Schema" } } }, "links": { "GetWebhookSchemaByMoid": { "operationId": "GetWebhookSchemaByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/webhook/Schemas/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "get": { "tags": [ "webhook" ], "x-intersight-type": "SaaS", "summary": "Read a 'webhook.Schema' resource.", "operationId": "GetWebhookSchemaList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.webhook.Schema", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'webhook.Schema' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook.Schema.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/webhook/Schemas/{Moid}": { "get": { "tags": [ "webhook" ], "x-intersight-type": "SaaS", "summary": "Read a 'webhook.Schema' resource.", "operationId": "GetWebhookSchemaByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.webhook.Schema", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'webhook.Schema' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook.Schema" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetWebhookSchemaByMoid": { "operationId": "GetWebhookSchemaByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/webhook/Schemas/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "webhook" ], "x-intersight-type": "SaaS", "summary": "Update a 'webhook.Schema' resource.", "operationId": "UpdateWebhookSchema", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.webhook.Schema" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'webhook.Schema' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook.Schema" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'webhook.Schema' resource was modified as requested. The 'webhook.Schema' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook.Schema" } } }, "links": { "GetWebhookSchemaByMoid": { "operationId": "GetWebhookSchemaByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/webhook/Schemas/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "webhook" ], "x-intersight-type": "SaaS", "summary": "Update a 'webhook.Schema' resource.", "operationId": "PatchWebhookSchema", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.webhook.Schema" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'webhook.Schema' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook.Schema" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'webhook.Schema' resource was patched as requested. The 'webhook.Schema' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook.Schema" } } }, "links": { "GetWebhookSchemaByMoid": { "operationId": "GetWebhookSchemaByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/webhook/Schemas/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "webhook" ], "x-intersight-type": "SaaS", "summary": "Delete a 'webhook.Schema' resource.", "operationId": "DeleteWebhookSchema", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.webhook.Schema", "PRIVSET.Account Administrator", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/AnsibleBatchExecutors": { "get": { "tags": [ "workflow" ], "summary": "Read a 'workflow.AnsibleBatchExecutor' resource.", "operationId": "GetWorkflowAnsibleBatchExecutorList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Workflow Definitions", "PRIVSET.Read-Only", "PRIVSET.View Workflow Definitions", "READ.workflow.AnsibleBatchExecutor", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'workflow.AnsibleBatchExecutor' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.AnsibleBatchExecutor.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "workflow" ], "summary": "Create a 'workflow.AnsibleBatchExecutor' resource.", "operationId": "CreateWorkflowAnsibleBatchExecutor", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.workflow.AnsibleBatchExecutor", "PRIVSET.Account Administrator", "PRIVSET.Manage Workflow Definitions", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'workflow.AnsibleBatchExecutor' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.AnsibleBatchExecutor" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.AnsibleBatchExecutor' resource was created as requested. The 'workflow.AnsibleBatchExecutor' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.AnsibleBatchExecutor" } } }, "links": { "GetWorkflowAnsibleBatchExecutorByMoid": { "operationId": "GetWorkflowAnsibleBatchExecutorByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/AnsibleBatchExecutors/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/AnsibleBatchExecutors/{Moid}": { "get": { "tags": [ "workflow" ], "summary": "Read a 'workflow.AnsibleBatchExecutor' resource.", "operationId": "GetWorkflowAnsibleBatchExecutorByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Workflow Definitions", "PRIVSET.Read-Only", "PRIVSET.View Workflow Definitions", "READ.workflow.AnsibleBatchExecutor", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'workflow.AnsibleBatchExecutor' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.AnsibleBatchExecutor" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetWorkflowAnsibleBatchExecutorByMoid": { "operationId": "GetWorkflowAnsibleBatchExecutorByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/AnsibleBatchExecutors/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "workflow" ], "summary": "Update a 'workflow.AnsibleBatchExecutor' resource.", "operationId": "UpdateWorkflowAnsibleBatchExecutor", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Workflow Definitions", "ROLE.Account Administrator", "UPDATE.workflow.AnsibleBatchExecutor" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'workflow.AnsibleBatchExecutor' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.AnsibleBatchExecutor" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.AnsibleBatchExecutor' resource was modified as requested. The 'workflow.AnsibleBatchExecutor' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.AnsibleBatchExecutor" } } }, "links": { "GetWorkflowAnsibleBatchExecutorByMoid": { "operationId": "GetWorkflowAnsibleBatchExecutorByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/AnsibleBatchExecutors/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "workflow" ], "summary": "Update a 'workflow.AnsibleBatchExecutor' resource.", "operationId": "PatchWorkflowAnsibleBatchExecutor", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Workflow Definitions", "ROLE.Account Administrator", "UPDATE.workflow.AnsibleBatchExecutor" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'workflow.AnsibleBatchExecutor' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.AnsibleBatchExecutor" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.AnsibleBatchExecutor' resource was patched as requested. The 'workflow.AnsibleBatchExecutor' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.AnsibleBatchExecutor" } } }, "links": { "GetWorkflowAnsibleBatchExecutorByMoid": { "operationId": "GetWorkflowAnsibleBatchExecutorByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/AnsibleBatchExecutors/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "workflow" ], "summary": "Delete a 'workflow.AnsibleBatchExecutor' resource.", "operationId": "DeleteWorkflowAnsibleBatchExecutor", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.workflow.AnsibleBatchExecutor", "PRIVSET.Account Administrator", "PRIVSET.Manage Workflow Definitions", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/BatchApiExecutors": { "get": { "tags": [ "workflow" ], "summary": "Read a 'workflow.BatchApiExecutor' resource.", "operationId": "GetWorkflowBatchApiExecutorList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Workflow Definitions", "PRIVSET.Read-Only", "PRIVSET.View Workflow Definitions", "READ.workflow.BatchApiExecutor", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'workflow.BatchApiExecutor' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.BatchApiExecutor.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "workflow" ], "summary": "Create a 'workflow.BatchApiExecutor' resource.", "operationId": "CreateWorkflowBatchApiExecutor", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.workflow.BatchApiExecutor", "PRIVSET.Account Administrator", "PRIVSET.Manage Workflow Definitions", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'workflow.BatchApiExecutor' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.BatchApiExecutor" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.BatchApiExecutor' resource was created as requested. The 'workflow.BatchApiExecutor' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.BatchApiExecutor" } } }, "links": { "GetWorkflowBatchApiExecutorByMoid": { "operationId": "GetWorkflowBatchApiExecutorByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/BatchApiExecutors/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/BatchApiExecutors/{Moid}": { "get": { "tags": [ "workflow" ], "summary": "Read a 'workflow.BatchApiExecutor' resource.", "operationId": "GetWorkflowBatchApiExecutorByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Workflow Definitions", "PRIVSET.Read-Only", "PRIVSET.View Workflow Definitions", "READ.workflow.BatchApiExecutor", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'workflow.BatchApiExecutor' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.BatchApiExecutor" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetWorkflowBatchApiExecutorByMoid": { "operationId": "GetWorkflowBatchApiExecutorByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/BatchApiExecutors/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "workflow" ], "summary": "Update a 'workflow.BatchApiExecutor' resource.", "operationId": "UpdateWorkflowBatchApiExecutor", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Workflow Definitions", "ROLE.Account Administrator", "UPDATE.workflow.BatchApiExecutor" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'workflow.BatchApiExecutor' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.BatchApiExecutor" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.BatchApiExecutor' resource was modified as requested. The 'workflow.BatchApiExecutor' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.BatchApiExecutor" } } }, "links": { "GetWorkflowBatchApiExecutorByMoid": { "operationId": "GetWorkflowBatchApiExecutorByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/BatchApiExecutors/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "workflow" ], "summary": "Update a 'workflow.BatchApiExecutor' resource.", "operationId": "PatchWorkflowBatchApiExecutor", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Workflow Definitions", "ROLE.Account Administrator", "UPDATE.workflow.BatchApiExecutor" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'workflow.BatchApiExecutor' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.BatchApiExecutor" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.BatchApiExecutor' resource was patched as requested. The 'workflow.BatchApiExecutor' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.BatchApiExecutor" } } }, "links": { "GetWorkflowBatchApiExecutorByMoid": { "operationId": "GetWorkflowBatchApiExecutorByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/BatchApiExecutors/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "workflow" ], "summary": "Delete a 'workflow.BatchApiExecutor' resource.", "operationId": "DeleteWorkflowBatchApiExecutor", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.workflow.BatchApiExecutor", "PRIVSET.Account Administrator", "PRIVSET.Manage Workflow Definitions", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/Catalogs": { "get": { "tags": [ "workflow" ], "summary": "Read a 'workflow.Catalog' resource.", "operationId": "GetWorkflowCatalogList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read Workflows", "PRIVSET.Read-Only", "PRIVSET.View Workflow Definitions", "READ.workflow.Catalog", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'workflow.Catalog' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.Catalog.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/Catalogs/{Moid}": { "get": { "tags": [ "workflow" ], "summary": "Read a 'workflow.Catalog' resource.", "operationId": "GetWorkflowCatalogByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read Workflows", "PRIVSET.Read-Only", "PRIVSET.View Workflow Definitions", "READ.workflow.Catalog", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'workflow.Catalog' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.Catalog" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetWorkflowCatalogByMoid": { "operationId": "GetWorkflowCatalogByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/Catalogs/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/CatalogItemDefinitions": { "get": { "tags": [ "workflow" ], "summary": "Read a 'workflow.CatalogItemDefinition' resource.", "operationId": "GetWorkflowCatalogItemDefinitionList", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Catalog Administrator", "PRIVSET.Catalog User", "PRIVSET.Read-Only", "PRIVSET.Service Operator", "READ.workflow.CatalogItemDefinition", "ROLE.Account Administrator", "ROLE.Catalog Administrator", "ROLE.Catalog User", "ROLE.Read-Only", "ROLE.Service Operator" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'workflow.CatalogItemDefinition' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.CatalogItemDefinition.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "workflow" ], "summary": "Create a 'workflow.CatalogItemDefinition' resource.", "operationId": "CreateWorkflowCatalogItemDefinition", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.workflow.CatalogItemDefinition", "PRIVSET.Account Administrator", "PRIVSET.Catalog Administrator", "ROLE.Account Administrator", "ROLE.Catalog Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'workflow.CatalogItemDefinition' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.CatalogItemDefinition" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.CatalogItemDefinition' resource was created as requested. The 'workflow.CatalogItemDefinition' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.CatalogItemDefinition" } } }, "links": { "GetWorkflowCatalogItemDefinitionByMoid": { "operationId": "GetWorkflowCatalogItemDefinitionByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/CatalogItemDefinitions/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/CatalogItemDefinitions/{Moid}": { "get": { "tags": [ "workflow" ], "summary": "Read a 'workflow.CatalogItemDefinition' resource.", "operationId": "GetWorkflowCatalogItemDefinitionByMoid", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Catalog Administrator", "PRIVSET.Catalog User", "PRIVSET.Read-Only", "PRIVSET.Service Operator", "READ.workflow.CatalogItemDefinition", "ROLE.Account Administrator", "ROLE.Catalog Administrator", "ROLE.Catalog User", "ROLE.Read-Only", "ROLE.Service Operator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'workflow.CatalogItemDefinition' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.CatalogItemDefinition" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetWorkflowCatalogItemDefinitionByMoid": { "operationId": "GetWorkflowCatalogItemDefinitionByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/CatalogItemDefinitions/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "workflow" ], "summary": "Update a 'workflow.CatalogItemDefinition' resource.", "operationId": "UpdateWorkflowCatalogItemDefinition", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Catalog Administrator", "ROLE.Account Administrator", "ROLE.Catalog Administrator", "UPDATE.workflow.CatalogItemDefinition" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'workflow.CatalogItemDefinition' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.CatalogItemDefinition" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.CatalogItemDefinition' resource was modified as requested. The 'workflow.CatalogItemDefinition' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.CatalogItemDefinition" } } }, "links": { "GetWorkflowCatalogItemDefinitionByMoid": { "operationId": "GetWorkflowCatalogItemDefinitionByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/CatalogItemDefinitions/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "workflow" ], "summary": "Update a 'workflow.CatalogItemDefinition' resource.", "operationId": "PatchWorkflowCatalogItemDefinition", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Catalog Administrator", "ROLE.Account Administrator", "ROLE.Catalog Administrator", "UPDATE.workflow.CatalogItemDefinition" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'workflow.CatalogItemDefinition' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.CatalogItemDefinition" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.CatalogItemDefinition' resource was patched as requested. The 'workflow.CatalogItemDefinition' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.CatalogItemDefinition" } } }, "links": { "GetWorkflowCatalogItemDefinitionByMoid": { "operationId": "GetWorkflowCatalogItemDefinitionByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/CatalogItemDefinitions/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "workflow" ], "summary": "Delete a 'workflow.CatalogItemDefinition' resource.", "operationId": "DeleteWorkflowCatalogItemDefinition", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.workflow.CatalogItemDefinition", "PRIVSET.Account Administrator", "PRIVSET.Catalog Administrator", "ROLE.Account Administrator", "ROLE.Catalog Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/CatalogServiceRequests": { "get": { "tags": [ "workflow" ], "summary": "Read a 'workflow.CatalogServiceRequest' resource.", "operationId": "GetWorkflowCatalogServiceRequestList", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Catalog Administrator", "PRIVSET.Catalog User", "PRIVSET.Read-Only", "PRIVSET.Service Operator", "READ.workflow.CatalogServiceRequest", "ROLE.Account Administrator", "ROLE.Catalog Administrator", "ROLE.Catalog User", "ROLE.Read-Only", "ROLE.Service Operator" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'workflow.CatalogServiceRequest' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.CatalogServiceRequest.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "workflow" ], "summary": "Create a 'workflow.CatalogServiceRequest' resource.", "operationId": "CreateWorkflowCatalogServiceRequest", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.workflow.CatalogServiceRequest", "PRIVSET.Account Administrator", "PRIVSET.Catalog Administrator", "PRIVSET.Catalog User", "PRIVSET.Service Operator", "ROLE.Account Administrator", "ROLE.Catalog Administrator", "ROLE.Catalog User", "ROLE.Service Operator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'workflow.CatalogServiceRequest' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.CatalogServiceRequest" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.CatalogServiceRequest' resource was created as requested. The 'workflow.CatalogServiceRequest' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.CatalogServiceRequest" } } }, "links": { "GetWorkflowCatalogServiceRequestByMoid": { "operationId": "GetWorkflowCatalogServiceRequestByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/CatalogServiceRequests/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/CatalogServiceRequests/{Moid}": { "get": { "tags": [ "workflow" ], "summary": "Read a 'workflow.CatalogServiceRequest' resource.", "operationId": "GetWorkflowCatalogServiceRequestByMoid", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Catalog Administrator", "PRIVSET.Catalog User", "PRIVSET.Read-Only", "PRIVSET.Service Operator", "READ.workflow.CatalogServiceRequest", "ROLE.Account Administrator", "ROLE.Catalog Administrator", "ROLE.Catalog User", "ROLE.Read-Only", "ROLE.Service Operator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'workflow.CatalogServiceRequest' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.CatalogServiceRequest" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetWorkflowCatalogServiceRequestByMoid": { "operationId": "GetWorkflowCatalogServiceRequestByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/CatalogServiceRequests/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "workflow" ], "summary": "Update a 'workflow.CatalogServiceRequest' resource.", "operationId": "UpdateWorkflowCatalogServiceRequest", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Catalog Administrator", "PRIVSET.Catalog User", "PRIVSET.Service Operator", "ROLE.Account Administrator", "ROLE.Catalog Administrator", "ROLE.Catalog User", "ROLE.Service Operator", "UPDATE.workflow.CatalogServiceRequest" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'workflow.CatalogServiceRequest' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.CatalogServiceRequest" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.CatalogServiceRequest' resource was modified as requested. The 'workflow.CatalogServiceRequest' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.CatalogServiceRequest" } } }, "links": { "GetWorkflowCatalogServiceRequestByMoid": { "operationId": "GetWorkflowCatalogServiceRequestByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/CatalogServiceRequests/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "workflow" ], "summary": "Update a 'workflow.CatalogServiceRequest' resource.", "operationId": "PatchWorkflowCatalogServiceRequest", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Catalog Administrator", "PRIVSET.Catalog User", "PRIVSET.Service Operator", "ROLE.Account Administrator", "ROLE.Catalog Administrator", "ROLE.Catalog User", "ROLE.Service Operator", "UPDATE.workflow.CatalogServiceRequest" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'workflow.CatalogServiceRequest' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.CatalogServiceRequest" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.CatalogServiceRequest' resource was patched as requested. The 'workflow.CatalogServiceRequest' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.CatalogServiceRequest" } } }, "links": { "GetWorkflowCatalogServiceRequestByMoid": { "operationId": "GetWorkflowCatalogServiceRequestByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/CatalogServiceRequests/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "workflow" ], "summary": "Delete a 'workflow.CatalogServiceRequest' resource.", "operationId": "DeleteWorkflowCatalogServiceRequest", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.workflow.CatalogServiceRequest", "PRIVSET.Account Administrator", "PRIVSET.Catalog Administrator", "ROLE.Account Administrator", "ROLE.Catalog Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/CustomDataTypeDefinitions": { "get": { "tags": [ "workflow" ], "summary": "Read a 'workflow.CustomDataTypeDefinition' resource.", "operationId": "GetWorkflowCustomDataTypeDefinitionList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Catalog User", "PRIVSET.Execute Workflows", "PRIVSET.Manage Workflow Definitions", "PRIVSET.Read Workflows", "PRIVSET.Read-Only", "PRIVSET.View Workflow Definitions", "READ.workflow.CustomDataTypeDefinition", "ROLE.Account Administrator", "ROLE.Catalog User", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'workflow.CustomDataTypeDefinition' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.CustomDataTypeDefinition.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "workflow" ], "summary": "Create a 'workflow.CustomDataTypeDefinition' resource.", "operationId": "CreateWorkflowCustomDataTypeDefinition", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.workflow.CustomDataTypeDefinition", "PRIVSET.Account Administrator", "PRIVSET.Manage Workflow Definitions", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'workflow.CustomDataTypeDefinition' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.CustomDataTypeDefinition" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.CustomDataTypeDefinition' resource was created as requested. The 'workflow.CustomDataTypeDefinition' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.CustomDataTypeDefinition" } } }, "links": { "GetWorkflowCustomDataTypeDefinitionByMoid": { "operationId": "GetWorkflowCustomDataTypeDefinitionByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/CustomDataTypeDefinitions/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/CustomDataTypeDefinitions/{Moid}": { "get": { "tags": [ "workflow" ], "summary": "Read a 'workflow.CustomDataTypeDefinition' resource.", "operationId": "GetWorkflowCustomDataTypeDefinitionByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Catalog User", "PRIVSET.Execute Workflows", "PRIVSET.Manage Workflow Definitions", "PRIVSET.Read Workflows", "PRIVSET.Read-Only", "PRIVSET.View Workflow Definitions", "READ.workflow.CustomDataTypeDefinition", "ROLE.Account Administrator", "ROLE.Catalog User", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'workflow.CustomDataTypeDefinition' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.CustomDataTypeDefinition" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetWorkflowCustomDataTypeDefinitionByMoid": { "operationId": "GetWorkflowCustomDataTypeDefinitionByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/CustomDataTypeDefinitions/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "workflow" ], "summary": "Update a 'workflow.CustomDataTypeDefinition' resource.", "operationId": "UpdateWorkflowCustomDataTypeDefinition", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Workflow Definitions", "ROLE.Account Administrator", "UPDATE.workflow.CustomDataTypeDefinition" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'workflow.CustomDataTypeDefinition' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.CustomDataTypeDefinition" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.CustomDataTypeDefinition' resource was modified as requested. The 'workflow.CustomDataTypeDefinition' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.CustomDataTypeDefinition" } } }, "links": { "GetWorkflowCustomDataTypeDefinitionByMoid": { "operationId": "GetWorkflowCustomDataTypeDefinitionByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/CustomDataTypeDefinitions/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "workflow" ], "summary": "Update a 'workflow.CustomDataTypeDefinition' resource.", "operationId": "PatchWorkflowCustomDataTypeDefinition", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Workflow Definitions", "ROLE.Account Administrator", "UPDATE.workflow.CustomDataTypeDefinition" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'workflow.CustomDataTypeDefinition' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.CustomDataTypeDefinition" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.CustomDataTypeDefinition' resource was patched as requested. The 'workflow.CustomDataTypeDefinition' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.CustomDataTypeDefinition" } } }, "links": { "GetWorkflowCustomDataTypeDefinitionByMoid": { "operationId": "GetWorkflowCustomDataTypeDefinitionByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/CustomDataTypeDefinitions/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "workflow" ], "summary": "Delete a 'workflow.CustomDataTypeDefinition' resource.", "operationId": "DeleteWorkflowCustomDataTypeDefinition", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.workflow.CustomDataTypeDefinition", "PRIVSET.Account Administrator", "PRIVSET.Manage Workflow Definitions", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/ErrorResponseHandlers": { "get": { "tags": [ "workflow" ], "summary": "Read a 'workflow.ErrorResponseHandler' resource.", "operationId": "GetWorkflowErrorResponseHandlerList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Workflow Definitions", "PRIVSET.View Workflow Definitions", "READ.workflow.ErrorResponseHandler", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'workflow.ErrorResponseHandler' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.ErrorResponseHandler.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "workflow" ], "summary": "Create a 'workflow.ErrorResponseHandler' resource.", "operationId": "CreateWorkflowErrorResponseHandler", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.workflow.ErrorResponseHandler", "PRIVSET.Account Administrator", "PRIVSET.Manage Workflow Definitions", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'workflow.ErrorResponseHandler' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.ErrorResponseHandler" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.ErrorResponseHandler' resource was created as requested. The 'workflow.ErrorResponseHandler' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.ErrorResponseHandler" } } }, "links": { "GetWorkflowErrorResponseHandlerByMoid": { "operationId": "GetWorkflowErrorResponseHandlerByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/ErrorResponseHandlers/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/ErrorResponseHandlers/{Moid}": { "get": { "tags": [ "workflow" ], "summary": "Read a 'workflow.ErrorResponseHandler' resource.", "operationId": "GetWorkflowErrorResponseHandlerByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Workflow Definitions", "PRIVSET.View Workflow Definitions", "READ.workflow.ErrorResponseHandler", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'workflow.ErrorResponseHandler' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.ErrorResponseHandler" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetWorkflowErrorResponseHandlerByMoid": { "operationId": "GetWorkflowErrorResponseHandlerByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/ErrorResponseHandlers/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "workflow" ], "summary": "Update a 'workflow.ErrorResponseHandler' resource.", "operationId": "UpdateWorkflowErrorResponseHandler", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Workflow Definitions", "ROLE.Account Administrator", "UPDATE.workflow.ErrorResponseHandler" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'workflow.ErrorResponseHandler' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.ErrorResponseHandler" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.ErrorResponseHandler' resource was modified as requested. The 'workflow.ErrorResponseHandler' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.ErrorResponseHandler" } } }, "links": { "GetWorkflowErrorResponseHandlerByMoid": { "operationId": "GetWorkflowErrorResponseHandlerByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/ErrorResponseHandlers/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "workflow" ], "summary": "Update a 'workflow.ErrorResponseHandler' resource.", "operationId": "PatchWorkflowErrorResponseHandler", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Workflow Definitions", "ROLE.Account Administrator", "UPDATE.workflow.ErrorResponseHandler" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'workflow.ErrorResponseHandler' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.ErrorResponseHandler" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.ErrorResponseHandler' resource was patched as requested. The 'workflow.ErrorResponseHandler' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.ErrorResponseHandler" } } }, "links": { "GetWorkflowErrorResponseHandlerByMoid": { "operationId": "GetWorkflowErrorResponseHandlerByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/ErrorResponseHandlers/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "workflow" ], "summary": "Delete a 'workflow.ErrorResponseHandler' resource.", "operationId": "DeleteWorkflowErrorResponseHandler", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.workflow.ErrorResponseHandler", "PRIVSET.Account Administrator", "PRIVSET.Manage Workflow Definitions", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/PowerShellBatchApiExecutors": { "get": { "tags": [ "workflow" ], "summary": "Read a 'workflow.PowerShellBatchApiExecutor' resource.", "operationId": "GetWorkflowPowerShellBatchApiExecutorList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Workflow Definitions", "PRIVSET.Read-Only", "PRIVSET.View Workflow Definitions", "READ.workflow.PowerShellBatchApiExecutor", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'workflow.PowerShellBatchApiExecutor' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.PowerShellBatchApiExecutor.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "workflow" ], "summary": "Create a 'workflow.PowerShellBatchApiExecutor' resource.", "operationId": "CreateWorkflowPowerShellBatchApiExecutor", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.workflow.PowerShellBatchApiExecutor", "PRIVSET.Account Administrator", "PRIVSET.Manage Workflow Definitions", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'workflow.PowerShellBatchApiExecutor' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.PowerShellBatchApiExecutor" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.PowerShellBatchApiExecutor' resource was created as requested. The 'workflow.PowerShellBatchApiExecutor' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.PowerShellBatchApiExecutor" } } }, "links": { "GetWorkflowPowerShellBatchApiExecutorByMoid": { "operationId": "GetWorkflowPowerShellBatchApiExecutorByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/PowerShellBatchApiExecutors/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/PowerShellBatchApiExecutors/{Moid}": { "get": { "tags": [ "workflow" ], "summary": "Read a 'workflow.PowerShellBatchApiExecutor' resource.", "operationId": "GetWorkflowPowerShellBatchApiExecutorByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Workflow Definitions", "PRIVSET.Read-Only", "PRIVSET.View Workflow Definitions", "READ.workflow.PowerShellBatchApiExecutor", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'workflow.PowerShellBatchApiExecutor' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.PowerShellBatchApiExecutor" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetWorkflowPowerShellBatchApiExecutorByMoid": { "operationId": "GetWorkflowPowerShellBatchApiExecutorByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/PowerShellBatchApiExecutors/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "workflow" ], "summary": "Update a 'workflow.PowerShellBatchApiExecutor' resource.", "operationId": "UpdateWorkflowPowerShellBatchApiExecutor", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Workflow Definitions", "ROLE.Account Administrator", "UPDATE.workflow.PowerShellBatchApiExecutor" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'workflow.PowerShellBatchApiExecutor' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.PowerShellBatchApiExecutor" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.PowerShellBatchApiExecutor' resource was modified as requested. The 'workflow.PowerShellBatchApiExecutor' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.PowerShellBatchApiExecutor" } } }, "links": { "GetWorkflowPowerShellBatchApiExecutorByMoid": { "operationId": "GetWorkflowPowerShellBatchApiExecutorByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/PowerShellBatchApiExecutors/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "workflow" ], "summary": "Update a 'workflow.PowerShellBatchApiExecutor' resource.", "operationId": "PatchWorkflowPowerShellBatchApiExecutor", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Workflow Definitions", "ROLE.Account Administrator", "UPDATE.workflow.PowerShellBatchApiExecutor" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'workflow.PowerShellBatchApiExecutor' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.PowerShellBatchApiExecutor" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.PowerShellBatchApiExecutor' resource was patched as requested. The 'workflow.PowerShellBatchApiExecutor' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.PowerShellBatchApiExecutor" } } }, "links": { "GetWorkflowPowerShellBatchApiExecutorByMoid": { "operationId": "GetWorkflowPowerShellBatchApiExecutorByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/PowerShellBatchApiExecutors/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "workflow" ], "summary": "Delete a 'workflow.PowerShellBatchApiExecutor' resource.", "operationId": "DeleteWorkflowPowerShellBatchApiExecutor", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.workflow.PowerShellBatchApiExecutor", "PRIVSET.Account Administrator", "PRIVSET.Manage Workflow Definitions", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/RollbackWorkflows": { "get": { "tags": [ "workflow" ], "summary": "Read a 'workflow.RollbackWorkflow' resource.", "operationId": "GetWorkflowRollbackWorkflowList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Execute Workflows", "PRIVSET.Manage Workflow Definitions", "PRIVSET.Read-Only", "PRIVSET.View Workflow Definitions", "READ.workflow.RollbackWorkflow", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'workflow.RollbackWorkflow' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.RollbackWorkflow.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "workflow" ], "summary": "Create a 'workflow.RollbackWorkflow' resource.", "operationId": "CreateWorkflowRollbackWorkflow", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.workflow.RollbackWorkflow", "PRIVSET.Account Administrator", "PRIVSET.Execute Workflows", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'workflow.RollbackWorkflow' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.RollbackWorkflow" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.RollbackWorkflow' resource was created as requested. The 'workflow.RollbackWorkflow' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.RollbackWorkflow" } } }, "links": { "GetWorkflowRollbackWorkflowByMoid": { "operationId": "GetWorkflowRollbackWorkflowByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/RollbackWorkflows/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/RollbackWorkflows/{Moid}": { "get": { "tags": [ "workflow" ], "summary": "Read a 'workflow.RollbackWorkflow' resource.", "operationId": "GetWorkflowRollbackWorkflowByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Execute Workflows", "PRIVSET.Manage Workflow Definitions", "PRIVSET.Read-Only", "PRIVSET.View Workflow Definitions", "READ.workflow.RollbackWorkflow", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'workflow.RollbackWorkflow' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.RollbackWorkflow" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetWorkflowRollbackWorkflowByMoid": { "operationId": "GetWorkflowRollbackWorkflowByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/RollbackWorkflows/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "workflow" ], "summary": "Update a 'workflow.RollbackWorkflow' resource.", "operationId": "UpdateWorkflowRollbackWorkflow", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Execute Workflows", "ROLE.Account Administrator", "UPDATE.workflow.RollbackWorkflow" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'workflow.RollbackWorkflow' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.RollbackWorkflow" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.RollbackWorkflow' resource was modified as requested. The 'workflow.RollbackWorkflow' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.RollbackWorkflow" } } }, "links": { "GetWorkflowRollbackWorkflowByMoid": { "operationId": "GetWorkflowRollbackWorkflowByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/RollbackWorkflows/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "workflow" ], "summary": "Update a 'workflow.RollbackWorkflow' resource.", "operationId": "PatchWorkflowRollbackWorkflow", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Execute Workflows", "ROLE.Account Administrator", "UPDATE.workflow.RollbackWorkflow" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'workflow.RollbackWorkflow' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.RollbackWorkflow" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.RollbackWorkflow' resource was patched as requested. The 'workflow.RollbackWorkflow' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.RollbackWorkflow" } } }, "links": { "GetWorkflowRollbackWorkflowByMoid": { "operationId": "GetWorkflowRollbackWorkflowByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/RollbackWorkflows/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "workflow" ], "summary": "Delete a 'workflow.RollbackWorkflow' resource.", "operationId": "DeleteWorkflowRollbackWorkflow", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.workflow.RollbackWorkflow", "PRIVSET.Account Administrator", "PRIVSET.Execute Workflows", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/ServiceItemActionDefinitions": { "get": { "tags": [ "workflow" ], "summary": "Read a 'workflow.ServiceItemActionDefinition' resource.", "operationId": "GetWorkflowServiceItemActionDefinitionList", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Catalog Administrator", "PRIVSET.Catalog User", "PRIVSET.Integrated Systems Administrator", "PRIVSET.Integrated Systems Operator", "PRIVSET.Read-Only", "PRIVSET.Read-only integrated systems", "PRIVSET.Service Designer", "PRIVSET.Service Operator", "PRIVSET.Workload Operator", "READ.workflow.ServiceItemActionDefinition", "ROLE.Account Administrator", "ROLE.Catalog Administrator", "ROLE.Catalog User", "ROLE.Integrated Systems Administrator", "ROLE.Integrated Systems Operator", "ROLE.Read-Only", "ROLE.Service Designer", "ROLE.Service Operator", "ROLE.Workload Operator" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'workflow.ServiceItemActionDefinition' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.ServiceItemActionDefinition.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "workflow" ], "summary": "Create a 'workflow.ServiceItemActionDefinition' resource.", "operationId": "CreateWorkflowServiceItemActionDefinition", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.workflow.ServiceItemActionDefinition", "PRIVSET.Account Administrator", "PRIVSET.Catalog Administrator", "PRIVSET.Integrated Systems Administrator", "PRIVSET.Service Designer", "ROLE.Account Administrator", "ROLE.Catalog Administrator", "ROLE.Integrated Systems Administrator", "ROLE.Service Designer" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'workflow.ServiceItemActionDefinition' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.ServiceItemActionDefinition" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.ServiceItemActionDefinition' resource was created as requested. The 'workflow.ServiceItemActionDefinition' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.ServiceItemActionDefinition" } } }, "links": { "GetWorkflowServiceItemActionDefinitionByMoid": { "operationId": "GetWorkflowServiceItemActionDefinitionByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/ServiceItemActionDefinitions/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/ServiceItemActionDefinitions/{Moid}": { "get": { "tags": [ "workflow" ], "summary": "Read a 'workflow.ServiceItemActionDefinition' resource.", "operationId": "GetWorkflowServiceItemActionDefinitionByMoid", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Catalog Administrator", "PRIVSET.Catalog User", "PRIVSET.Integrated Systems Administrator", "PRIVSET.Integrated Systems Operator", "PRIVSET.Read-Only", "PRIVSET.Read-only integrated systems", "PRIVSET.Service Designer", "PRIVSET.Service Operator", "PRIVSET.Workload Operator", "READ.workflow.ServiceItemActionDefinition", "ROLE.Account Administrator", "ROLE.Catalog Administrator", "ROLE.Catalog User", "ROLE.Integrated Systems Administrator", "ROLE.Integrated Systems Operator", "ROLE.Read-Only", "ROLE.Service Designer", "ROLE.Service Operator", "ROLE.Workload Operator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'workflow.ServiceItemActionDefinition' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.ServiceItemActionDefinition" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetWorkflowServiceItemActionDefinitionByMoid": { "operationId": "GetWorkflowServiceItemActionDefinitionByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/ServiceItemActionDefinitions/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "workflow" ], "summary": "Update a 'workflow.ServiceItemActionDefinition' resource.", "operationId": "UpdateWorkflowServiceItemActionDefinition", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Catalog Administrator", "PRIVSET.Integrated Systems Administrator", "PRIVSET.Service Designer", "ROLE.Account Administrator", "ROLE.Catalog Administrator", "ROLE.Integrated Systems Administrator", "ROLE.Service Designer", "UPDATE.workflow.ServiceItemActionDefinition" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'workflow.ServiceItemActionDefinition' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.ServiceItemActionDefinition" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.ServiceItemActionDefinition' resource was modified as requested. The 'workflow.ServiceItemActionDefinition' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.ServiceItemActionDefinition" } } }, "links": { "GetWorkflowServiceItemActionDefinitionByMoid": { "operationId": "GetWorkflowServiceItemActionDefinitionByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/ServiceItemActionDefinitions/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "workflow" ], "summary": "Update a 'workflow.ServiceItemActionDefinition' resource.", "operationId": "PatchWorkflowServiceItemActionDefinition", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Catalog Administrator", "PRIVSET.Integrated Systems Administrator", "PRIVSET.Service Designer", "ROLE.Account Administrator", "ROLE.Catalog Administrator", "ROLE.Integrated Systems Administrator", "ROLE.Service Designer", "UPDATE.workflow.ServiceItemActionDefinition" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'workflow.ServiceItemActionDefinition' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.ServiceItemActionDefinition" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.ServiceItemActionDefinition' resource was patched as requested. The 'workflow.ServiceItemActionDefinition' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.ServiceItemActionDefinition" } } }, "links": { "GetWorkflowServiceItemActionDefinitionByMoid": { "operationId": "GetWorkflowServiceItemActionDefinitionByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/ServiceItemActionDefinitions/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "workflow" ], "summary": "Delete a 'workflow.ServiceItemActionDefinition' resource.", "operationId": "DeleteWorkflowServiceItemActionDefinition", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.workflow.ServiceItemActionDefinition", "PRIVSET.Account Administrator", "PRIVSET.Catalog Administrator", "PRIVSET.Integrated Systems Administrator", "PRIVSET.Service Designer", "ROLE.Account Administrator", "ROLE.Catalog Administrator", "ROLE.Integrated Systems Administrator", "ROLE.Service Designer" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/ServiceItemActionInstances": { "get": { "tags": [ "workflow" ], "summary": "Read a 'workflow.ServiceItemActionInstance' resource.", "operationId": "GetWorkflowServiceItemActionInstanceList", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Catalog Administrator", "PRIVSET.Catalog User", "PRIVSET.Integrated Systems Administrator", "PRIVSET.Integrated Systems Operator", "PRIVSET.Read-Only", "PRIVSET.Read-only integrated systems", "PRIVSET.Service Designer", "PRIVSET.Service Operator", "PRIVSET.Workload Operator", "READ.workflow.ServiceItemActionInstance", "ROLE.Account Administrator", "ROLE.Catalog Administrator", "ROLE.Catalog User", "ROLE.Integrated Systems Administrator", "ROLE.Integrated Systems Operator", "ROLE.Read-Only", "ROLE.Service Designer", "ROLE.Service Operator", "ROLE.Workload Operator" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'workflow.ServiceItemActionInstance' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.ServiceItemActionInstance.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "workflow" ], "summary": "Create a 'workflow.ServiceItemActionInstance' resource.", "operationId": "CreateWorkflowServiceItemActionInstance", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.workflow.ServiceItemActionInstance", "PRIVSET.Account Administrator", "PRIVSET.Catalog Administrator", "PRIVSET.Create integrated systems", "PRIVSET.Delete integrated systems", "PRIVSET.Edit integrated systems", "PRIVSET.Integrated Systems Administrator", "PRIVSET.Integrated Systems Operator", "PRIVSET.Run interoperability checks", "PRIVSET.Service Designer", "PRIVSET.Service Operator", "PRIVSET.Workload Operator", "ROLE.Account Administrator", "ROLE.Catalog Administrator", "ROLE.Integrated Systems Administrator", "ROLE.Integrated Systems Operator", "ROLE.Service Designer", "ROLE.Service Operator", "ROLE.Workload Operator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'workflow.ServiceItemActionInstance' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.ServiceItemActionInstance" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.ServiceItemActionInstance' resource was created as requested. The 'workflow.ServiceItemActionInstance' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.ServiceItemActionInstance" } } }, "links": { "GetWorkflowServiceItemActionInstanceByMoid": { "operationId": "GetWorkflowServiceItemActionInstanceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/ServiceItemActionInstances/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/ServiceItemActionInstances/{Moid}": { "get": { "tags": [ "workflow" ], "summary": "Read a 'workflow.ServiceItemActionInstance' resource.", "operationId": "GetWorkflowServiceItemActionInstanceByMoid", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Catalog Administrator", "PRIVSET.Catalog User", "PRIVSET.Integrated Systems Administrator", "PRIVSET.Integrated Systems Operator", "PRIVSET.Read-Only", "PRIVSET.Read-only integrated systems", "PRIVSET.Service Designer", "PRIVSET.Service Operator", "PRIVSET.Workload Operator", "READ.workflow.ServiceItemActionInstance", "ROLE.Account Administrator", "ROLE.Catalog Administrator", "ROLE.Catalog User", "ROLE.Integrated Systems Administrator", "ROLE.Integrated Systems Operator", "ROLE.Read-Only", "ROLE.Service Designer", "ROLE.Service Operator", "ROLE.Workload Operator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'workflow.ServiceItemActionInstance' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.ServiceItemActionInstance" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetWorkflowServiceItemActionInstanceByMoid": { "operationId": "GetWorkflowServiceItemActionInstanceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/ServiceItemActionInstances/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "workflow" ], "summary": "Update a 'workflow.ServiceItemActionInstance' resource.", "operationId": "UpdateWorkflowServiceItemActionInstance", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Catalog Administrator", "PRIVSET.Create integrated systems", "PRIVSET.Delete integrated systems", "PRIVSET.Edit integrated systems", "PRIVSET.Integrated Systems Administrator", "PRIVSET.Integrated Systems Operator", "PRIVSET.Run interoperability checks", "PRIVSET.Service Designer", "PRIVSET.Service Operator", "PRIVSET.Workload Operator", "ROLE.Account Administrator", "ROLE.Catalog Administrator", "ROLE.Integrated Systems Administrator", "ROLE.Integrated Systems Operator", "ROLE.Service Designer", "ROLE.Service Operator", "ROLE.Workload Operator", "UPDATE.workflow.ServiceItemActionInstance" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'workflow.ServiceItemActionInstance' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.ServiceItemActionInstance" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.ServiceItemActionInstance' resource was modified as requested. The 'workflow.ServiceItemActionInstance' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.ServiceItemActionInstance" } } }, "links": { "GetWorkflowServiceItemActionInstanceByMoid": { "operationId": "GetWorkflowServiceItemActionInstanceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/ServiceItemActionInstances/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "workflow" ], "summary": "Update a 'workflow.ServiceItemActionInstance' resource.", "operationId": "PatchWorkflowServiceItemActionInstance", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Catalog Administrator", "PRIVSET.Create integrated systems", "PRIVSET.Delete integrated systems", "PRIVSET.Edit integrated systems", "PRIVSET.Integrated Systems Administrator", "PRIVSET.Integrated Systems Operator", "PRIVSET.Run interoperability checks", "PRIVSET.Service Designer", "PRIVSET.Service Operator", "PRIVSET.Workload Operator", "ROLE.Account Administrator", "ROLE.Catalog Administrator", "ROLE.Integrated Systems Administrator", "ROLE.Integrated Systems Operator", "ROLE.Service Designer", "ROLE.Service Operator", "ROLE.Workload Operator", "UPDATE.workflow.ServiceItemActionInstance" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'workflow.ServiceItemActionInstance' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.ServiceItemActionInstance" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.ServiceItemActionInstance' resource was patched as requested. The 'workflow.ServiceItemActionInstance' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.ServiceItemActionInstance" } } }, "links": { "GetWorkflowServiceItemActionInstanceByMoid": { "operationId": "GetWorkflowServiceItemActionInstanceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/ServiceItemActionInstances/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "workflow" ], "summary": "Delete a 'workflow.ServiceItemActionInstance' resource.", "operationId": "DeleteWorkflowServiceItemActionInstance", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.workflow.ServiceItemActionInstance", "PRIVSET.Account Administrator", "PRIVSET.Catalog Administrator", "PRIVSET.Delete integrated systems", "PRIVSET.Integrated Systems Administrator", "PRIVSET.Integrated Systems Operator", "PRIVSET.Service Designer", "PRIVSET.Service Operator", "PRIVSET.Workload Operator", "ROLE.Account Administrator", "ROLE.Catalog Administrator", "ROLE.Integrated Systems Administrator", "ROLE.Integrated Systems Operator", "ROLE.Service Designer", "ROLE.Service Operator", "ROLE.Workload Operator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/ServiceItemAttributes": { "get": { "tags": [ "workflow" ], "summary": "Read a 'workflow.ServiceItemAttribute' resource.", "operationId": "GetWorkflowServiceItemAttributeList", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Catalog Administrator", "PRIVSET.Catalog User", "PRIVSET.Read-Only", "PRIVSET.Service Designer", "PRIVSET.Service Operator", "PRIVSET.Workload Operator", "READ.workflow.ServiceItemAttribute", "ROLE.Account Administrator", "ROLE.Catalog Administrator", "ROLE.Catalog User", "ROLE.Read-Only", "ROLE.Service Designer", "ROLE.Service Operator", "ROLE.Workload Operator" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'workflow.ServiceItemAttribute' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.ServiceItemAttribute.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/ServiceItemAttributes/{Moid}": { "get": { "tags": [ "workflow" ], "summary": "Read a 'workflow.ServiceItemAttribute' resource.", "operationId": "GetWorkflowServiceItemAttributeByMoid", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Catalog Administrator", "PRIVSET.Catalog User", "PRIVSET.Read-Only", "PRIVSET.Service Designer", "PRIVSET.Service Operator", "PRIVSET.Workload Operator", "READ.workflow.ServiceItemAttribute", "ROLE.Account Administrator", "ROLE.Catalog Administrator", "ROLE.Catalog User", "ROLE.Read-Only", "ROLE.Service Designer", "ROLE.Service Operator", "ROLE.Workload Operator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'workflow.ServiceItemAttribute' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.ServiceItemAttribute" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetWorkflowServiceItemAttributeByMoid": { "operationId": "GetWorkflowServiceItemAttributeByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/ServiceItemAttributes/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/ServiceItemDefinitions": { "get": { "tags": [ "workflow" ], "summary": "Read a 'workflow.ServiceItemDefinition' resource.", "operationId": "GetWorkflowServiceItemDefinitionList", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Catalog Administrator", "PRIVSET.Catalog User", "PRIVSET.Integrated Systems Administrator", "PRIVSET.Integrated Systems Operator", "PRIVSET.Read-Only", "PRIVSET.Read-only integrated systems", "PRIVSET.Service Designer", "PRIVSET.Service Operator", "PRIVSET.Workload Operator", "READ.workflow.ServiceItemDefinition", "ROLE.Account Administrator", "ROLE.Catalog Administrator", "ROLE.Catalog User", "ROLE.Integrated Systems Administrator", "ROLE.Integrated Systems Operator", "ROLE.Read-Only", "ROLE.Service Designer", "ROLE.Service Operator", "ROLE.Workload Operator" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'workflow.ServiceItemDefinition' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.ServiceItemDefinition.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "workflow" ], "summary": "Create a 'workflow.ServiceItemDefinition' resource.", "operationId": "CreateWorkflowServiceItemDefinition", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.workflow.ServiceItemDefinition", "PRIVSET.Account Administrator", "PRIVSET.Catalog Administrator", "PRIVSET.Integrated Systems Administrator", "PRIVSET.Service Designer", "ROLE.Account Administrator", "ROLE.Catalog Administrator", "ROLE.Integrated Systems Administrator", "ROLE.Service Designer" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'workflow.ServiceItemDefinition' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.ServiceItemDefinition" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.ServiceItemDefinition' resource was created as requested. The 'workflow.ServiceItemDefinition' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.ServiceItemDefinition" } } }, "links": { "GetWorkflowServiceItemDefinitionByMoid": { "operationId": "GetWorkflowServiceItemDefinitionByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/ServiceItemDefinitions/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/ServiceItemDefinitions/{Moid}": { "get": { "tags": [ "workflow" ], "summary": "Read a 'workflow.ServiceItemDefinition' resource.", "operationId": "GetWorkflowServiceItemDefinitionByMoid", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Catalog Administrator", "PRIVSET.Catalog User", "PRIVSET.Integrated Systems Administrator", "PRIVSET.Integrated Systems Operator", "PRIVSET.Read-Only", "PRIVSET.Read-only integrated systems", "PRIVSET.Service Designer", "PRIVSET.Service Operator", "PRIVSET.Workload Operator", "READ.workflow.ServiceItemDefinition", "ROLE.Account Administrator", "ROLE.Catalog Administrator", "ROLE.Catalog User", "ROLE.Integrated Systems Administrator", "ROLE.Integrated Systems Operator", "ROLE.Read-Only", "ROLE.Service Designer", "ROLE.Service Operator", "ROLE.Workload Operator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'workflow.ServiceItemDefinition' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.ServiceItemDefinition" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetWorkflowServiceItemDefinitionByMoid": { "operationId": "GetWorkflowServiceItemDefinitionByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/ServiceItemDefinitions/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "workflow" ], "summary": "Update a 'workflow.ServiceItemDefinition' resource.", "operationId": "UpdateWorkflowServiceItemDefinition", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Catalog Administrator", "PRIVSET.Integrated Systems Administrator", "PRIVSET.Service Designer", "ROLE.Account Administrator", "ROLE.Catalog Administrator", "ROLE.Integrated Systems Administrator", "ROLE.Service Designer", "UPDATE.workflow.ServiceItemDefinition" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'workflow.ServiceItemDefinition' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.ServiceItemDefinition" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.ServiceItemDefinition' resource was modified as requested. The 'workflow.ServiceItemDefinition' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.ServiceItemDefinition" } } }, "links": { "GetWorkflowServiceItemDefinitionByMoid": { "operationId": "GetWorkflowServiceItemDefinitionByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/ServiceItemDefinitions/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "workflow" ], "summary": "Update a 'workflow.ServiceItemDefinition' resource.", "operationId": "PatchWorkflowServiceItemDefinition", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Catalog Administrator", "PRIVSET.Integrated Systems Administrator", "PRIVSET.Service Designer", "ROLE.Account Administrator", "ROLE.Catalog Administrator", "ROLE.Integrated Systems Administrator", "ROLE.Service Designer", "UPDATE.workflow.ServiceItemDefinition" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'workflow.ServiceItemDefinition' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.ServiceItemDefinition" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.ServiceItemDefinition' resource was patched as requested. The 'workflow.ServiceItemDefinition' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.ServiceItemDefinition" } } }, "links": { "GetWorkflowServiceItemDefinitionByMoid": { "operationId": "GetWorkflowServiceItemDefinitionByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/ServiceItemDefinitions/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "workflow" ], "summary": "Delete a 'workflow.ServiceItemDefinition' resource.", "operationId": "DeleteWorkflowServiceItemDefinition", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.workflow.ServiceItemDefinition", "PRIVSET.Account Administrator", "PRIVSET.Catalog Administrator", "PRIVSET.Integrated Systems Administrator", "PRIVSET.Service Designer", "ROLE.Account Administrator", "ROLE.Catalog Administrator", "ROLE.Integrated Systems Administrator", "ROLE.Service Designer" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/ServiceItemHealthCheckDefinitions": { "get": { "tags": [ "workflow" ], "summary": "Read a 'workflow.ServiceItemHealthCheckDefinition' resource.", "operationId": "GetWorkflowServiceItemHealthCheckDefinitionList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Integrated Systems Administrator", "PRIVSET.Integrated Systems Operator", "PRIVSET.Read-Only", "PRIVSET.Read-only integrated systems", "READ.workflow.ServiceItemHealthCheckDefinition", "ROLE.Account Administrator", "ROLE.Integrated Systems Administrator", "ROLE.Integrated Systems Operator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'workflow.ServiceItemHealthCheckDefinition' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.ServiceItemHealthCheckDefinition.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/ServiceItemHealthCheckDefinitions/{Moid}": { "get": { "tags": [ "workflow" ], "summary": "Read a 'workflow.ServiceItemHealthCheckDefinition' resource.", "operationId": "GetWorkflowServiceItemHealthCheckDefinitionByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Integrated Systems Administrator", "PRIVSET.Integrated Systems Operator", "PRIVSET.Read-Only", "PRIVSET.Read-only integrated systems", "READ.workflow.ServiceItemHealthCheckDefinition", "ROLE.Account Administrator", "ROLE.Integrated Systems Administrator", "ROLE.Integrated Systems Operator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'workflow.ServiceItemHealthCheckDefinition' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.ServiceItemHealthCheckDefinition" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetWorkflowServiceItemHealthCheckDefinitionByMoid": { "operationId": "GetWorkflowServiceItemHealthCheckDefinitionByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/ServiceItemHealthCheckDefinitions/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/ServiceItemHealthCheckExecutions": { "get": { "tags": [ "workflow" ], "summary": "Read a 'workflow.ServiceItemHealthCheckExecution' resource.", "operationId": "GetWorkflowServiceItemHealthCheckExecutionList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.workflow.ServiceItemHealthCheckExecution", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'workflow.ServiceItemHealthCheckExecution' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.ServiceItemHealthCheckExecution.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/ServiceItemHealthCheckExecutions/{Moid}": { "get": { "tags": [ "workflow" ], "summary": "Read a 'workflow.ServiceItemHealthCheckExecution' resource.", "operationId": "GetWorkflowServiceItemHealthCheckExecutionByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.workflow.ServiceItemHealthCheckExecution", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'workflow.ServiceItemHealthCheckExecution' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.ServiceItemHealthCheckExecution" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetWorkflowServiceItemHealthCheckExecutionByMoid": { "operationId": "GetWorkflowServiceItemHealthCheckExecutionByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/ServiceItemHealthCheckExecutions/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/ServiceItemInstances": { "get": { "tags": [ "workflow" ], "summary": "Read a 'workflow.ServiceItemInstance' resource.", "operationId": "GetWorkflowServiceItemInstanceList", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Catalog Administrator", "PRIVSET.Catalog User", "PRIVSET.Integrated Systems Administrator", "PRIVSET.Integrated Systems Operator", "PRIVSET.Read-Only", "PRIVSET.Read-only integrated systems", "PRIVSET.Service Designer", "PRIVSET.Service Operator", "PRIVSET.Workload Operator", "READ.workflow.ServiceItemInstance", "ROLE.Account Administrator", "ROLE.Catalog Administrator", "ROLE.Catalog User", "ROLE.Integrated Systems Administrator", "ROLE.Integrated Systems Operator", "ROLE.Read-Only", "ROLE.Service Designer", "ROLE.Service Operator", "ROLE.Workload Operator" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'workflow.ServiceItemInstance' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.ServiceItemInstance.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "workflow" ], "summary": "Create a 'workflow.ServiceItemInstance' resource.", "operationId": "CreateWorkflowServiceItemInstance", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.workflow.ServiceItemInstance", "PRIVSET.Account Administrator", "PRIVSET.Catalog Administrator", "PRIVSET.Create integrated systems", "PRIVSET.Integrated Systems Administrator", "PRIVSET.Service Designer", "PRIVSET.Service Operator", "PRIVSET.Workload Operator", "ROLE.Account Administrator", "ROLE.Catalog Administrator", "ROLE.Integrated Systems Administrator", "ROLE.Service Designer", "ROLE.Service Operator", "ROLE.Workload Operator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'workflow.ServiceItemInstance' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.ServiceItemInstance" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.ServiceItemInstance' resource was created as requested. The 'workflow.ServiceItemInstance' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.ServiceItemInstance" } } }, "links": { "GetWorkflowServiceItemInstanceByMoid": { "operationId": "GetWorkflowServiceItemInstanceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/ServiceItemInstances/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/ServiceItemInstances/{Moid}": { "get": { "tags": [ "workflow" ], "summary": "Read a 'workflow.ServiceItemInstance' resource.", "operationId": "GetWorkflowServiceItemInstanceByMoid", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Catalog Administrator", "PRIVSET.Catalog User", "PRIVSET.Integrated Systems Administrator", "PRIVSET.Integrated Systems Operator", "PRIVSET.Read-Only", "PRIVSET.Read-only integrated systems", "PRIVSET.Service Designer", "PRIVSET.Service Operator", "PRIVSET.Workload Operator", "READ.workflow.ServiceItemInstance", "ROLE.Account Administrator", "ROLE.Catalog Administrator", "ROLE.Catalog User", "ROLE.Integrated Systems Administrator", "ROLE.Integrated Systems Operator", "ROLE.Read-Only", "ROLE.Service Designer", "ROLE.Service Operator", "ROLE.Workload Operator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'workflow.ServiceItemInstance' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.ServiceItemInstance" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetWorkflowServiceItemInstanceByMoid": { "operationId": "GetWorkflowServiceItemInstanceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/ServiceItemInstances/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "workflow" ], "summary": "Update a 'workflow.ServiceItemInstance' resource.", "operationId": "UpdateWorkflowServiceItemInstance", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Catalog Administrator", "PRIVSET.Edit integrated systems", "PRIVSET.Integrated Systems Administrator", "PRIVSET.Service Designer", "PRIVSET.Service Operator", "PRIVSET.Workload Operator", "ROLE.Account Administrator", "ROLE.Catalog Administrator", "ROLE.Integrated Systems Administrator", "ROLE.Service Designer", "ROLE.Service Operator", "ROLE.Workload Operator", "UPDATE.workflow.ServiceItemInstance" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'workflow.ServiceItemInstance' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.ServiceItemInstance" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.ServiceItemInstance' resource was modified as requested. The 'workflow.ServiceItemInstance' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.ServiceItemInstance" } } }, "links": { "GetWorkflowServiceItemInstanceByMoid": { "operationId": "GetWorkflowServiceItemInstanceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/ServiceItemInstances/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "workflow" ], "summary": "Update a 'workflow.ServiceItemInstance' resource.", "operationId": "PatchWorkflowServiceItemInstance", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Catalog Administrator", "PRIVSET.Edit integrated systems", "PRIVSET.Integrated Systems Administrator", "PRIVSET.Service Designer", "PRIVSET.Service Operator", "PRIVSET.Workload Operator", "ROLE.Account Administrator", "ROLE.Catalog Administrator", "ROLE.Integrated Systems Administrator", "ROLE.Service Designer", "ROLE.Service Operator", "ROLE.Workload Operator", "UPDATE.workflow.ServiceItemInstance" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'workflow.ServiceItemInstance' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.ServiceItemInstance" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.ServiceItemInstance' resource was patched as requested. The 'workflow.ServiceItemInstance' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.ServiceItemInstance" } } }, "links": { "GetWorkflowServiceItemInstanceByMoid": { "operationId": "GetWorkflowServiceItemInstanceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/ServiceItemInstances/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "workflow" ], "summary": "Delete a 'workflow.ServiceItemInstance' resource.", "operationId": "DeleteWorkflowServiceItemInstance", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.workflow.ServiceItemInstance", "PRIVSET.Account Administrator", "PRIVSET.Catalog Administrator", "PRIVSET.Catalog User", "PRIVSET.Delete integrated systems", "PRIVSET.Integrated Systems Administrator", "PRIVSET.Service Designer", "PRIVSET.Service Operator", "PRIVSET.Workload Operator", "ROLE.Account Administrator", "ROLE.Catalog Administrator", "ROLE.Catalog User", "ROLE.Integrated Systems Administrator", "ROLE.Service Designer", "ROLE.Service Operator", "ROLE.Workload Operator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/ServiceItemOutputs": { "get": { "tags": [ "workflow" ], "summary": "Read a 'workflow.ServiceItemOutput' resource.", "operationId": "GetWorkflowServiceItemOutputList", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Integrated Systems Administrator", "PRIVSET.Integrated Systems Operator", "PRIVSET.Read-Only", "PRIVSET.Read-only integrated systems", "PRIVSET.Workload Operator", "READ.workflow.ServiceItemOutput", "ROLE.Account Administrator", "ROLE.Integrated Systems Administrator", "ROLE.Integrated Systems Operator", "ROLE.Read-Only", "ROLE.Workload Operator" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'workflow.ServiceItemOutput' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.ServiceItemOutput.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "workflow" ], "summary": "Create a 'workflow.ServiceItemOutput' resource.", "operationId": "CreateWorkflowServiceItemOutput", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.workflow.ServiceItemOutput", "PRIVSET.Account Administrator", "PRIVSET.Integrated Systems Administrator", "PRIVSET.Workload Operator", "ROLE.Account Administrator", "ROLE.Integrated Systems Administrator", "ROLE.Workload Operator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'workflow.ServiceItemOutput' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.ServiceItemOutput" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.ServiceItemOutput' resource was created as requested. The 'workflow.ServiceItemOutput' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.ServiceItemOutput" } } }, "links": { "GetWorkflowServiceItemOutputByMoid": { "operationId": "GetWorkflowServiceItemOutputByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/ServiceItemOutputs/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/ServiceItemOutputs/{Moid}": { "get": { "tags": [ "workflow" ], "summary": "Read a 'workflow.ServiceItemOutput' resource.", "operationId": "GetWorkflowServiceItemOutputByMoid", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Integrated Systems Administrator", "PRIVSET.Integrated Systems Operator", "PRIVSET.Read-Only", "PRIVSET.Read-only integrated systems", "PRIVSET.Workload Operator", "READ.workflow.ServiceItemOutput", "ROLE.Account Administrator", "ROLE.Integrated Systems Administrator", "ROLE.Integrated Systems Operator", "ROLE.Read-Only", "ROLE.Workload Operator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'workflow.ServiceItemOutput' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.ServiceItemOutput" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetWorkflowServiceItemOutputByMoid": { "operationId": "GetWorkflowServiceItemOutputByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/ServiceItemOutputs/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "workflow" ], "summary": "Update a 'workflow.ServiceItemOutput' resource.", "operationId": "UpdateWorkflowServiceItemOutput", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Integrated Systems Administrator", "PRIVSET.Workload Operator", "ROLE.Account Administrator", "ROLE.Integrated Systems Administrator", "ROLE.Workload Operator", "UPDATE.workflow.ServiceItemOutput" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'workflow.ServiceItemOutput' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.ServiceItemOutput" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.ServiceItemOutput' resource was modified as requested. The 'workflow.ServiceItemOutput' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.ServiceItemOutput" } } }, "links": { "GetWorkflowServiceItemOutputByMoid": { "operationId": "GetWorkflowServiceItemOutputByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/ServiceItemOutputs/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "workflow" ], "summary": "Update a 'workflow.ServiceItemOutput' resource.", "operationId": "PatchWorkflowServiceItemOutput", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Integrated Systems Administrator", "PRIVSET.Workload Operator", "ROLE.Account Administrator", "ROLE.Integrated Systems Administrator", "ROLE.Workload Operator", "UPDATE.workflow.ServiceItemOutput" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'workflow.ServiceItemOutput' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.ServiceItemOutput" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.ServiceItemOutput' resource was patched as requested. The 'workflow.ServiceItemOutput' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.ServiceItemOutput" } } }, "links": { "GetWorkflowServiceItemOutputByMoid": { "operationId": "GetWorkflowServiceItemOutputByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/ServiceItemOutputs/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "workflow" ], "summary": "Delete a 'workflow.ServiceItemOutput' resource.", "operationId": "DeleteWorkflowServiceItemOutput", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.workflow.ServiceItemOutput", "PRIVSET.Account Administrator", "PRIVSET.Integrated Systems Administrator", "PRIVSET.Workload Operator", "ROLE.Account Administrator", "ROLE.Integrated Systems Administrator", "ROLE.Workload Operator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/SshBatchExecutors": { "get": { "tags": [ "workflow" ], "summary": "Read a 'workflow.SshBatchExecutor' resource.", "operationId": "GetWorkflowSshBatchExecutorList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Workflow Definitions", "PRIVSET.Read-Only", "PRIVSET.View Workflow Definitions", "READ.workflow.SshBatchExecutor", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'workflow.SshBatchExecutor' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.SshBatchExecutor.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "workflow" ], "summary": "Create a 'workflow.SshBatchExecutor' resource.", "operationId": "CreateWorkflowSshBatchExecutor", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.workflow.SshBatchExecutor", "PRIVSET.Account Administrator", "PRIVSET.Manage Workflow Definitions", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'workflow.SshBatchExecutor' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.SshBatchExecutor" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.SshBatchExecutor' resource was created as requested. The 'workflow.SshBatchExecutor' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.SshBatchExecutor" } } }, "links": { "GetWorkflowSshBatchExecutorByMoid": { "operationId": "GetWorkflowSshBatchExecutorByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/SshBatchExecutors/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/SshBatchExecutors/{Moid}": { "get": { "tags": [ "workflow" ], "summary": "Read a 'workflow.SshBatchExecutor' resource.", "operationId": "GetWorkflowSshBatchExecutorByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Workflow Definitions", "PRIVSET.Read-Only", "PRIVSET.View Workflow Definitions", "READ.workflow.SshBatchExecutor", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'workflow.SshBatchExecutor' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.SshBatchExecutor" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetWorkflowSshBatchExecutorByMoid": { "operationId": "GetWorkflowSshBatchExecutorByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/SshBatchExecutors/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "workflow" ], "summary": "Update a 'workflow.SshBatchExecutor' resource.", "operationId": "UpdateWorkflowSshBatchExecutor", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Workflow Definitions", "ROLE.Account Administrator", "UPDATE.workflow.SshBatchExecutor" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'workflow.SshBatchExecutor' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.SshBatchExecutor" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.SshBatchExecutor' resource was modified as requested. The 'workflow.SshBatchExecutor' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.SshBatchExecutor" } } }, "links": { "GetWorkflowSshBatchExecutorByMoid": { "operationId": "GetWorkflowSshBatchExecutorByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/SshBatchExecutors/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "workflow" ], "summary": "Update a 'workflow.SshBatchExecutor' resource.", "operationId": "PatchWorkflowSshBatchExecutor", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Workflow Definitions", "ROLE.Account Administrator", "UPDATE.workflow.SshBatchExecutor" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'workflow.SshBatchExecutor' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.SshBatchExecutor" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.SshBatchExecutor' resource was patched as requested. The 'workflow.SshBatchExecutor' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.SshBatchExecutor" } } }, "links": { "GetWorkflowSshBatchExecutorByMoid": { "operationId": "GetWorkflowSshBatchExecutorByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/SshBatchExecutors/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "workflow" ], "summary": "Delete a 'workflow.SshBatchExecutor' resource.", "operationId": "DeleteWorkflowSshBatchExecutor", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.workflow.SshBatchExecutor", "PRIVSET.Account Administrator", "PRIVSET.Manage Workflow Definitions", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/TaskDebugLogs": { "get": { "tags": [ "workflow" ], "summary": "Read a 'workflow.TaskDebugLog' resource.", "operationId": "GetWorkflowTaskDebugLogList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Workflow Definitions", "READ.workflow.TaskDebugLog", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'workflow.TaskDebugLog' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.TaskDebugLog.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/TaskDebugLogs/{Moid}": { "get": { "tags": [ "workflow" ], "summary": "Read a 'workflow.TaskDebugLog' resource.", "operationId": "GetWorkflowTaskDebugLogByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Workflow Definitions", "READ.workflow.TaskDebugLog", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'workflow.TaskDebugLog' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.TaskDebugLog" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetWorkflowTaskDebugLogByMoid": { "operationId": "GetWorkflowTaskDebugLogByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/TaskDebugLogs/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/TaskDefinitions": { "get": { "tags": [ "workflow" ], "summary": "Read a 'workflow.TaskDefinition' resource.", "operationId": "GetWorkflowTaskDefinitionList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Execute Workflows", "PRIVSET.Manage Workflow Definitions", "PRIVSET.Read Workflows", "PRIVSET.Read-Only", "PRIVSET.View Workflow Definitions", "READ.workflow.TaskDefinition", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'workflow.TaskDefinition' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.TaskDefinition.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "workflow" ], "summary": "Create a 'workflow.TaskDefinition' resource.", "operationId": "CreateWorkflowTaskDefinition", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.workflow.TaskDefinition", "PRIVSET.Account Administrator", "PRIVSET.Manage Workflow Definitions", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'workflow.TaskDefinition' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.TaskDefinition" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.TaskDefinition' resource was created as requested. The 'workflow.TaskDefinition' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.TaskDefinition" } } }, "links": { "GetWorkflowTaskDefinitionByMoid": { "operationId": "GetWorkflowTaskDefinitionByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/TaskDefinitions/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/TaskDefinitions/{Moid}": { "get": { "tags": [ "workflow" ], "summary": "Read a 'workflow.TaskDefinition' resource.", "operationId": "GetWorkflowTaskDefinitionByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Execute Workflows", "PRIVSET.Manage Workflow Definitions", "PRIVSET.Read Workflows", "PRIVSET.Read-Only", "PRIVSET.View Workflow Definitions", "READ.workflow.TaskDefinition", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'workflow.TaskDefinition' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.TaskDefinition" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetWorkflowTaskDefinitionByMoid": { "operationId": "GetWorkflowTaskDefinitionByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/TaskDefinitions/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "workflow" ], "summary": "Update a 'workflow.TaskDefinition' resource.", "operationId": "UpdateWorkflowTaskDefinition", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Workflow Definitions", "ROLE.Account Administrator", "UPDATE.workflow.TaskDefinition" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'workflow.TaskDefinition' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.TaskDefinition" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.TaskDefinition' resource was modified as requested. The 'workflow.TaskDefinition' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.TaskDefinition" } } }, "links": { "GetWorkflowTaskDefinitionByMoid": { "operationId": "GetWorkflowTaskDefinitionByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/TaskDefinitions/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "workflow" ], "summary": "Update a 'workflow.TaskDefinition' resource.", "operationId": "PatchWorkflowTaskDefinition", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Workflow Definitions", "ROLE.Account Administrator", "UPDATE.workflow.TaskDefinition" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'workflow.TaskDefinition' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.TaskDefinition" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.TaskDefinition' resource was patched as requested. The 'workflow.TaskDefinition' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.TaskDefinition" } } }, "links": { "GetWorkflowTaskDefinitionByMoid": { "operationId": "GetWorkflowTaskDefinitionByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/TaskDefinitions/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "workflow" ], "summary": "Delete a 'workflow.TaskDefinition' resource.", "operationId": "DeleteWorkflowTaskDefinition", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.workflow.TaskDefinition", "PRIVSET.Account Administrator", "PRIVSET.Manage Workflow Definitions", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/TaskInfos": { "get": { "tags": [ "workflow" ], "summary": "Read a 'workflow.TaskInfo' resource.", "operationId": "GetWorkflowTaskInfoList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Execute Workflows", "PRIVSET.Manage Workflow Definitions", "PRIVSET.Read Workflows", "PRIVSET.Read-Only", "PRIVSET.View Workflow Definitions", "PRIVSET.View Workflow Executions", "READ.workflow.TaskInfo", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'workflow.TaskInfo' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.TaskInfo.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/TaskInfos/{Moid}": { "get": { "tags": [ "workflow" ], "summary": "Read a 'workflow.TaskInfo' resource.", "operationId": "GetWorkflowTaskInfoByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Execute Workflows", "PRIVSET.Manage Workflow Definitions", "PRIVSET.Read Workflows", "PRIVSET.Read-Only", "PRIVSET.View Workflow Definitions", "PRIVSET.View Workflow Executions", "READ.workflow.TaskInfo", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'workflow.TaskInfo' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.TaskInfo" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetWorkflowTaskInfoByMoid": { "operationId": "GetWorkflowTaskInfoByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/TaskInfos/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "workflow" ], "summary": "Update a 'workflow.TaskInfo' resource.", "operationId": "UpdateWorkflowTaskInfo", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Execute Workflows", "PRIVSET.Manage Workflow Definitions", "PRIVSET.Run Workflows", "ROLE.Account Administrator", "UPDATE.workflow.TaskInfo" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'workflow.TaskInfo' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.TaskInfo" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.TaskInfo' resource was modified as requested. The 'workflow.TaskInfo' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.TaskInfo" } } }, "links": { "GetWorkflowTaskInfoByMoid": { "operationId": "GetWorkflowTaskInfoByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/TaskInfos/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "workflow" ], "summary": "Update a 'workflow.TaskInfo' resource.", "operationId": "PatchWorkflowTaskInfo", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Execute Workflows", "PRIVSET.Manage Workflow Definitions", "PRIVSET.Run Workflows", "ROLE.Account Administrator", "UPDATE.workflow.TaskInfo" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'workflow.TaskInfo' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.TaskInfo" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.TaskInfo' resource was patched as requested. The 'workflow.TaskInfo' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.TaskInfo" } } }, "links": { "GetWorkflowTaskInfoByMoid": { "operationId": "GetWorkflowTaskInfoByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/TaskInfos/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/TaskMetadata": { "get": { "tags": [ "workflow" ], "summary": "Read a 'workflow.TaskMetadata' resource.", "operationId": "GetWorkflowTaskMetadataList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.workflow.TaskMetadata", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'workflow.TaskMetadata' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.TaskMetadata.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/TaskMetadata/{Moid}": { "get": { "tags": [ "workflow" ], "summary": "Read a 'workflow.TaskMetadata' resource.", "operationId": "GetWorkflowTaskMetadataByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.workflow.TaskMetadata", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'workflow.TaskMetadata' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.TaskMetadata" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetWorkflowTaskMetadataByMoid": { "operationId": "GetWorkflowTaskMetadataByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/TaskMetadata/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/TemplateEvaluations": { "post": { "tags": [ "workflow" ], "summary": "Create a 'workflow.TemplateEvaluation' resource.", "operationId": "CreateWorkflowTemplateEvaluation", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.workflow.TemplateEvaluation", "PRIVSET.Account Administrator", "PRIVSET.Manage Workflow Definitions", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'workflow.TemplateEvaluation' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.TemplateEvaluation" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.TemplateEvaluation' resource was created as requested. The 'workflow.TemplateEvaluation' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.TemplateEvaluation" } } }, "links": { "GetWorkflowTemplateEvaluationByMoid": { "operationId": "GetWorkflowTemplateEvaluationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/TemplateEvaluations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/TemplateFunctionMeta": { "get": { "tags": [ "workflow" ], "summary": "Read a 'workflow.TemplateFunctionMeta' resource.", "operationId": "GetWorkflowTemplateFunctionMetaList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Execute Workflows", "PRIVSET.Manage Workflow Definitions", "PRIVSET.Read-Only", "PRIVSET.View Workflow Definitions", "READ.workflow.TemplateFunctionMeta", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'workflow.TemplateFunctionMeta' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.TemplateFunctionMeta.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/TemplateFunctionMeta/{Moid}": { "get": { "tags": [ "workflow" ], "summary": "Read a 'workflow.TemplateFunctionMeta' resource.", "operationId": "GetWorkflowTemplateFunctionMetaByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Execute Workflows", "PRIVSET.Manage Workflow Definitions", "PRIVSET.Read-Only", "PRIVSET.View Workflow Definitions", "READ.workflow.TemplateFunctionMeta", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'workflow.TemplateFunctionMeta' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.TemplateFunctionMeta" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetWorkflowTemplateFunctionMetaByMoid": { "operationId": "GetWorkflowTemplateFunctionMetaByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/TemplateFunctionMeta/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/TemplateParsers": { "post": { "tags": [ "workflow" ], "summary": "Create a 'workflow.TemplateParser' resource.", "operationId": "CreateWorkflowTemplateParser", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.workflow.TemplateParser", "PRIVSET.Account Administrator", "PRIVSET.Execute Workflows", "PRIVSET.Workflow Designer", "ROLE.Account Administrator", "ROLE.Workflow Designer" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'workflow.TemplateParser' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.TemplateParser" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.TemplateParser' resource was created as requested. The 'workflow.TemplateParser' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.TemplateParser" } } }, "links": { "GetWorkflowTemplateParserByMoid": { "operationId": "GetWorkflowTemplateParserByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/TemplateParsers/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/UiDisplayMetadata": { "get": { "tags": [ "workflow" ], "summary": "Read a 'workflow.UiDisplayMetadata' resource.", "operationId": "GetWorkflowUiDisplayMetadataList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Execute Workflows", "PRIVSET.Manage Workflow Definitions", "PRIVSET.Read Workflows", "PRIVSET.Read-Only", "PRIVSET.View Workflow Definitions", "READ.workflow.UiDisplayMetadata", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'workflow.UiDisplayMetadata' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.UiDisplayMetadata.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "workflow" ], "summary": "Create a 'workflow.UiDisplayMetadata' resource.", "operationId": "CreateWorkflowUiDisplayMetadata", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.workflow.UiDisplayMetadata", "PRIVSET.Account Administrator", "PRIVSET.Manage Workflow Definitions", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'workflow.UiDisplayMetadata' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.UiDisplayMetadata" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.UiDisplayMetadata' resource was created as requested. The 'workflow.UiDisplayMetadata' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.UiDisplayMetadata" } } }, "links": { "GetWorkflowUiDisplayMetadataByMoid": { "operationId": "GetWorkflowUiDisplayMetadataByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/UiDisplayMetadata/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/UiDisplayMetadata/{Moid}": { "get": { "tags": [ "workflow" ], "summary": "Read a 'workflow.UiDisplayMetadata' resource.", "operationId": "GetWorkflowUiDisplayMetadataByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Execute Workflows", "PRIVSET.Manage Workflow Definitions", "PRIVSET.Read Workflows", "PRIVSET.Read-Only", "PRIVSET.View Workflow Definitions", "READ.workflow.UiDisplayMetadata", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'workflow.UiDisplayMetadata' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.UiDisplayMetadata" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetWorkflowUiDisplayMetadataByMoid": { "operationId": "GetWorkflowUiDisplayMetadataByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/UiDisplayMetadata/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "workflow" ], "summary": "Update a 'workflow.UiDisplayMetadata' resource.", "operationId": "UpdateWorkflowUiDisplayMetadata", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Workflow Definitions", "ROLE.Account Administrator", "UPDATE.workflow.UiDisplayMetadata" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'workflow.UiDisplayMetadata' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.UiDisplayMetadata" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.UiDisplayMetadata' resource was modified as requested. The 'workflow.UiDisplayMetadata' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.UiDisplayMetadata" } } }, "links": { "GetWorkflowUiDisplayMetadataByMoid": { "operationId": "GetWorkflowUiDisplayMetadataByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/UiDisplayMetadata/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "workflow" ], "summary": "Update a 'workflow.UiDisplayMetadata' resource.", "operationId": "PatchWorkflowUiDisplayMetadata", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Workflow Definitions", "ROLE.Account Administrator", "UPDATE.workflow.UiDisplayMetadata" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'workflow.UiDisplayMetadata' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.UiDisplayMetadata" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.UiDisplayMetadata' resource was patched as requested. The 'workflow.UiDisplayMetadata' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.UiDisplayMetadata" } } }, "links": { "GetWorkflowUiDisplayMetadataByMoid": { "operationId": "GetWorkflowUiDisplayMetadataByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/UiDisplayMetadata/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "workflow" ], "summary": "Delete a 'workflow.UiDisplayMetadata' resource.", "operationId": "DeleteWorkflowUiDisplayMetadata", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.workflow.UiDisplayMetadata", "PRIVSET.Account Administrator", "PRIVSET.Manage Workflow Definitions", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/Variables": { "get": { "tags": [ "workflow" ], "summary": "Read a 'workflow.Variable' resource.", "operationId": "GetWorkflowVariableList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Catalog User", "PRIVSET.Execute Workflows", "PRIVSET.Manage Workflow Definitions", "PRIVSET.Read-Only", "PRIVSET.View Workflow Definitions", "READ.workflow.Variable", "ROLE.Account Administrator", "ROLE.Catalog User", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'workflow.Variable' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.Variable.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "workflow" ], "summary": "Create a 'workflow.Variable' resource.", "operationId": "CreateWorkflowVariable", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.workflow.Variable", "PRIVSET.Account Administrator", "PRIVSET.Manage Workflow Definitions", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'workflow.Variable' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.Variable" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.Variable' resource was created as requested. The 'workflow.Variable' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.Variable" } } }, "links": { "GetWorkflowVariableByMoid": { "operationId": "GetWorkflowVariableByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/Variables/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/Variables/{Moid}": { "get": { "tags": [ "workflow" ], "summary": "Read a 'workflow.Variable' resource.", "operationId": "GetWorkflowVariableByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Catalog User", "PRIVSET.Execute Workflows", "PRIVSET.Manage Workflow Definitions", "PRIVSET.Read-Only", "PRIVSET.View Workflow Definitions", "READ.workflow.Variable", "ROLE.Account Administrator", "ROLE.Catalog User", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'workflow.Variable' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.Variable" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetWorkflowVariableByMoid": { "operationId": "GetWorkflowVariableByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/Variables/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "workflow" ], "summary": "Update a 'workflow.Variable' resource.", "operationId": "UpdateWorkflowVariable", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Workflow Definitions", "ROLE.Account Administrator", "UPDATE.workflow.Variable" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'workflow.Variable' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.Variable" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.Variable' resource was modified as requested. The 'workflow.Variable' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.Variable" } } }, "links": { "GetWorkflowVariableByMoid": { "operationId": "GetWorkflowVariableByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/Variables/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "workflow" ], "summary": "Update a 'workflow.Variable' resource.", "operationId": "PatchWorkflowVariable", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Workflow Definitions", "ROLE.Account Administrator", "UPDATE.workflow.Variable" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'workflow.Variable' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.Variable" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.Variable' resource was patched as requested. The 'workflow.Variable' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.Variable" } } }, "links": { "GetWorkflowVariableByMoid": { "operationId": "GetWorkflowVariableByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/Variables/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "workflow" ], "summary": "Delete a 'workflow.Variable' resource.", "operationId": "DeleteWorkflowVariable", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.workflow.Variable", "PRIVSET.Account Administrator", "PRIVSET.Manage Workflow Definitions", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/WorkflowDefinitions": { "get": { "tags": [ "workflow" ], "summary": "Read a 'workflow.WorkflowDefinition' resource.", "operationId": "GetWorkflowWorkflowDefinitionList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Execute Workflows", "PRIVSET.Manage Workflow Definitions", "PRIVSET.Read Workflows", "PRIVSET.Read-Only", "PRIVSET.View Workflow Definitions", "READ.workflow.WorkflowDefinition", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'workflow.WorkflowDefinition' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.WorkflowDefinition.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "workflow" ], "summary": "Create a 'workflow.WorkflowDefinition' resource.", "operationId": "CreateWorkflowWorkflowDefinition", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.workflow.WorkflowDefinition", "PRIVSET.Account Administrator", "PRIVSET.Manage Workflow Definitions", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'workflow.WorkflowDefinition' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.WorkflowDefinition" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.WorkflowDefinition' resource was created as requested. The 'workflow.WorkflowDefinition' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.WorkflowDefinition" } } }, "links": { "GetWorkflowWorkflowDefinitionByMoid": { "operationId": "GetWorkflowWorkflowDefinitionByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/WorkflowDefinitions/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/WorkflowDefinitions/{Moid}": { "get": { "tags": [ "workflow" ], "summary": "Read a 'workflow.WorkflowDefinition' resource.", "operationId": "GetWorkflowWorkflowDefinitionByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Execute Workflows", "PRIVSET.Manage Workflow Definitions", "PRIVSET.Read Workflows", "PRIVSET.Read-Only", "PRIVSET.View Workflow Definitions", "READ.workflow.WorkflowDefinition", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'workflow.WorkflowDefinition' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.WorkflowDefinition" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetWorkflowWorkflowDefinitionByMoid": { "operationId": "GetWorkflowWorkflowDefinitionByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/WorkflowDefinitions/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "workflow" ], "summary": "Update a 'workflow.WorkflowDefinition' resource.", "operationId": "UpdateWorkflowWorkflowDefinition", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Workflow Definitions", "ROLE.Account Administrator", "UPDATE.workflow.WorkflowDefinition" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'workflow.WorkflowDefinition' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.WorkflowDefinition" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.WorkflowDefinition' resource was modified as requested. The 'workflow.WorkflowDefinition' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.WorkflowDefinition" } } }, "links": { "GetWorkflowWorkflowDefinitionByMoid": { "operationId": "GetWorkflowWorkflowDefinitionByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/WorkflowDefinitions/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "workflow" ], "summary": "Update a 'workflow.WorkflowDefinition' resource.", "operationId": "PatchWorkflowWorkflowDefinition", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Workflow Definitions", "ROLE.Account Administrator", "UPDATE.workflow.WorkflowDefinition" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'workflow.WorkflowDefinition' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.WorkflowDefinition" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.WorkflowDefinition' resource was patched as requested. The 'workflow.WorkflowDefinition' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.WorkflowDefinition" } } }, "links": { "GetWorkflowWorkflowDefinitionByMoid": { "operationId": "GetWorkflowWorkflowDefinitionByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/WorkflowDefinitions/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "workflow" ], "summary": "Delete a 'workflow.WorkflowDefinition' resource.", "operationId": "DeleteWorkflowWorkflowDefinition", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.workflow.WorkflowDefinition", "PRIVSET.Account Administrator", "PRIVSET.Manage Workflow Definitions", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/WorkflowInfos": { "get": { "tags": [ "workflow" ], "summary": "Read a 'workflow.WorkflowInfo' resource.", "operationId": "GetWorkflowWorkflowInfoList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Execute Workflows", "PRIVSET.Manage Workflow Definitions", "PRIVSET.Read Workflows", "PRIVSET.Read-Only", "PRIVSET.View Workflow Definitions", "PRIVSET.View Workflow Executions", "READ.workflow.WorkflowInfo", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'workflow.WorkflowInfo' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.WorkflowInfo.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "workflow" ], "summary": "Create a 'workflow.WorkflowInfo' resource.", "operationId": "CreateWorkflowWorkflowInfo", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.workflow.WorkflowInfo", "PRIVSET.Account Administrator", "PRIVSET.Execute Workflows", "PRIVSET.Manage Workflow Definitions", "PRIVSET.Run Workflows", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'workflow.WorkflowInfo' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.WorkflowInfo" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.WorkflowInfo' resource was created as requested. The 'workflow.WorkflowInfo' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.WorkflowInfo" } } }, "links": { "GetWorkflowWorkflowInfoByMoid": { "operationId": "GetWorkflowWorkflowInfoByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/WorkflowInfos/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/WorkflowInfos/{Moid}": { "get": { "tags": [ "workflow" ], "summary": "Read a 'workflow.WorkflowInfo' resource.", "operationId": "GetWorkflowWorkflowInfoByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Execute Workflows", "PRIVSET.Manage Workflow Definitions", "PRIVSET.Read Workflows", "PRIVSET.Read-Only", "PRIVSET.View Workflow Definitions", "PRIVSET.View Workflow Executions", "READ.workflow.WorkflowInfo", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'workflow.WorkflowInfo' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.WorkflowInfo" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetWorkflowWorkflowInfoByMoid": { "operationId": "GetWorkflowWorkflowInfoByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/WorkflowInfos/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "workflow" ], "summary": "Update a 'workflow.WorkflowInfo' resource.", "operationId": "UpdateWorkflowWorkflowInfo", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Execute Workflows", "PRIVSET.Manage Workflow Definitions", "PRIVSET.Run Workflows", "ROLE.Account Administrator", "UPDATE.workflow.WorkflowInfo" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'workflow.WorkflowInfo' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.WorkflowInfo" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.WorkflowInfo' resource was modified as requested. The 'workflow.WorkflowInfo' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.WorkflowInfo" } } }, "links": { "GetWorkflowWorkflowInfoByMoid": { "operationId": "GetWorkflowWorkflowInfoByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/WorkflowInfos/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "workflow" ], "summary": "Update a 'workflow.WorkflowInfo' resource.", "operationId": "PatchWorkflowWorkflowInfo", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Execute Workflows", "PRIVSET.Manage Workflow Definitions", "PRIVSET.Run Workflows", "ROLE.Account Administrator", "UPDATE.workflow.WorkflowInfo" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'workflow.WorkflowInfo' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.WorkflowInfo" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.WorkflowInfo' resource was patched as requested. The 'workflow.WorkflowInfo' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.WorkflowInfo" } } }, "links": { "GetWorkflowWorkflowInfoByMoid": { "operationId": "GetWorkflowWorkflowInfoByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/WorkflowInfos/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "workflow" ], "summary": "Delete a 'workflow.WorkflowInfo' resource.", "operationId": "DeleteWorkflowWorkflowInfo", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.workflow.WorkflowInfo", "PRIVSET.Account Administrator", "PRIVSET.Execute Workflows", "PRIVSET.Manage Workflow Definitions", "PRIVSET.Run Workflows", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/WorkflowMetadata": { "get": { "tags": [ "workflow" ], "summary": "Read a 'workflow.WorkflowMetadata' resource.", "operationId": "GetWorkflowWorkflowMetadataList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.workflow.WorkflowMetadata", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'workflow.WorkflowMetadata' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.WorkflowMetadata.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/WorkflowMetadata/{Moid}": { "get": { "tags": [ "workflow" ], "summary": "Read a 'workflow.WorkflowMetadata' resource.", "operationId": "GetWorkflowWorkflowMetadataByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.workflow.WorkflowMetadata", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'workflow.WorkflowMetadata' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.WorkflowMetadata" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetWorkflowWorkflowMetadataByMoid": { "operationId": "GetWorkflowWorkflowMetadataByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/WorkflowMetadata/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } } }, "components": { "schemas": { "aaa.AbstractAuditRecord": { "title": "Aaa:Abstract Audit Record", "description": "AbstractAuditRecord is an abstract base type that specifies the common properties for all audit log records concrete sub-types.", "x-allOf-name": "aaa.AbstractAuditRecord", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'aaa.AbstractAuditRecord', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "aaa.AuditRecord" ], "default": "aaa.AuditRecord", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "aaa.AuditRecord" ], "default": "aaa.AuditRecord", "x-enum-as-string": true }, "Event": { "description": "The operation that was performed on this Managed Object.\nThe event is a compound string that includes the CRUD operation such as Create, Modify, Delete, and a string representing the Managed Object type.", "type": "string", "readOnly": true, "x-omitempty": true }, "HttpOperation": { "description": "The REST URL for the operation.", "type": "string", "readOnly": true, "x-omitempty": true }, "HttpResponseCode": { "description": "The response code of the operation.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "HttpResponsePayload": { "description": "The response body of the operation, with JSON truncated to 2 nested levels when its size exceeds 10KB.", "nullable": true, "readOnly": true, "x-omitempty": true }, "MoDisplayNames": { "description": "The user-friendly names of the changed MO.", "nullable": true, "readOnly": true, "x-omitempty": true }, "MoType": { "description": "The object type of the REST resource that was created, modified or deleted.", "type": "string", "readOnly": true, "x-omitempty": true }, "ObjectMoid": { "description": "The Moid of the REST resource that was created, modified or deleted.", "type": "string", "readOnly": true, "x-omitempty": true }, "Request": { "description": "The body of the REST request that was received from a client to create or modify a REST resource, represented as a JSON document.", "nullable": true, "readOnly": true, "x-omitempty": true }, "TraceId": { "description": "The trace id of the request that was used to create, modify or delete a REST resource.\nA trace id is a unique identifier for one particular REST request. It may be used for troubleshooting purpose\nby the Intersight technical support team.", "type": "string", "readOnly": true, "x-omitempty": true }, "UserAgent": { "description": "The parsed representation of the user agent of the request.", "$ref": "#/components/schemas/aaa.UserAgent", "readOnly": true, "x-omitempty": true }, "UserAgentString": { "description": "The raw, string representation of the user agent of the request from the user-agent http request header.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "aaa.AuditRecord.Response": { "description": "The response body of a HTTP GET request for the 'aaa.AuditRecord' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'aaa.AuditRecord' resources.", "x-one-of-name": "aaa.AuditRecord.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/aaa.AuditRecord.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "aaa.AuditRecord": { "title": "Aaa:Audit Record", "description": "The AuditRecord object is a crucial element within the system, providing a comprehensive overview of configuration changes made by users. It serves as a reliable log of actions, supporting transparency, accountability, and operational integrity.\n#### Purpose\nAn AuditRecord functions as a historical record of configuration changes, capturing essential details about modifications in real time. This ensures that all changes are traceable and can be reviewed for compliance and audit purposes.\n#### Key Concepts\n- **Transparency:** Provides visibility into user actions, ensuring all changes are logged with details such as timestamps, user identities, and affected objects.\n- **Accountability:** By documenting changes, AuditRecords promote accountability among users, encouraging responsible and informed decision-making.\n- **Access Control:** Access is governed by privilege sets, ensuring only authorized personnel can view audit logs and understand the context of changes.\n- **Relationship Management:** AuditRecords are associated with user accounts and sessions, allowing a detailed trace of who made changes and under what circumstances.", "x-allOf-name": "aaa.AuditRecord", "allOf": [ { "$ref": "#/components/schemas/aaa.AbstractAuditRecord" }, { "type": "object", "description": "Definition of the list of properties defined in 'aaa.AuditRecord', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "aaa.AuditRecord" ], "default": "aaa.AuditRecord", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "aaa.AuditRecord" ], "default": "aaa.AuditRecord", "x-enum-as-string": true }, "AffectedObjectTypeLabel": { "description": "The user-friendly label for the object type that was changed.", "type": "string", "readOnly": true, "x-omitempty": true }, "Email": { "description": "The email of the associated user that made the change. In case the user is later deleted, we still have some reference to the information.", "type": "string", "pattern": "^$|^[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$", "readOnly": true, "x-omitempty": true }, "InstId": { "description": "The instance id of AuditRecordLocal, which is used to identify if the comming AuditRecordLocal was already processed before.", "type": "string", "readOnly": true, "x-omitempty": true }, "SessionId": { "description": "The sessionId in which the user made the change. In case that the session is later deleted, we still have some reference to the information.", "type": "string", "readOnly": true, "x-omitempty": true }, "SourceIp": { "description": "The source IP of the client.", "type": "string", "readOnly": true, "x-omitempty": true }, "Timestamp": { "description": "The creation time of AuditRecordLocal, which is the time when the affected MO was created/modified/deleted.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "UserIdOrEmail": { "description": "The userId or the email of the associated user that made the change. In case that user is later deleted, we still have some reference to the information.", "type": "string", "readOnly": true, "x-omitempty": true }, "Account": { "$ref": "#/components/schemas/iam.Account.Relationship", "description": "A reference to a iamAccount resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Sessions": { "$ref": "#/components/schemas/iam.Session.Relationship", "description": "A reference to a iamSession resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "User": { "$ref": "#/components/schemas/iam.User.Relationship", "description": "A reference to a iamUser resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "aaa.AuditRecord.List": { "title": "List of 'aaa.AuditRecord' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'aaa.AuditRecord' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'aaa.AuditRecord' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/aaa.AuditRecord" }, "nullable": true } } } ] }, "aaa.RetentionConfig.Response": { "description": "The response body of a HTTP GET request for the 'aaa.RetentionConfig' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'aaa.RetentionConfig' resources.", "x-one-of-name": "aaa.RetentionConfig.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/aaa.RetentionConfig.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "aaa.RetentionConfig": { "title": "Aaa:Retention Config", "description": "The RetentionConfig object provides default configurations for audit log retention, offering a standardized approach to managing retention periods in the absence of specific policies.\n#### Purpose\nRetentionConfig serves as a baseline configuration for audit log retention, ensuring logs are preserved for a defined period by default when no explicit retention policy exists. This helps maintain consistent log management practices across the system.\n#### Key Concepts\n- **Default Settings:** Establishes default retention periods, ensuring systematic log retention even without custom policies.\n- **System Ownership:** Managed by the system to guarantee reliable and consistent application of retention settings across all accounts.\n- **Read-Only Access:** Designed for safe consumption, ensuring default configurations are applied without unauthorized modifications.\n- **Policy Integration:** Complements account-specific RetentionPolicies, harmonizing log retention across the system.", "x-allOf-name": "aaa.RetentionConfig", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'aaa.RetentionConfig', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "aaa.RetentionConfig" ], "default": "aaa.RetentionConfig", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "aaa.RetentionConfig" ], "default": "aaa.RetentionConfig", "x-enum-as-string": true }, "RetentionPeriod": { "description": "The default retention period in months for audit log retention for accounts without a retention policy.", "type": "integer", "format": "int64", "minimum": 6, "maximum": 48, "readOnly": true, "x-omitempty": true } } } ] }, "aaa.RetentionConfig.List": { "title": "List of 'aaa.RetentionConfig' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'aaa.RetentionConfig' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'aaa.RetentionConfig' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/aaa.RetentionConfig" }, "nullable": true } } } ] }, "aaa.RetentionPolicy.Response": { "description": "The response body of a HTTP GET request for the 'aaa.RetentionPolicy' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'aaa.RetentionPolicy' resources.", "x-one-of-name": "aaa.RetentionPolicy.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/aaa.RetentionPolicy.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "aaa.RetentionPolicy": { "title": "Audit Log Retention Policy", "description": "The RetentionPolicy object governs audit log retention policies at the account level, specifying the duration for which audit logs are preserved before automatic deletion.\n#### Purpose\nA RetentionPolicy defines the time frame for audit log retention, ensuring logs are kept for an appropriate duration to meet organizational and regulatory requirements. This facilitates systematic management of log retention, balancing storage needs with compliance obligations.\n#### Key Concepts\n- **Policy Management:** Allows administrators to define and update retention periods, providing flexibility for changing compliance needs.\n- **Automatic Cleanup:** Enables automatic log deletion based on retention periods, reducing manual overhead and ensuring efficient storage use.\n- **Access Control:** Privilege sets govern the creation, reading, and updating of RetentionPolicies, ensuring only authorized users can modify configurations.\n- **Account Association:** Each RetentionPolicy is linked to specific accounts, enabling tailored retention strategies for different organizational units.", "x-allOf-name": "aaa.RetentionPolicy", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractPolicy" }, { "type": "object", "description": "Definition of the list of properties defined in 'aaa.RetentionPolicy', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "aaa.RetentionPolicy" ], "default": "aaa.RetentionPolicy", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "aaa.RetentionPolicy" ], "default": "aaa.RetentionPolicy", "x-enum-as-string": true }, "RetentionPeriod": { "description": "The time period in months for audit log retention. Audit logs beyond this period will be automatically deleted.", "type": "integer", "format": "int64", "maximum": 48, "x-omitempty": true }, "Account": { "$ref": "#/components/schemas/iam.Account.Relationship", "description": "A reference to a iamAccount resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "aaa.RetentionPolicy.List": { "title": "List of 'aaa.RetentionPolicy' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'aaa.RetentionPolicy' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'aaa.RetentionPolicy' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/aaa.RetentionPolicy" }, "nullable": true } } } ] }, "aaa.UserAgent": { "title": "Aaa:User Agent", "description": "A user agent of an API request. The user agent has information about the operating system family and version that initiated the request. The user agent also has information about the software client that made the request which includes the software type (browser, SDK, etc.) and version.", "x-allOf-name": "aaa.UserAgent", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'aaa.UserAgent', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "aaa.UserAgent" ], "default": "aaa.UserAgent", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "aaa.UserAgent" ], "default": "aaa.UserAgent", "x-enum-as-string": true }, "OsFamily": { "description": "The type of operating system that sent the request.\nNot applicable to Intersight SDK requests.", "type": "string", "readOnly": true, "x-omitempty": true }, "OsVersion": { "description": "The version of the operating system that sent the request.\nNot applicable for Intersight SDK requests.", "type": "string", "readOnly": true, "x-omitempty": true }, "SoftwareFamily": { "description": "The type of client that made the request.\nFor browser requests, it is the specific browser that made the request (e.g. Chrome, Firefox, etc.).", "type": "string", "readOnly": true, "x-omitempty": true }, "SoftwareSubtype": { "description": "The subtype of software that made the request.\nFor SDK requests, this is the programming language used in the SDK. For browser requests, this provides additional context on the client (e.g. if the client is running on a mobile device).", "type": "string", "readOnly": true, "x-omitempty": true }, "SoftwareType": { "description": "The type of application that made the request.\nThis can be a browser or some other software, such as an SDK.", "type": "string", "readOnly": true, "x-omitempty": true }, "SoftwareVersion": { "description": "The version of the client that made the request.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "apic.FabricLeafNodeDetails": { "title": "Apic:Fabric Leaf Node Details", "description": "Fabric leaf node details in APIC.", "x-allOf-name": "apic.FabricLeafNodeDetails", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'apic.FabricLeafNodeDetails', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "apic.FabricLeafNodeDetails" ], "default": "apic.FabricLeafNodeDetails", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "apic.FabricLeafNodeDetails" ], "default": "apic.FabricLeafNodeDetails", "x-enum-as-string": true }, "Id": { "description": "Leaf node ID in Cisco Application Policy Infrastructure Controller (APIC).", "type": "string", "x-omitempty": true }, "Name": { "description": "Leaf node name in Cisco Application Policy Infrastructure Controller (APIC).", "type": "string", "x-omitempty": true } } } ] }, "asset.AddressInformation": { "title": "Asset:Address Information", "description": "Type for saving the address information. It is used in asset.DeviceContractInformation object to save customer address.", "x-allOf-name": "asset.AddressInformation", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.AddressInformation', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.AddressInformation" ], "default": "asset.AddressInformation", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.AddressInformation" ], "default": "asset.AddressInformation", "x-enum-as-string": true }, "Address1": { "description": "Address Line one of the address information. example \"PO BOX 641570\".", "type": "string", "readOnly": true, "x-omitempty": true }, "Address2": { "description": "Address Line two of the address information. example \"Cisco Systems\".", "type": "string", "readOnly": true, "x-omitempty": true }, "Address3": { "description": "Address Line three of the address information. example \"Cisco Systems\".", "type": "string", "readOnly": true, "x-omitempty": true }, "City": { "description": "City in which the address resides. example \"San Jose\".", "type": "string", "readOnly": true, "x-omitempty": true }, "Country": { "description": "Country in which the address resides. example \"US\".", "type": "string", "readOnly": true, "x-omitempty": true }, "County": { "description": "County in which the address resides. example \"Washington County\".", "type": "string", "readOnly": true, "x-omitempty": true }, "Location": { "description": "Location in which the address resides. example \"14852\".", "type": "string", "readOnly": true, "x-omitempty": true }, "Name": { "description": "Name of the user whose address is being populated.", "type": "string", "readOnly": true, "x-omitempty": true }, "PostalCode": { "description": "Postal Code in which the address resides. example \"95164-1570\".", "type": "string", "readOnly": true, "x-omitempty": true }, "Province": { "description": "Province in which the address resides. example \"AB\".", "type": "string", "readOnly": true, "x-omitempty": true }, "State": { "description": "State in which the address resides. example \"CA\".", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "asset.AlarmSummary": { "title": "Asset:Alarm Summary", "description": "The summary of alarm counts based on alarm serverity.", "x-allOf-name": "asset.AlarmSummary", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.AlarmSummary', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.AlarmSummary" ], "default": "asset.AlarmSummary", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.AlarmSummary" ], "default": "asset.AlarmSummary", "x-enum-as-string": true }, "Critical": { "description": "The count of active alarms that have severity type Critical.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Health": { "description": "Health of the managed end point. The highest severity computed from alarmSummary property is set as the health.\n* `Healthy` - The Enum value represents that the entity is healthy.\n* `Warning` - The Enum value Warning represents that the entity has one or more active warnings on it.\n* `Critical` - The Enum value Critical represents that the entity is in a critical state.", "type": "string", "enum": [ "Healthy", "Warning", "Critical" ], "default": "Healthy", "readOnly": true, "x-omitempty": true }, "Info": { "description": "The count of active alarms that have severity type Info.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "SuppressedCritical": { "description": "The count of active suppressed alarms that have severity type Critical.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "SuppressedInfo": { "description": "The count of active suppressed alarms that have severity type Info.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "SuppressedWarning": { "description": "The count of active suppressed alarms that have severity type Warning.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Warning": { "description": "The count of active alarms that have severity type Warning.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true } } } ] }, "asset.ApiKeyCredential": { "title": "Asset:Api Key Credential", "description": "API key based authentication.", "x-allOf-name": "asset.ApiKeyCredential", "allOf": [ { "$ref": "#/components/schemas/asset.Credential" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.ApiKeyCredential', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.ApiKeyCredential" ], "default": "asset.ApiKeyCredential", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.ApiKeyCredential" ], "default": "asset.ApiKeyCredential", "x-enum-as-string": true }, "ApiKey": { "description": "This a secret API key which can be used for authentication purposes for different targets like Azure Enterprise Agreement.", "type": "string", "writeOnly": true, "x-omitempty": true }, "IsApiKeySet": { "description": "Indicates whether the value of the 'apiKey' property has been set.", "type": "boolean", "default": false, "readOnly": true, "x-omitempty": true } } } ] }, "asset.ClaimSignature": { "title": "Asset:Claim Signature", "description": "A cryptographic signature that can be used to auto-claim a device connector into a user's account.", "x-allOf-name": "asset.ClaimSignature", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.ClaimSignature', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "asset.ParentConnectionSignature", "asset.TargetSignature", "asset.Token" ], "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "asset.ParentConnectionSignature", "asset.TargetSignature", "asset.Token" ], "x-enum-as-string": true }, "Signature": { "description": "The result of signing the deviceId appended with the timeStamp fields with the devices private key.", "type": "string", "format": "byte", "x-omitempty": true }, "TimeStamp": { "description": "The time at which the signature was generated. Date is accurate to Intersights clock. Used to expire the signature.", "type": "string", "format": "date-time", "x-omitempty": true } } } ] }, "asset.ClaimToken.Response": { "description": "The response body of a HTTP GET request for the 'asset.ClaimToken' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'asset.ClaimToken' resources.", "x-one-of-name": "asset.ClaimToken.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/asset.ClaimToken.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "asset.ClaimToken": { "title": "Asset:Claim Token", "description": "The ClaimToken object serves as a secure mechanism for onboarding and registering devices to an Intersight user account. It facilitates a streamlined connection process, allowing device connectors to authenticate and associate themselves with a specific user environment without requiring complex manual configuration or external dial-out procedures.\n#### Purpose\nA ClaimToken acts as a bridge between a physical or virtual device and the Intersight platform. Supplies the necessary credentials and instructions for a device connector to establish a secure link to the user's account, ensuring that device claiming is performed in a controlled and authorized manner.\n#### Key Concepts\n- **Simplified Onboarding:** Enables the claiming of devices into an Intersight account by providing a pre-configured token, removing the need for the appliance to perform manual outbound configuration. - **Security and Verification:** Incorporates cryptographic signatures to verify the legitimacy of the claim, ensuring that only authorized devices can be associated with an account. - **Access Control:** Management of claim tokens is restricted to specific privilege sets, such as Account Administrators and users with dedicated Claim Devices or Claim targets permissions, ensuring that only authorized personnel can initiate device registration. - **Lifecycle Management:** Includes built-in expiration logic to maintain security, ensuring that tokens remain valid only for a defined period and reducing the risk associated with long-lived or unused tokens.", "x-allOf-name": "asset.ClaimToken", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.ClaimToken', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.ClaimToken" ], "default": "asset.ClaimToken", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.ClaimToken" ], "default": "asset.ClaimToken", "x-enum-as-string": true }, "Claim": { "description": "The claim generated to configure the device to connect and claim to the user account.", "type": "string", "x-omitempty": true }, "ExpirationDate": { "description": "The expiry time of the claim token, after this time any generated claims from this token are no longer valid.", "type": "string", "format": "date-time", "x-omitempty": true }, "User": { "$ref": "#/components/schemas/iam.User.Relationship", "description": "A reference to a iamUser resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." } } } ] }, "asset.ClaimToken.List": { "title": "List of 'asset.ClaimToken' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'asset.ClaimToken' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'asset.ClaimToken' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/asset.ClaimToken" }, "nullable": true } } } ] }, "asset.ClientCertificateCredential": { "title": "Asset:Client Certificate Credential", "description": "A credential which performs authentication with TLS client certificates.", "x-allOf-name": "asset.ClientCertificateCredential", "allOf": [ { "$ref": "#/components/schemas/asset.Credential" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.ClientCertificateCredential', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.ClientCertificateCredential" ], "default": "asset.ClientCertificateCredential", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.ClientCertificateCredential" ], "default": "asset.ClientCertificateCredential", "x-enum-as-string": true }, "ClientCertificate": { "description": "PEM encoded x509 client certificate used to authenticate with the target.", "type": "string", "x-omitempty": true }, "ClientKey": { "description": "PEM encoded private key used to authenticate with the target.", "type": "string", "writeOnly": true, "x-omitempty": true }, "IsClientKeySet": { "description": "Indicates whether the value of the 'clientKey' property has been set.", "type": "boolean", "default": false, "readOnly": true, "x-omitempty": true } } } ] }, "asset.CloudConnection": { "title": "Asset:Cloud Connection", "description": "CloudConnection provides the necessary details for Intersight to connect to and authenticate with a target at a well-known service address. The service address is inferred based upon the target type. For example Amazon Web Services.", "x-allOf-name": "asset.CloudConnection", "allOf": [ { "$ref": "#/components/schemas/asset.Connection" } ] }, "asset.ClusterMember.Response": { "description": "The response body of a HTTP GET request for the 'asset.ClusterMember' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'asset.ClusterMember' resources.", "x-one-of-name": "asset.ClusterMember.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/asset.ClusterMember.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "asset.ClusterMember.Relationship": { "description": "A relationship to the 'asset.ClusterMember' resource, or the expanded 'asset.ClusterMember' resource, or the 'null' value.", "x-one-of-name": "asset.ClusterMember.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/asset.ClusterMember" } ], "discriminator": { "propertyName": "ClassId" } }, "asset.ClusterMember": { "title": "Asset:Cluster Member", "description": "The ClusterMember object represents a node within a cluster of device connectors. This provides detailed insights into the individual members of a device cluster, supporting high availability and redundancy in device management.\n#### Purpose\nClusterMember facilitates the management of clustered devices by capturing connection details and leadership states of each node. It plays a crucial role in ensuring that device management is robust and scalable, supporting seamless failover and load balancing.\n#### Key Concepts\n- **Cluster Identity:** Maintains unique identities for each node within the cluster, ensuring precise tracking and management.\n- **Leadership Management:** Monitors leadership states within the cluster, supporting efficient failover and recovery processes.\n- **Connection Details:** Provides granular visibility into the connection status and configuration of each cluster member, enabling proactive management.", "x-allOf-name": "asset.ClusterMember", "allOf": [ { "$ref": "#/components/schemas/asset.DeviceConnection" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.ClusterMember', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.ClusterMember" ], "default": "asset.ClusterMember", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.ClusterMember" ], "default": "asset.ClusterMember", "x-enum-as-string": true }, "ConnectedHost": { "description": "The DNS hostname the device connector has used to connect to Intersight. Devices may be configured to connect to a set of DNS hostnames which all resolve to the same Intersight instance, the connected host is the latest hostname the device used to connect successfully to Intersight.", "type": "string", "readOnly": true, "x-omitempty": true }, "ConnectionFlapStatus": { "description": "Encapsulates key details used to identify devices experiencing connection flapping.", "$ref": "#/components/schemas/asset.ConnectionFlapStatus", "readOnly": true, "x-omitempty": true }, "Leadership": { "description": "The current leadershipstate of this member. Updated by the device connector on failover or leadership change. If a member is elected as Primary within the cluster this connection will be the same as the DeviceRegistration connection. E.g a message addressed to the DeviceRegistration will be forwarded to the ClusterMember connection.\n* `Unknown` - The node is unable to complete election or determine the current state. If the device has been registered before and the node has access to the current credentials, it will establish a connection to Intersight with limited capabilities that can be used to debug the HA failure from Intersight.\n* `Primary` - The node has been elected as the primary and will establish a connection to the Intersight service and accept all message types enabled for a primary node. There can only be one primary node in a given cluster, while the underlying platform may be active. If it is active, only one connector will assume the primary role.\n* `Secondary` - The node has been elected as a secondary node in the cluster. The device connector will establish a connection to the Intersight service with limited capabilities. E.g. file upload will be enabled, but requests to the underlying platform management will be disabled.", "type": "string", "enum": [ "Unknown", "Primary", "Secondary" ], "default": "Unknown", "readOnly": true, "x-omitempty": true }, "LockedLeader": { "description": "Devices lock their leadership on failure to heartbeat with peers. Value acts as a third party tie breaker in election between nodes. Intersight enforces that only one cluster member exists with this value set to true.", "type": "boolean", "x-omitempty": true }, "MemberIdentity": { "description": "The unique identity of the member within the cluster. The identity is retrieved from the platform and reported by the device connector at connection time.", "type": "string", "readOnly": true, "x-omitempty": true }, "ParentClusterMemberIdentity": { "description": "The member idenity of the cluster member through which this device is connected if applicable.", "type": "string", "readOnly": true, "x-omitempty": true }, "Sudi": { "description": "The SUDI status read from the Trust Anchor Module on a device.", "$ref": "#/components/schemas/asset.SudiInfo", "readOnly": true, "x-omitempty": true }, "Device": { "$ref": "#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "asset.ClusterMember.List": { "title": "List of 'asset.ClusterMember' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'asset.ClusterMember' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'asset.ClusterMember' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/asset.ClusterMember" }, "nullable": true } } } ] }, "asset.Connection": { "title": "Asset:Connection", "description": "A method for Intersight to connect to a managed target, including network connectivity and authentication details.", "x-allOf-name": "asset.Connection", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.Connection', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "asset.CloudConnection", "asset.HttpConnection", "asset.IntersightDeviceConnectorConnection", "asset.ScopedTargetConnection", "asset.SshConnection" ], "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "asset.CloudConnection", "asset.HttpConnection", "asset.IntersightDeviceConnectorConnection", "asset.ScopedTargetConnection", "asset.SshConnection" ], "x-enum-as-string": true }, "Credential": { "description": "The credential to be used to authenticate with the managed target.", "$ref": "#/components/schemas/asset.Credential", "x-omitempty": true } } } ] }, "asset.ConnectionFlapStatus": { "title": "Asset:Connection Flap Status", "description": "Encapsulates key details used to identify devices experiencing connection flapping.", "x-allOf-name": "asset.ConnectionFlapStatus", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.ConnectionFlapStatus', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.ConnectionFlapStatus" ], "default": "asset.ConnectionFlapStatus", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.ConnectionFlapStatus" ], "default": "asset.ConnectionFlapStatus", "x-enum-as-string": true }, "FlapAlertTime": { "description": "Time when flapping was reported.", "type": "string", "format": "date-time", "x-omitempty": true }, "FlapCount": { "description": "The number of times a device disconnected within a specified time window.", "type": "integer", "format": "int64", "x-omitempty": true }, "FlapDetected": { "description": "Indicates if the device is flapping.", "type": "boolean", "x-omitempty": true }, "WindowSize": { "description": "The time window during which device disconnects are counted. E.g. values are PT30M or PT1H.", "type": "string", "x-omitempty": true } } } ] }, "asset.ContractInformation": { "title": "Asset:Contract Information", "description": "Type for saving contract information.", "x-allOf-name": "asset.ContractInformation", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.ContractInformation', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.ContractInformation" ], "default": "asset.ContractInformation", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.ContractInformation" ], "default": "asset.ContractInformation", "x-enum-as-string": true }, "BillTo": { "description": "BillTo address of listed for the contract.", "$ref": "#/components/schemas/asset.AddressInformation", "readOnly": true, "x-omitempty": true }, "BillToGlobalUltimate": { "description": "BillToGlobalUltimate information listed in the contract.", "$ref": "#/components/schemas/asset.GlobalUltimate", "readOnly": true, "x-omitempty": true }, "ContractNumber": { "description": "Contract number for the Cisco support contract purchased for the Cisco device.", "type": "string", "readOnly": true, "x-omitempty": true }, "LineStatus": { "description": "Contract status as per the Cisco Contract APIx.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "asset.Credential": { "title": "Asset:Credential", "description": "A credential which can be used to authenticate with a managed target.", "x-allOf-name": "asset.Credential", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" } ] }, "asset.CustomerInformation": { "title": "Asset:Customer Information", "description": "Type for saving contract information.", "x-allOf-name": "asset.CustomerInformation", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.CustomerInformation', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.CustomerInformation" ], "default": "asset.CustomerInformation", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.CustomerInformation" ], "default": "asset.CustomerInformation", "x-enum-as-string": true }, "Address": { "description": "Address as per the information provided by the user.", "$ref": "#/components/schemas/asset.AddressInformation", "readOnly": true, "x-omitempty": true }, "Id": { "description": "Unique identifier for an end customer. This identifier is allocated by Cisco.", "type": "string", "readOnly": true, "x-omitempty": true }, "Name": { "description": "Name as per the information provided by the user.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "asset.Deployment.Response": { "description": "The response body of a HTTP GET request for the 'asset.Deployment' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'asset.Deployment' resources.", "x-one-of-name": "asset.Deployment.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/asset.Deployment.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "asset.Deployment.Relationship": { "description": "A relationship to the 'asset.Deployment' resource, or the expanded 'asset.Deployment' resource, or the 'null' value.", "x-one-of-name": "asset.Deployment.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/asset.Deployment" } ], "discriminator": { "propertyName": "ClassId" } }, "asset.Deployment": { "title": "Asset:Deployment", "description": "The Deployment object is an essential element of the Cisco consumption-based subscription ecosystem, providing detailed information about deployments associated with subscriptions. It ensures seamless integration and updates through Cisco Install Base, supporting effective deployment tracking and management.\n#### Purpose\nDeployment serves as a detailed repository for tracking and managing deployments under consumption-based subscriptions, facilitating automated updates and ensuring accurate data representation. This information is also queried by downstream OPUS team for billing purposes. \n#### Key Concepts\n- **Integration:** Automates deployment management through synchronization with Cisco Install Base, ensuring data accuracy.\n- **Detailed Information:** Provides comprehensive data on deployment status, customer details, and associated metrics.\n- **Access Management:** Enforces secure access through defined privileges, ensuring only authorized users can interact with deployment data.\n- **Relationship and Dependency Handling:** Manages complex relationships between deployments, devices, and subscriptions, supporting efficient management.\n- **Consumption metering Alerts:** It keeps track of Deployment level consumption based metering related alerts.", "x-allOf-name": "asset.Deployment", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.Deployment', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.Deployment" ], "default": "asset.Deployment", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.Deployment" ], "default": "asset.Deployment", "x-enum-as-string": true }, "AlarmInfo": { "description": "Different alarm types raised for the deployment.", "$ref": "#/components/schemas/asset.DeploymentAlarmInfo", "readOnly": true, "x-omitempty": true }, "DeploymentRefId": { "description": "Identifies the consumption-based subscription's deployment.", "type": "string", "readOnly": true, "x-omitempty": true }, "EndCustomer": { "description": "End customer information for the purchased Cisco device's deployment.", "$ref": "#/components/schemas/asset.CustomerInformation", "readOnly": true, "x-omitempty": true }, "EndDate": { "description": "End Date for the consumption-based subscription's deployment.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "LicenseType": { "description": "Active license tier for the purchased Cisco device's deployment.\n* `Base` - Base as a License type. It is default license type.\n* `Essential` - Essential as a License type.\n* `Standard` - Standard as a License type.\n* `Advantage` - Advantage as a License type.\n* `Premier` - Premier as a License type.\n* `IWO-Essential` - IWO-Essential as a License type.\n* `IWO-Advantage` - IWO-Advantage as a License type.\n* `IWO-Premier` - IWO-Premier as a License type.\n* `IKS-Advantage` - IKS-Advantage as a License type.\n* `INC-Premier-1GFixed` - Premier 1G Fixed license tier for Intersight Nexus Cloud.\n* `INC-Premier-10GFixed` - Premier 10G Fixed license tier for Intersight Nexus Cloud.\n* `INC-Premier-100GFixed` - Premier 100G Fixed license tier for Intersight Nexus Cloud.\n* `INC-Premier-Mod4Slot` - Premier Modular 4 slot license tier for Intersight Nexus Cloud.\n* `INC-Premier-Mod8Slot` - Premier Modular 8 slot license tier for Intersight Nexus Cloud.\n* `INC-Premier-D2OpsFixed` - Premier D2Ops fixed license tier for Intersight Nexus Cloud.\n* `INC-Premier-D2OpsMod` - Premier D2Ops modular license tier for Intersight Nexus Cloud.\n* `INC-Premier-CentralizedMod8Slot` - Premier modular license tier of switch type CentralizedMod8Slot for Intersight Nexus Cloud.\n* `INC-Premier-DistributedMod8Slot` - Premier modular license tier of switch type DistributedMod8Slot for Intersight Nexus Cloud.\n* `ERP-Advantage` - Advantage license tier for ERP workflows.\n* `IntersightTrial` - Virtual dummy license type to indicate trial. Used for UI display of trial mode Intersight tiers.\n* `IWOTrial` - Virtual dummy license type to indicate trial. Used for UI display of trial mode IKS tiers.\n* `IKSTrial` - Virtual dummy license type to indicate trial. Used for UI display of trial mode IWO tiers.\n* `INCTrial` - Virtual dummy license type to indicate trial. Used for UI display of trial mode Nexus tiers.", "type": "string", "enum": [ "Base", "Essential", "Standard", "Advantage", "Premier", "IWO-Essential", "IWO-Advantage", "IWO-Premier", "IKS-Advantage", "INC-Premier-1GFixed", "INC-Premier-10GFixed", "INC-Premier-100GFixed", "INC-Premier-Mod4Slot", "INC-Premier-Mod8Slot", "INC-Premier-D2OpsFixed", "INC-Premier-D2OpsMod", "INC-Premier-CentralizedMod8Slot", "INC-Premier-DistributedMod8Slot", "ERP-Advantage", "IntersightTrial", "IWOTrial", "IKSTrial", "INCTrial" ], "default": "Base", "readOnly": true, "x-omitempty": true }, "MlbOfferType": { "description": "Identifier for consumption based pricing. MLB refers to MultiLine Bundle.", "type": "string", "readOnly": true, "x-omitempty": true }, "StartDate": { "description": "Start Date for the consumption-based subscription's deployment.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "SubscriptionRefId": { "description": "Identifies the consumption-based subscription.", "type": "string", "readOnly": true, "x-omitempty": true }, "UnitOfMeasure": { "type": "array", "items": { "description": "Unit of Measure identifies the type of metric being pushed. It is an array field. It contains \"vMemory\" for vm based metering, \"Storage\" for storage based metering and \"Node\" for Node based metering.", "$ref": "#/components/schemas/asset.MeteringType", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Workloads": { "type": "array", "items": { "description": "Workload/Usecase running on the deployment.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Devices": { "description": "An array of relationships to assetDeploymentDevice resources.", "type": "array", "items": { "$ref": "#/components/schemas/asset.DeploymentDevice.Relationship" }, "nullable": true, "readOnly": true }, "Subscription": { "$ref": "#/components/schemas/asset.Subscription.Relationship", "description": "A reference to a assetSubscription resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "asset.Deployment.List": { "title": "List of 'asset.Deployment' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'asset.Deployment' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'asset.Deployment' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/asset.Deployment" }, "nullable": true } } } ] }, "asset.DeploymentAlarmInfo": { "title": "Asset:Deployment Alarm Info", "description": "Persists the different alarm type flags.", "x-allOf-name": "asset.DeploymentAlarmInfo", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.DeploymentAlarmInfo', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.DeploymentAlarmInfo" ], "default": "asset.DeploymentAlarmInfo", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.DeploymentAlarmInfo" ], "default": "asset.DeploymentAlarmInfo", "x-enum-as-string": true }, "EnabledAlarms": { "type": "array", "items": { "description": "List of deployment related alarms raised.\n* `Unknown` - No specific alarms raised at this point of time.\n* `InvalidNodeLicense` - This deployment related alarm is raised when license tier on a deployment with node-metered servers is not Advantage+.\n* `InconsistentUnitOfMeasure` - This deployment related alarm is raised when devices of the same type within a deployment have different units of measure.\n* `InconsistentClusterUnitOfMeasure` - This deployment related alarm is raised when vm-metered servers forming an ESXi cluster have different units of measure.\n* `InvalidEsxiLicense` - This deployment related alarm is raised when license tier on a deployment with VM-metered servers is not Advantage+.\n* `VcenterNotClaimed` - This deployment related alarm is raised when vCenter associated with one or more deployments shows up as unclaimed.\n* `InvalidEsxiAccountLicense` - This deployment related alarm is raised when deployment contains connected VM-metered servers but accounts's license tier is not Advantage+.\n* `NonConsumptionESXiServerAssociated` - This deployment related alarm is raised when deployment contains non-consumption servers participate in an ESXi cluster.\n* `InvalidSubscriptionAssociated` - This deployment related alarm is raised when servers within an ESXi cluster are part of different subscriptions.\n* `InvalidDeploymentAssociated` - This deployment related alarm is raised when servers are not part of related deployments.\n* `VcenterNotPublishingStats` - This deployment related alarm is raised when vm/cluster stats are not recorded from ESXi clusters for over 24 hours.\n* `InvalidCpuOverCommitmentFactor` - This deployment related alarm is raised when configured CPU over-commitment is higher than 2:1 on an ESXi cluster.\n* `InvalidVirtualCpuRatio` - This deployment related alarm is raised when total vCPUs allocated to VMs is greater than 2x the pCPUs available to the ESXi cluster.\n* `HxNotClaimed` - This deployment related alarm is raised when HyperFlex cluster associated with one or more deployments shows up as unclaimed.\n* `HxNotPublishingStats` - This deployment related alarm is raised when used/total storage is not recorded from HyperFlex clusters for over 24 hours.\n* `IncorrectReplicationFactor` - This deployment related alarm is raised when replication/redundancy factor on an HyperFlex cluster is configured lower than 3 (non-edge) or 2 (edge).", "type": "string", "enum": [ "Unknown", "InvalidNodeLicense", "InconsistentUnitOfMeasure", "InconsistentClusterUnitOfMeasure", "InvalidEsxiLicense", "VcenterNotClaimed", "InvalidEsxiAccountLicense", "NonConsumptionESXiServerAssociated", "InvalidSubscriptionAssociated", "InvalidDeploymentAssociated", "VcenterNotPublishingStats", "InvalidCpuOverCommitmentFactor", "InvalidVirtualCpuRatio", "HxNotClaimed", "HxNotPublishingStats", "IncorrectReplicationFactor" ], "default": "Unknown", "readOnly": true, "x-omitempty": true }, "nullable": true } } } ] }, "asset.DeploymentDevice.Response": { "description": "The response body of a HTTP GET request for the 'asset.DeploymentDevice' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'asset.DeploymentDevice' resources.", "x-one-of-name": "asset.DeploymentDevice.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/asset.DeploymentDevice.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "asset.DeploymentDevice.Relationship": { "description": "A relationship to the 'asset.DeploymentDevice' resource, or the expanded 'asset.DeploymentDevice' resource, or the 'null' value.", "x-one-of-name": "asset.DeploymentDevice.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/asset.DeploymentDevice" } ], "discriminator": { "propertyName": "ClassId" } }, "asset.DeploymentDevice": { "title": "Asset:Deployment Device", "description": "The DeploymentDevice object is pivotal in managing device information within consumption-based subscriptions. This provides a detailed view of device installation status, replacements, and transaction history, facilitating seamless management through Cisco Install Base integration.\n#### Purpose\nDeploymentDevice acts as a detailed repository for device-related data within deployments, ensuring accurate tracking under consumption-based subscriptions. This information is also queried by downstream OPUS team for billing purposes. \n#### Key Concepts\n- **Device Management:** Centralizes device data, supporting efficient tracking and management within deployments.\n- **Integration with Install Base:** Listens to messages from Cisco Install Base for automated data updates, ensuring accuracy.\n- **Access Management:** Enforces secure access through defined privileges, ensuring only authorized users can interact with DeploymentDevice data.\n- **Heartbeat generation:** Active DeploymentDevice records are used to publish hourly heartbeats to track device level subscription usage for billing purposes.\n- **Relationship Management:** Manages associations between devices and deployments, supporting effective data management.\n- **Consumption metering Alerts:** It keeps track of device level consumption based metering related alerts.", "x-allOf-name": "asset.DeploymentDevice", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.DeploymentDevice', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.DeploymentDevice" ], "default": "asset.DeploymentDevice", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.DeploymentDevice" ], "default": "asset.DeploymentDevice", "x-enum-as-string": true }, "AlarmInfo": { "description": "Different alarm types raised for the deployment.", "$ref": "#/components/schemas/asset.DeploymentDeviceAlarmInfo", "readOnly": true, "x-omitempty": true }, "DeviceId": { "description": "Unique identifier of the Cisco device.", "type": "string", "readOnly": true, "x-omitempty": true }, "DeviceInformation": { "description": "Detailed device information including installation status and customer address.", "$ref": "#/components/schemas/asset.DeploymentDeviceInformation", "readOnly": true, "x-omitempty": true }, "DevicePid": { "description": "Product identifier for the specified Cisco device. It is used to distinguish between HyperFlex and UCS devices.", "type": "string", "readOnly": true, "x-omitempty": true }, "DeviceStatistics": { "description": "Device statistics for HyperFlex and UCS devices.", "$ref": "#/components/schemas/asset.DeviceStatistics", "readOnly": true, "x-omitempty": true }, "ProductSubgroup": { "description": "Product Subgroup type helps to determine if device subgroup within Product type has to be billed using consumption metering. example \"N9300 Series\" in Product type \"SWITCH\".", "type": "string", "readOnly": true, "x-omitempty": true }, "ProductType": { "description": "Product type helps to determine if device has to be billed using consumption metering. example \"SERVER\".", "type": "string", "readOnly": true, "x-omitempty": true }, "RegisteredDeviceMoid": { "description": "String reference to the device connector.", "type": "string", "readOnly": true, "x-omitempty": true }, "UnitOfMeasure": { "type": "array", "items": { "description": "Unit of Measure identifies the type of metric being pushed. It is an array field. It contains \"vMemory\" for vm based metering, \"Storage\" for storage based metering and \"Node\" for Node based metering.", "$ref": "#/components/schemas/asset.MeteringType", "readOnly": true, "x-omitempty": true }, "nullable": true }, "VirtualizationPlatform": { "description": "Virtualization platform is used to identify the hypervisor type. example \"ESXi\".", "type": "string", "readOnly": true, "x-omitempty": true }, "Workload": { "description": "Workload/Usecase running on the device.", "type": "string", "readOnly": true, "x-omitempty": true }, "Deployment": { "$ref": "#/components/schemas/asset.Deployment.Relationship", "description": "A reference to a assetDeployment resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "DeviceContractInformation": { "$ref": "#/components/schemas/asset.DeviceContractInformation.Relationship", "description": "A reference to a assetDeviceContractInformation resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Subscription": { "$ref": "#/components/schemas/asset.Subscription.Relationship", "description": "A reference to a assetSubscription resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "SubscriptionAccount": { "$ref": "#/components/schemas/asset.SubscriptionAccount.Relationship", "description": "A reference to a assetSubscriptionAccount resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "asset.DeploymentDevice.List": { "title": "List of 'asset.DeploymentDevice' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'asset.DeploymentDevice' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'asset.DeploymentDevice' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/asset.DeploymentDevice" }, "nullable": true } } } ] }, "asset.DeploymentDeviceAlarmInfo": { "title": "Asset:Deployment Device Alarm Info", "description": "Persists the different alarm type flags.", "x-allOf-name": "asset.DeploymentDeviceAlarmInfo", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.DeploymentDeviceAlarmInfo', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.DeploymentDeviceAlarmInfo" ], "default": "asset.DeploymentDeviceAlarmInfo", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.DeploymentDeviceAlarmInfo" ], "default": "asset.DeploymentDeviceAlarmInfo", "x-enum-as-string": true }, "EnabledAlarms": { "type": "array", "items": { "description": "List of device related alarms raised.\n* `Unknown` - No specific alarms raised at this point of time.\n* `DeviceNotReachable` - This device related alarm is raised when the device is not connected to Intersight.\n* `DeviceNotClaimed` - This device related alarm is raised when the device is not claimed within Intersight.\n* `DeviceNotEsxiClusterMember` - This device related alarm is raised when the VM-metered server is not part of an ESXi cluster.\n* `InvalidMemoryMirroringFactor` - This device related alarm is raised when memory mirroring is enabled on a VM-metered server.\n* `InvalidUcsServerLicense` - This device related alarm is raised when a claimed UCS server is not associated with the deployment's license.\n* `DeviceNotPublishingPowerState` - This device related alarm is raised when power state from connected node-metered servers is absent or unknown for over 24 hours.", "type": "string", "enum": [ "Unknown", "DeviceNotReachable", "DeviceNotClaimed", "DeviceNotEsxiClusterMember", "InvalidMemoryMirroringFactor", "InvalidUcsServerLicense", "DeviceNotPublishingPowerState" ], "default": "Unknown", "readOnly": true, "x-omitempty": true }, "nullable": true } } } ] }, "asset.DeploymentDeviceInformation": { "title": "Asset:Deployment Device Information", "description": "Type for saving the device information reported by Cisco Install Base. It is used in asset.DeploymentDevice object to save the device information.", "x-allOf-name": "asset.DeploymentDeviceInformation", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.DeploymentDeviceInformation', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.DeploymentDeviceInformation" ], "default": "asset.DeploymentDeviceInformation", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.DeploymentDeviceInformation" ], "default": "asset.DeploymentDeviceInformation", "x-enum-as-string": true }, "ApplicationName": { "description": "Application name reported by Cisco Install Base.", "type": "string", "readOnly": true, "x-omitempty": true }, "Description": { "description": "Description of device reported by Cisco Install Base.", "type": "string", "readOnly": true, "x-omitempty": true }, "DeviceTransactions": { "type": "array", "items": { "description": "All the device transactions reported by Cisco Install Base.", "$ref": "#/components/schemas/asset.DeviceTransaction", "readOnly": true, "x-omitempty": true }, "nullable": true }, "InstanceId": { "description": "Instance number of the device. example \"917280220\".", "type": "string", "readOnly": true, "x-omitempty": true }, "ItemType": { "description": "Item type flag. example ATO, Child, Standalone. ATO - refers to Cisco Block based major device. Child - refers to Child device part of an ATO block. Standalone - refers to a device that is managed and configured as an individual entity with limited capacity.", "type": "string", "readOnly": true, "x-omitempty": true }, "MlbProductId": { "description": "Identifier corresponding to MLB Product Name. MLB refers to MultiLine Bundle.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "MlbProductName": { "description": "Product Name for the device. It is used to determine if the server is to be billed as a UCS compute device or a storage cluster. MLB refers to MultiLine Bundle.", "type": "string", "readOnly": true, "x-omitempty": true }, "OldDeviceId": { "description": "Unique identifier of old Cisco device. It is the device ID of old Cisco device, which got replaced by the new device.", "type": "string", "readOnly": true, "x-omitempty": true }, "OldDeviceStatusDescription": { "description": "Description of status of old Cisco device, which got replaced by the new device.", "type": "string", "readOnly": true, "x-omitempty": true }, "OldDeviceStatusId": { "description": "Status ID of old Cisco device, which got replaced by the new device.\n* `0` - A default value to catch cases where device status is not correctly detected.\n* `10000` - Device is installed successfully.\n* `1010041` - Device is currently in Return Material Authorization process.\n* `10005` - Device is replaced successfully with another device.\n* `10007` - Device is returned succcessfuly.\n* `10009` - Device is terminated at customer's end.", "type": "integer", "enum": [ 0, 10000, 1010041, 10005, 10007, 10009 ], "default": 0, "readOnly": true, "x-omitempty": true }, "OldInstanceId": { "description": "Instance number of the old device, which got replaced by the new device.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "asset.DeviceClaim.Relationship": { "description": "A relationship to the 'asset.DeviceClaim' resource, or the expanded 'asset.DeviceClaim' resource, or the 'null' value.", "x-one-of-name": "asset.DeviceClaim.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/asset.DeviceClaim" } ], "discriminator": { "propertyName": "ClassId" } }, "asset.DeviceClaim": { "title": "Asset:Device Claim", "description": "DeviceClaim captures the intent to claim a device to an Intersight account. A device can be unclaimed by performing a DELETE on a DeviceClaim instance. When performing a claim, a secret passphrase must be obtained from the device connector UI/API by a sufficiently privileged user. The passphrase is timebound and proves that the user currently has privileged administrative access to the device being claimed.", "x-allOf-name": "asset.DeviceClaim", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.DeviceClaim', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.DeviceClaim" ], "default": "asset.DeviceClaim", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.DeviceClaim" ], "default": "asset.DeviceClaim", "x-enum-as-string": true }, "SecurityToken": { "description": "Obtained from the device connector management UI or API (REST endpoint '/connector/SecurityTokens').", "type": "string", "x-createOnly": true, "x-omitempty": true }, "SerialNumber": { "description": "Obtained from the device connector management UI or API (REST endpoint '/connector/DeviceIdentifiers').", "type": "string", "x-createOnly": true, "x-omitempty": true }, "Account": { "$ref": "#/components/schemas/iam.Account.Relationship", "description": "A reference to a iamAccount resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "CustomPermissionResources": { "description": "An array of relationships to moBaseMo resources.", "type": "array", "items": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo.Relationship" }, "nullable": true, "readOnly": true }, "Device": { "$ref": "#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Reservation": { "$ref": "#/components/schemas/resource.Reservation.Relationship", "description": "A reference to a resourceReservation resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true } } } ] }, "asset.DeviceConfiguration.Response": { "description": "The response body of a HTTP GET request for the 'asset.DeviceConfiguration' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'asset.DeviceConfiguration' resources.", "x-one-of-name": "asset.DeviceConfiguration.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/asset.DeviceConfiguration.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "asset.DeviceConfiguration.Relationship": { "description": "A relationship to the 'asset.DeviceConfiguration' resource, or the expanded 'asset.DeviceConfiguration' resource, or the 'null' value.", "x-one-of-name": "asset.DeviceConfiguration.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/asset.DeviceConfiguration" } ], "discriminator": { "propertyName": "ClassId" } }, "asset.DeviceConfiguration": { "title": "Asset:Device Configuration", "description": "The configuration of a device connector. Configuration properties may be changed by a Intersight user or by a device administrator using the connector's API exposed through the platforms management interface.", "x-allOf-name": "asset.DeviceConfiguration", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.DeviceConfiguration', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.DeviceConfiguration" ], "default": "asset.DeviceConfiguration", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.DeviceConfiguration" ], "default": "asset.DeviceConfiguration", "x-enum-as-string": true }, "LocalConfigurationLocked": { "description": "Specifies whether configuration through the platforms local management interface has been disabled, with only configuration through the Intersight service enabled.", "type": "boolean", "x-omitempty": true }, "LogLevel": { "description": "The log level of the device connector service.", "type": "string", "x-omitempty": true }, "TunneledKvm": { "description": "Specifies whether Tunneled vKVM is enabled on the device connector.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "Device": { "$ref": "#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "asset.DeviceConfiguration.List": { "title": "List of 'asset.DeviceConfiguration' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'asset.DeviceConfiguration' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'asset.DeviceConfiguration' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/asset.DeviceConfiguration" }, "nullable": true } } } ] }, "asset.DeviceConnection.Relationship": { "description": "A relationship to the 'asset.DeviceConnection' resource, or the expanded 'asset.DeviceConnection' resource, or the 'null' value.", "x-one-of-name": "asset.DeviceConnection.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/asset.DeviceConnection" } ], "discriminator": { "propertyName": "ClassId" } }, "asset.DeviceConnection": { "title": "Asset:Device Connection", "description": "An abstract class that holds the details of a device connectors connection to Intersight.", "x-allOf-name": "asset.DeviceConnection", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.DeviceConnection', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "asset.ClusterMember", "asset.DeviceRegistration" ], "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "asset.ClusterMember", "asset.DeviceRegistration" ], "x-enum-as-string": true }, "ApiVersion": { "description": "The version of the connector API, describes the capability of the connector's framework.\nIf the version is lower than the current minimum supported version defined in the service managing the connection, the device connector will be connected with limited capabilities until the device connector is upgraded to a fully supported version. For example if a device connector that was released without delta inventory capabilities registers and connects to Intersight, inventory collection may be disabled until it has been upgraded.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "AppPartitionNumber": { "description": "The partition number corresponding to the instance of the Proxy App which is managing the web-socket to the device connector.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "ConnectionId": { "description": "The unique identifier for the current connection. The identifier persists across network connectivity loss and is reset on device connector process restart or platform administrator toggle of the Intersight connectivity. The connectionId can be used by services that need to interact with stateful plugins running in the device connector process. For example if a service schedules an inventory in a devices job scheduler plugin at registration it is not necessary to reschedule the job if the device loses network connectivity due to an Intersight service upgrade or intermittent network issues in the devices datacenter.", "type": "string", "readOnly": true, "x-omitempty": true }, "ConnectionReason": { "description": "If 'connectionStatus' is not equal to Connected, connectionReason provides further details about why the device is not connected with Intersight.", "type": "string", "readOnly": true, "x-omitempty": true }, "ConnectionStatus": { "description": "The status of the persistent connection between the device connector and Intersight.\n* `` - The target details have been persisted but Intersight has not yet attempted to connect to the target.\n* `Connected` - Intersight is able to establish a connection to the target and initiate management activities.\n* `NotConnected` - Intersight is unable to establish a connection to the target.\n* `ClaimInProgress` - Claim of the target is in progress. A connection to the target has not been fully established.\n* `UnclaimInProgress` - Unclaim of the target is in progress. Intersight is able to connect to the target and all management operations are supported.\n* `Unclaimed` - The device was un-claimed from the users account by an Administrator of the device. Also indicates the failure to claim Targets of type HTTP Endpoint in Intersight.\n* `Claimed` - Target of type HTTP Endpoint is successfully claimed in Intersight. Currently no validation is performed to verify the Target connectivity from Intersight at the time of creation. However invoking API from Intersight Orchestrator fails if this Target is not reachable from Intersight or if Target API credentials are incorrect.\n* `PreClaimed` - Target has been pre-claimed and is pending claim completion. Pre-claimed targets are pre-provisioned before endpoint is available to connect to Intersight, once target connects the claim can be completed by providing the security token to the pre-claim API.", "type": "string", "enum": [ "", "Connected", "NotConnected", "ClaimInProgress", "UnclaimInProgress", "Unclaimed", "Claimed", "PreClaimed" ], "default": "", "readOnly": true, "x-omitempty": true }, "ConnectionStatusLastChangeTime": { "description": "The last time at which the 'connectionStatus' property value changed. If connectionStatus is Connected, this time can be interpreted as the starting time since which a persistent connection has been maintained between Intersight and Device Connector. If connectionStatus is NotConnected, this time can be interpreted as the last time the device connector was connected with Intersight.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "ConnectorVersion": { "description": "The version of the device connector running on the managed device.", "type": "string", "readOnly": true, "x-omitempty": true }, "DeviceExternalIpAddress": { "description": "The IP Address of the managed device as seen from Intersight at the time of registration.\nThis could be the IP address of the managed device's interface which has a route to the internet or a NAT IP address when the managed device is deployed in a private network.", "type": "string", "readOnly": true, "x-omitempty": true }, "ProxyApp": { "description": "The name of the app which will proxy the messages to the device connector.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "asset.DeviceConnectorManager.Response": { "description": "The response body of a HTTP GET request for the 'asset.DeviceConnectorManager' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'asset.DeviceConnectorManager' resources.", "x-one-of-name": "asset.DeviceConnectorManager.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/asset.DeviceConnectorManager.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "asset.DeviceConnectorManager": { "title": "Asset:Device Connector Manager", "description": "The DeviceConnectorManager object is a central component in managing registered Intersight Assist Appliance Devices within the Intersight ecosystem. This provides essential information and controls pertaining to device registration and management.\n #### Purpose\nDeviceConnectorManager is responsible for maintaining and overseeing the registration status of Intersight Assist appliances. It helps manage the lifecycle and connectivity of devices, ensuring they are effectively integrated and operational within the system.\n#### Key Concepts\n- **Device Registration:** Manages the registration of Intersight Assist appliances, ensuring they are correctly enrolled and identified within the system.\n- **Lifecycle Management:** Facilitates the management of the device lifecycle, including registration, updates, and potential deregistration.\n- **Relationship Management:** Establishes and maintains relationships with registered devices, supporting cascading updates and ensuring that connected systems are informed of changes.\n- **Access Control:** Utilizes privilege sets to control access and operations, ensuring that only authorized users can perform device management tasks.", "x-allOf-name": "asset.DeviceConnectorManager", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.DeviceConnectorManager', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.DeviceConnectorManager" ], "default": "asset.DeviceConnectorManager", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.DeviceConnectorManager" ], "default": "asset.DeviceConnectorManager", "x-enum-as-string": true }, "RegisteredDevice": { "$ref": "#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "asset.DeviceConnectorManager.List": { "title": "List of 'asset.DeviceConnectorManager' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'asset.DeviceConnectorManager' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'asset.DeviceConnectorManager' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/asset.DeviceConnectorManager" }, "nullable": true } } } ] }, "asset.DeviceContractInformation.Response": { "description": "The response body of a HTTP GET request for the 'asset.DeviceContractInformation' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'asset.DeviceContractInformation' resources.", "x-one-of-name": "asset.DeviceContractInformation.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/asset.DeviceContractInformation.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "asset.DeviceContractInformation.Relationship": { "description": "A relationship to the 'asset.DeviceContractInformation' resource, or the expanded 'asset.DeviceContractInformation' resource, or the 'null' value.", "x-one-of-name": "asset.DeviceContractInformation.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/asset.DeviceContractInformation" } ], "discriminator": { "propertyName": "ClassId" } }, "asset.DeviceContractInformation": { "title": "Asset:Device Contract Information", "description": "The DeviceContractInformation object provides a comprehensive structure for managing contract-related information of Cisco devices identified by unique identifiers. It integrates data from Cisco APIs to ensure valid device status and contract details, supporting efficient device management.\n#### Purpose\nDeviceContractInformation serves as a central repository for viewing contract-related data of Cisco devices, facilitating efficient tracking and validation through Cisco API integration.\n#### Key Concepts\n- **Contract Management:** Provides detailed information on device contracts, supporting efficient tracking.\n- **Integration with Cisco APIs:** Ensures accurate and validated device information through periodic data synchronization.\n- **Access Control:** Enforces secure access through defined privileges, ensuring authorized interactions with contract data.\n- **Detailed Information:** Maintains comprehensive records of contract status, warranty details, and customer information, supporting reliable data management.", "x-allOf-name": "asset.DeviceContractInformation", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.DeviceContractInformation', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.DeviceContractInformation" ], "default": "asset.DeviceContractInformation", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.DeviceContractInformation" ], "default": "asset.DeviceContractInformation", "x-enum-as-string": true }, "Contract": { "description": "Contract information for the Cisco support contract purchased for the Cisco device.", "$ref": "#/components/schemas/asset.ContractInformation", "readOnly": true, "x-omitempty": true }, "ContractStatus": { "description": "Calculated contract status that is derived based on the service line status and contract end date. It is different from serviceLineStatus property. serviceLineStatus gives us ACTIVE, OVERDUE, EXPIRED. These are transformed into Active, Expiring Soon and Not Covered.\n* `Unknown` - The device's contract status cannot be determined.\n* `Not Covered` - The Cisco device does not have a valid support contract.\n* `Active` - The Cisco device is covered under a active support contract.\n* `Expiring Soon` - The contract for this Cisco device is going to expire in the next 30 days.", "type": "string", "enum": [ "Unknown", "Not Covered", "Active", "Expiring Soon" ], "default": "Unknown", "readOnly": true, "x-omitempty": true }, "ContractStatusReason": { "description": "Reason for contract status. In case of Not Covered, reason is either Terminated or Expired.\n* `` - There is no reason for the specified contract status.\n* `Line Item Expired` - The Cisco device does not have a valid support contract, it has expired.\n* `Line Item Terminated` - The Cisco device does not have a valid support contract, it has been terminated.", "type": "string", "enum": [ "", "Line Item Expired", "Line Item Terminated" ], "default": "", "readOnly": true, "x-omitempty": true }, "ContractUnavailableRetryCount": { "description": "If Contract details doesn't exists in CCW API response, we will retry couple of times based on threshold value Retry count will track the number of retry happens due to contract details unavailability.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "ContractUpdatedTime": { "description": "Date and time indicating when the contract data is last fetched from Cisco's Contract API successfully.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "CoveredProductLineEndDate": { "description": "End date of the covered product line. The coverage end date is fetched from Cisco SN2INFO API.", "type": "string", "readOnly": true, "x-omitempty": true }, "DeviceId": { "description": "Unique identifier of the Cisco device. This information is used to query Cisco APIx SN2INFO and CCWR databases.", "type": "string", "readOnly": true, "x-omitempty": true }, "DeviceType": { "description": "Type used to classify the device in Cisco Intersight. Currently supported values are Server and FabricInterconnect. This will be expanded to support more types in future.\n* `None` - A default value to catch cases where device type is not correctly detected.\n* `CiscoUcsServer` - A device of type server. It includes Cisco IMC and UCS Managed servers.\n* `CiscoUcsFI` - A device of type Fabric Interconnect. It includes the various types of Cisco Fabric Interconnects supported by Cisco Intersight.\n* `CiscoUcsChassis` - A device of type Chassis. It includes various UCS chassis supported by Cisco Intersight.\n* `CiscoNexusSwitch` - A device of type Nexus switch. It includes various Nexus switches supported by Cisco Intersight.\n* `CiscoMDSSwitch` - A device of type MDS switch. It includes various MDS switches supported by Cisco Intersight.\n* `CiscoEdgeServer` - A device of type Edge Server. It includes various edge servers supported by Cisco Intersight.\n* `CiscoEdgeChassis` - A device of type Edge Chassis. It includes various edge chassis supported by Cisco Intersight.", "type": "string", "enum": [ "None", "CiscoUcsServer", "CiscoUcsFI", "CiscoUcsChassis", "CiscoNexusSwitch", "CiscoMDSSwitch", "CiscoEdgeServer", "CiscoEdgeChassis" ], "default": "None", "readOnly": true, "x-omitempty": true }, "EndCustomer": { "description": "End customer information for the Cisco support contract purchased for the Cisco device.", "$ref": "#/components/schemas/asset.CustomerInformation", "readOnly": true, "x-omitempty": true }, "EndUserGlobalUltimate": { "description": "EndUserGlobalUltimate information listed in the contract.", "$ref": "#/components/schemas/asset.GlobalUltimate", "readOnly": true, "x-omitempty": true }, "IsValid": { "description": "Validates if the device is a genuine Cisco device. Validated is done using the Cisco SN2INFO APIs.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "ItemType": { "description": "Item type of this specific Cisco device. example \"Chassis\".", "type": "string", "readOnly": true, "x-omitempty": true }, "LastDateOfSupport": { "description": "The last date of hardware support for this device.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "MaintenancePurchaseOrderNumber": { "description": "Maintenance purchase order number for the Cisco device.", "type": "string", "readOnly": true, "x-omitempty": true }, "MaintenanceSalesOrderNumber": { "description": "Maintenance sales order number for the Cisco device.", "type": "string", "readOnly": true, "x-omitempty": true }, "PlatformType": { "description": "The platform type of the Cisco device.\n* `` - An unrecognized platform type.\n* `APIC` - A Cisco Application Policy Infrastructure Controller (APIC) cluster.\n* `CAPIC` - A Cisco Cloud Application Policy Infrastructure Controller (Cloud APIC) instance.\n* `DCNM` - A Cisco Data Center Network Manager (DCNM) instance.\n* `UCSFI` - A Cisco UCS Fabric Interconnect that is managed by Cisco UCS Manager (UCSM).\n* `UCSFIISM` - A Cisco UCS Fabric Interconnect that is managed by Cisco Intersight.\n* `IMC` - A standalone Cisco UCS rack server (Deprecated).\n* `IMCM4` - A standalone Cisco UCS C-Series or S-Series M4 server.\n* `IMCM5` - A standalone Cisco UCS C-Series or S-Series M5 server.\n* `IMCRack` - A standalone Cisco UCS C-Series or S-Series M6 or newer server.\n* `UCSIOM` - A Cisco UCS Blade Chassis I/O Module (IOM).\n* `UCSPCIeNODE` - A Cisco UCS PCIe Node in a blade form factor.\n* `UCSXFM` - A Cisco UCS Fabric Extender Module (XFM).\n* `HX` - A Cisco HyperFlex (HX) cluster.\n* `UCSD` - A Cisco UCS Director (UCSD) instance.\n* `UCSXECMC` - A Cisco UCSXE Chassis Management Controller.\n* `UCSXESecureRouter` - A secure networking router node designed to operate as part of a UCSXE chassis.\n* `IntersightAppliance` - A Cisco Intersight Connected Virtual Appliance instance.\n* `IntersightAssist` - A Cisco Intersight Assist instance.\n* `PureStorageFlashArray` - A Pure Storage FlashArray that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer and storage management features are supported on this device.\n* `PureStorageFlashBladeSystem` - A Pure Storage FlashBlade target that is managed using Cisco Intersight Assist. Storage management feature is supported on this device.\n* `NexusDevice` - A Cisco Nexus Network Switch that is managed using Cisco Intersight Assist.\n* `ACISwitch` - A Cisco Nexus Network Switch with the embedded Device Connector and is a part of the Cisco ACI fabric.\n* `NexusSwitch` - A standalone Cisco Nexus Network Switch with the embedded Device Connector.\n* `MDSSwitch` - A Cisco MDS Switch that is managed using the embedded Device Connector.\n* `MDSDevice` - A Cisco MDS Switch that is managed using Cisco Intersight Assist.\n* `UCSC885` - A standalone Cisco UCS C885 Server.\n* `CAI845A` - A standalone Cisco AI 845A Server.\n* `UCSC890` - A standalone Cisco UCS C890 server managed using Cisco Intersight Assist.\n* `RedfishServer` - A generic target type for servers that support Redfish APIs and is managed using Cisco Intersight Assist. Support is limited to HPE and Dell Servers.\n* `NetAppOntap` - A Netapp ONTAP Storage system that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this device.\n* `NetAppActiveIqUnifiedManager` - A NetApp Active IQ Unified Manager (AIQUM) that is managed using Cisco Intersight Assist.\n* `EmcScaleIo` - An EMC ScaleIO Software Defined Storage system that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this device.\n* `EmcVmax` - An EMC VMAX 2 or 3 series enterprise storage array that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this device.\n* `EmcVplex` - An EMC VPLEX virtual storage system that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this device.\n* `EmcXtremIo` - An EMC XtremIO SSD storage system that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this device.\n* `VmwareVcenter` - A VMware vCenter instance that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer and Virtualization features are supported on this hypervisor.\n* `MicrosoftHyperV` - A Microsoft Hyper-V host that is managed using Cisco Intersight Assist. Optionally, other hosts in the cluster can be discovered through this host. Cisco Intersight Workload Optimizer features are supported on this hypervisor.\n* `AppDynamics` - An AppDynamics controller running in a SaaS or on-prem datacenter. On-prem AppDynamics instance is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this controller.\n* `Dynatrace` - A Dynatrace Server instance running in a SaaS or on-prem datacenter. On-prem Dynatrace instance is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this server.\n* `NewRelic` - A NewRelic user account. The NewRelic instance monitors the application infrastructure. Cisco Intersight Workload Optimizer features are supported on this server.\n* `ServiceNow` - A cloud-based workflow automation platform that enables enterprise organizations to improve operational efficiencies by streamlining and automating routine work tasks.\n* `Umbrella` - Umbrella cloud target that discovers and monitors an organization. It discovers entities like Datacenters, Devices, Tunnels, Networks, etc.\n* `CloudFoundry` - An open source cloud platform on which developers can build, deploy, run and scale applications.\n* `MicrosoftAzureApplicationInsights` - A feature of Azure Monitor, is an extensible Application Performance Management service for developers and DevOps professionals to monitor their live applications.\n* `OpenStack` - An OpenStack target manages Virtual Machines, Physical Machines, Datacenters and Virtual Datacenters using different OpenStack services as administrative endpoints.\n* `MicrosoftSqlServer` - A Microsoft SQL database server that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this database.\n* `MySqlServer` - A MySQL database server that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this database.\n* `OracleDatabaseServer` - An Oracle database server that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this database.\n* `IBMWebSphereApplicationServer` - An IBM WebSphere Application server that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this application server.\n* `OracleWebLogicServer` - Oracle WebLogic Server is a unified and extensible platform for developing, deploying and running enterprise applications, such as Java, for on-premises and in the cloud. WebLogic Server offers a robust, mature, and scalable implementation of Java Enterprise Edition (EE) and Jakarta EE.\n* `ApacheTomcatServer` - An Apache Tomcat server that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this server.\n* `JavaVirtualMachine` - A JVM Application with JMX configured that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this application.\n* `RedHatJBossApplicationServer` - JBoss Application Server is an open-source, cross-platform Java application server developed by JBoss, a division of Red Hat Inc. It is an open-source implementation of Java 2 Enterprise Edition (J2EE) that is used for implementing Java applications and other Web-based applications and software.\n* `Kubernetes` - A Kubernetes cluster that runs containerized applications, with Kubernetes Collector installed. Cisco Intersight Workload Optimizer features are supported on Kubernetes cluster.\n* `AmazonWebService` - An Amazon Web Service cloud account. Cisco Intersight Workload Optimizer and Virtualization features are supported on this cloud.\n* `AmazonWebServiceBilling` - An Amazon Web Service cloud billing account used to retrieve billing information stored in S3 bucket. Cisco Intersight Workload Optimizer features are supported on this cloud.\n* `GoogleCloudPlatform` - A Google Cloud Platform service account with access to one or more projects. Cisco Intersight Workload Optimizer features are supported on this cloud.\n* `GoogleCloudPlatformBilling` - A Google Cloud Platform service account used to retrieve billing information from BigQuery. Cisco Intersight Workload Optimizer features are supported on this cloud.\n* `MicrosoftAzureServicePrincipal` - A Microsoft Azure Service Principal account with access to Azure subscriptions. Cisco Intersight Workload Optimizer features are supported on this cloud.\n* `MicrosoftAzureEnterpriseAgreement` - A Microsoft Azure Enterprise Agreement enrolment used to retrieve pricing and billing information. Cisco Intersight Workload Optimizer features are supported on this cloud.\n* `MicrosoftAzureBilling` - A Microsoft Azure Service Principal account with access to billing information. Cisco Intersight Workload Optimizer features are supported on this cloud.\n* `DellCompellent` - A Dell EMC SC Series (Compellent) storage system that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this device.\n* `HPE3Par` - A HPE 3PAR StoreServ system that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this device.\n* `RedHatEnterpriseVirtualization` - A Red Hat Enterprise Virtualization Hypervisor system that manages Virtual Machines.\n* `NutanixAcropolis` - A Nutanix Acropolis cluster that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this cluster.\n* `NutanixPrismCentral` - A Nutanix Prism Central cluster. Prism central is a virtual appliance for managing Nutanix clusters and services.\n* `HPEOneView` - A HPE OneView system that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this system.\n* `ServiceEngine` - Cisco Application Services Engine. Cisco Application Services Engine is a platform to deploy and manage applications.\n* `HitachiVirtualStoragePlatform` - A Hitachi Virtual Storage Platform (Hitachi VSP) that is managed using Cisco Intersight Assist.\n* `GenericTarget` - A generic third-party target supported only in Partner Integration Appliance. This target type is used for development purposes and will not be supported in production environment.\n* `IMCBlade` - A Cisco UCS blade server managed by Cisco Intersight.\n* `TerraformCloud` - A Terraform Cloud Business Tier account.\n* `TerraformAgent` - A Terraform Cloud Agent that will be deployed on Cisco Intersight Assist. The agent can be used to plan and apply Terraform runs from a Terraform Cloud workspace.\n* `CustomTarget` - CustomTarget is deprecated. Use HTTPEndpoint type to claim HTTP endpoints.\n* `AnsibleEndpoint` - An external endpoint that is added as a target which can be accessed through Ansible in Intersight Cloud Orchestrator automation workflows.\n* `HTTPEndpoint` - An HTTP endpoint that can be accessed in Intersight Orchestrator workflows directly or using Cisco Intersight Assist. Authentication Schemes supported are Basic and Bearer Token.\n* `SSHEndpoint` - An SSH endpoint that can be accessed in Intersight Orchestrator workflows using Cisco Intersight Assist.\n* `CiscoCatalyst` - A Cisco Catalyst networking switch device.\n* `PowerShellEndpoint` - A Windows operating system server on which PowerShell scripts can be executed using Cisco Intersight Assist.\n* `CiscoDNAC` - A Cisco Digital Network Architecture (DNA) Center appliance.\n* `CiscoFMC` - A Cisco Secure Firewall Management Center.\n* `ViptelaCloud` - ViptelaCloud is deprecated. Use CatalystSDWANManager type to claim Catalyst SDWAN Manager which can manage Catalyst SDWAN devices.\n* `CatalystSDWANManager` - A Cisco Catalyst SD-WAN Manager.\n* `MerakiCloud` - A Cisco Meraki Organization.\n* `CiscoISE` - A Cisco Identity Services Engine (ISE) target.", "type": "string", "enum": [ "", "APIC", "CAPIC", "DCNM", "UCSFI", "UCSFIISM", "IMC", "IMCM4", "IMCM5", "IMCRack", "UCSIOM", "UCSPCIeNODE", "UCSXFM", "HX", "UCSD", "UCSXECMC", "UCSXESecureRouter", "IntersightAppliance", "IntersightAssist", "PureStorageFlashArray", "PureStorageFlashBladeSystem", "NexusDevice", "ACISwitch", "NexusSwitch", "MDSSwitch", "MDSDevice", "UCSC885", "CAI845A", "UCSC890", "RedfishServer", "NetAppOntap", "NetAppActiveIqUnifiedManager", "EmcScaleIo", "EmcVmax", "EmcVplex", "EmcXtremIo", "VmwareVcenter", "MicrosoftHyperV", "AppDynamics", "Dynatrace", "NewRelic", "ServiceNow", "Umbrella", "CloudFoundry", "MicrosoftAzureApplicationInsights", "OpenStack", "MicrosoftSqlServer", "MySqlServer", "OracleDatabaseServer", "IBMWebSphereApplicationServer", "OracleWebLogicServer", "ApacheTomcatServer", "JavaVirtualMachine", "RedHatJBossApplicationServer", "Kubernetes", "AmazonWebService", "AmazonWebServiceBilling", "GoogleCloudPlatform", "GoogleCloudPlatformBilling", "MicrosoftAzureServicePrincipal", "MicrosoftAzureEnterpriseAgreement", "MicrosoftAzureBilling", "DellCompellent", "HPE3Par", "RedHatEnterpriseVirtualization", "NutanixAcropolis", "NutanixPrismCentral", "HPEOneView", "ServiceEngine", "HitachiVirtualStoragePlatform", "GenericTarget", "IMCBlade", "TerraformCloud", "TerraformAgent", "CustomTarget", "AnsibleEndpoint", "HTTPEndpoint", "SSHEndpoint", "CiscoCatalyst", "PowerShellEndpoint", "CiscoDNAC", "CiscoFMC", "ViptelaCloud", "CatalystSDWANManager", "MerakiCloud", "CiscoISE" ], "default": "", "readOnly": true, "x-omitempty": true }, "Product": { "description": "Product information of the offering under a contract.", "$ref": "#/components/schemas/asset.ProductInformation", "readOnly": true, "x-omitempty": true }, "PurchaseOrderNumber": { "description": "Purchase order number for the Cisco device. It is a unique number assigned for every purchase.", "type": "string", "readOnly": true, "x-omitempty": true }, "ResellerGlobalUltimate": { "description": "ResellerGlobalUltimate information listed in the contract.", "$ref": "#/components/schemas/asset.GlobalUltimate", "readOnly": true, "x-omitempty": true }, "SalesOrderNumber": { "description": "Sales order number for the Cisco device. It is a unique number assigned for every sale.", "type": "string", "readOnly": true, "x-omitempty": true }, "ServiceDescription": { "description": "The type of service contract that covers the Cisco device.", "type": "string", "readOnly": true, "x-omitempty": true }, "ServiceEndDate": { "description": "End date for the Cisco service contract that covers this Cisco device.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "ServiceLevel": { "description": "The type of service contract that covers the Cisco device.", "type": "string", "readOnly": true, "x-omitempty": true }, "ServiceSku": { "description": "The SKU of the service contract that covers the Cisco device.", "type": "string", "readOnly": true, "x-omitempty": true }, "ServiceStartDate": { "description": "Start date for the Cisco service contract that covers this Cisco device.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "StateContract": { "description": "Internal property used for triggering and tracking actions for contract information.\n* `Update` - Sn2Info/Contract information needs to be updated.\n* `OK` - Sn2Info/Contract information was fetched succcessfuly and updated.\n* `Failed` - Sn2Info/Contract information was not available or failed while fetching.\n* `Retry` - Sn2Info/Contract information update failed and will be retried later.\n* `Inactive` - Device is not in connected state (offline). No action will be taken when the state is Inactive.", "type": "string", "enum": [ "Update", "OK", "Failed", "Retry", "Inactive" ], "default": "Update", "x-omitempty": true }, "WarrantyEndDate": { "description": "End date for the warranty that covers the Cisco device.", "type": "string", "readOnly": true, "x-omitempty": true }, "WarrantyType": { "description": "Type of warranty that covers the Cisco device.", "type": "string", "readOnly": true, "x-omitempty": true }, "RegisteredDevice": { "$ref": "#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Source": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo.Relationship", "description": "A reference to a moBaseMo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "asset.DeviceContractInformation.List": { "title": "List of 'asset.DeviceContractInformation' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'asset.DeviceContractInformation' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'asset.DeviceContractInformation' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/asset.DeviceContractInformation" }, "nullable": true } } } ] }, "asset.DeviceContractNotification": { "title": "Asset:Device Contract Notification", "description": "The DeviceContractNotification object facilitates communication between appliances and cloud systems, supporting contract status computations. It acts as an intermediary for sending and receiving contract status data, ensuring seamless integration and updates.\n#### Purpose\nDeviceContractNotification serves as a communication bridge between appliances and cloud systems, supporting efficient contract status management and updates.\n#### Key Concepts\n- **Communication Management:** Facilitates data exchange between appliances and cloud systems for contract status computations.\n- **Integration:** Supports seamless integration with Cisco systems for accurate and timely contract status updates.\n- **Access Management:** Ensures secure handling of contract data through defined privileges and permissions.\n- **Data Persistence:** Maintains reliable data exchange for contract status management, supporting consistent updates.", "x-allOf-name": "asset.DeviceContractNotification", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.DeviceContractNotification', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.DeviceContractNotification" ], "default": "asset.DeviceContractNotification", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.DeviceContractNotification" ], "default": "asset.DeviceContractNotification", "x-enum-as-string": true }, "Contract": { "description": "Contract information for the Cisco support contract purchased for the Cisco device.", "$ref": "#/components/schemas/asset.ContractInformation", "x-omitempty": true }, "ContractStatus": { "description": "Calculated contract status that is derived based on the service line status and contract end date. It is different from serviceLineStatus property. serviceLineStatus gives us ACTIVE, OVERDUE, EXPIRED. These are transformed into Active, Expiring Soon and Not Covered.\n* `Unknown` - The device's contract status cannot be determined.\n* `Not Covered` - The Cisco device does not have a valid support contract.\n* `Active` - The Cisco device is covered under a active support contract.\n* `Expiring Soon` - The contract for this Cisco device is going to expire in the next 30 days.", "type": "string", "enum": [ "Unknown", "Not Covered", "Active", "Expiring Soon" ], "default": "Unknown", "x-omitempty": true }, "ContractStatusReason": { "description": "Reason for contract status. In case of Not Covered, reason is either Terminated or Expired.\n* `` - There is no reason for the specified contract status.\n* `Line Item Expired` - The Cisco device does not have a valid support contract, it has expired.\n* `Line Item Terminated` - The Cisco device does not have a valid support contract, it has been terminated.", "type": "string", "enum": [ "", "Line Item Expired", "Line Item Terminated" ], "default": "", "x-omitempty": true }, "ContractUpdatedTime": { "description": "Date and time indicating when the contract data is last refreshed.", "type": "string", "format": "date-time", "x-omitempty": true }, "CoveredProductLineEndDate": { "description": "End date of the covered product line. The coverage end date is fetched from Cisco SN2INFO API.", "type": "string", "x-omitempty": true }, "DeviceId": { "description": "Unique identifier of the Cisco device.", "type": "string", "x-omitempty": true }, "EndCustomer": { "description": "End customer information for the Cisco support contract purchased for the Cisco device.", "$ref": "#/components/schemas/asset.CustomerInformation", "x-omitempty": true }, "EndUserGlobalUltimate": { "description": "EndUserGlobalUltimate information listed in the contract.", "$ref": "#/components/schemas/asset.GlobalUltimate", "x-omitempty": true }, "IsValid": { "description": "Validates if the device is a genuine Cisco device. Validated is done using the Cisco SN2INFO APIs.", "type": "boolean", "x-omitempty": true }, "ItemType": { "description": "Item type of this specific Cisco device. example \"Chassis\".", "type": "string", "x-omitempty": true }, "LastDateOfSupport": { "description": "The last date of hardware support for this device.", "type": "string", "format": "date-time", "x-omitempty": true }, "MaintenancePurchaseOrderNumber": { "description": "Maintenance purchase order number for the Cisco device.", "type": "string", "x-omitempty": true }, "MaintenanceSalesOrderNumber": { "description": "Maintenance sales order number for the Cisco device.", "type": "string", "x-omitempty": true }, "Product": { "description": "Product information of the offering under a contract.", "$ref": "#/components/schemas/asset.ProductInformation", "x-omitempty": true }, "PurchaseOrderNumber": { "description": "Purchase order number for the Cisco device. It is a unique number assigned for every purchase.", "type": "string", "x-omitempty": true }, "ResellerGlobalUltimate": { "description": "ResellerGlobalUltimate information listed in the contract.", "$ref": "#/components/schemas/asset.GlobalUltimate", "x-omitempty": true }, "SalesOrderNumber": { "description": "Sales order number for the Cisco device. It is a unique number assigned for every sale.", "type": "string", "x-omitempty": true }, "ServiceDescription": { "description": "The type of service contract that covers the Cisco device.", "type": "string", "x-omitempty": true }, "ServiceEndDate": { "description": "End date for the Cisco service contract that covers this Cisco device.", "type": "string", "format": "date-time", "x-omitempty": true }, "ServiceLevel": { "description": "The type of service contract that covers the Cisco device.", "type": "string", "x-omitempty": true }, "ServiceSku": { "description": "The SKU of the service contract that covers the Cisco device.", "type": "string", "x-omitempty": true }, "ServiceStartDate": { "description": "Start date for the Cisco service contract that covers this Cisco device.", "type": "string", "format": "date-time", "x-omitempty": true }, "StateContract": { "description": "Internal property used for triggering and tracking actions for contract information.\n* `Update` - Sn2Info/Contract information needs to be updated.\n* `OK` - Sn2Info/Contract information was fetched succcessfuly and updated.\n* `Failed` - Sn2Info/Contract information was not available or failed while fetching.\n* `Retry` - Sn2Info/Contract information update failed and will be retried later.\n* `Inactive` - Device is not in connected state (offline). No action will be taken when the state is Inactive.", "type": "string", "enum": [ "Update", "OK", "Failed", "Retry", "Inactive" ], "default": "Update", "x-omitempty": true }, "StateSn2Info": { "description": "Internal property used for triggering and tracking actions for sn2info information.\n* `Update` - Sn2Info/Contract information needs to be updated.\n* `OK` - Sn2Info/Contract information was fetched succcessfuly and updated.\n* `Failed` - Sn2Info/Contract information was not available or failed while fetching.\n* `Retry` - Sn2Info/Contract information update failed and will be retried later.\n* `Inactive` - Device is not in connected state (offline). No action will be taken when the state is Inactive.", "type": "string", "enum": [ "Update", "OK", "Failed", "Retry", "Inactive" ], "default": "Update", "x-omitempty": true }, "WarrantyEndDate": { "description": "End date for the warranty that covers the Cisco device.", "type": "string", "x-omitempty": true }, "WarrantyType": { "description": "Type of warranty that covers the Cisco device.", "type": "string", "x-omitempty": true }, "RegisteredDevice": { "$ref": "#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "asset.DeviceEndpointLocalCredential": { "title": "Asset:Device Endpoint Local Credential", "description": "Used against a device endpoint that manages its own local credential.", "x-allOf-name": "asset.DeviceEndpointLocalCredential", "allOf": [ { "$ref": "#/components/schemas/asset.Credential" } ] }, "asset.DeviceInformation": { "title": "Asset:Device Information", "description": "Type for saving the device information reported by Cisco Install Base. It is used in asset.SubscriptionDeviceInformation object to save the device information.", "x-allOf-name": "asset.DeviceInformation", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.DeviceInformation', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.DeviceInformation" ], "default": "asset.DeviceInformation", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.DeviceInformation" ], "default": "asset.DeviceInformation", "x-enum-as-string": true }, "ApplicationName": { "description": "Application name reported by Cisco Install Base.", "type": "string", "readOnly": true, "x-omitempty": true }, "DeviceTransactions": { "type": "array", "items": { "description": "All the device transactions reported by Cisco Install Base.", "$ref": "#/components/schemas/asset.DeviceTransaction", "readOnly": true, "x-omitempty": true }, "nullable": true }, "EndCustomer": { "description": "End customer information for the Cisco support contract purchased for the Cisco device.", "$ref": "#/components/schemas/asset.CustomerInformation", "readOnly": true, "x-omitempty": true }, "InstanceId": { "description": "Instance number of the device. example \"917280220\".", "type": "string", "readOnly": true, "x-omitempty": true }, "ItemType": { "description": "Item type flag. example ATO, Child, Standalone. ATO - refers to Cisco Block based major device. Child - refers to Child device part of an ATO block. Standalone - refers to a device that is managed and configured as an individual entity with limited capacity.", "type": "string", "readOnly": true, "x-omitempty": true }, "MlbOfferType": { "description": "Identifier for consumption based pricing. MLB refers to MultiLine Bundle.", "type": "string", "readOnly": true, "x-omitempty": true }, "MlbProductId": { "description": "Identifier corresponding to MLB Product Name. MLB refers to MultiLine Bundle.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "MlbProductName": { "description": "Product Name for the device. It is used to determine if the server is to be billed as a UCS compute device or a storage cluster. MLB refers to MultiLine Bundle.", "type": "string", "readOnly": true, "x-omitempty": true }, "OldDeviceId": { "description": "Unique identifier of old Cisco device. It is the device ID of old Cisco device, which got replaced by the new device.", "type": "string", "readOnly": true, "x-omitempty": true }, "OldDeviceStatusDescription": { "description": "Description of status of old Cisco device, which got replaced by the new device.", "type": "string", "readOnly": true, "x-omitempty": true }, "OldDeviceStatusId": { "description": "Status ID of old Cisco device, which got replaced by the new device.\n* `0` - A default value to catch cases where device status is not correctly detected.\n* `10000` - Device is installed successfully.\n* `1010041` - Device is currently in Return Material Authorization process.\n* `10005` - Device is replaced successfully with another device.\n* `10007` - Device is returned succcessfuly.\n* `10009` - Device is terminated at customer's end.", "type": "integer", "enum": [ 0, 10000, 1010041, 10005, 10007, 10009 ], "default": 0, "readOnly": true, "x-omitempty": true }, "OldInstanceId": { "description": "Instance number of the old device, which got replaced by the new device.", "type": "string", "readOnly": true, "x-omitempty": true }, "ProductFamily": { "description": "Product Family is the field used to identify the hypervisor type. example \"ESXi\".", "type": "string", "readOnly": true, "x-omitempty": true }, "ProductType": { "description": "Product type helps to determine if device has to be billed using consumption metering. example \"SERVER\".", "type": "string", "readOnly": true, "x-omitempty": true }, "UnitOfMeasure": { "description": "Unit of Measure is flag used to identify the type of metric being pushed. example - \"STORAGE\" for hardware metrics , \"VM\" - for hypervisor metrics.\n* `None` - A default value to catch cases where unit of measure is not correctly detected.\n* `STORAGE` - The metric type of the device is a storage metric.\n* `NODE` - The metric type of the device is a hardware metric.\n* `VM` - The metric type of the device is a hypervisor metric.", "type": "string", "enum": [ "None", "STORAGE", "NODE", "VM" ], "default": "None", "readOnly": true, "x-omitempty": true } } } ] }, "asset.DeviceRegistration.Response": { "description": "The response body of a HTTP GET request for the 'asset.DeviceRegistration' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'asset.DeviceRegistration' resources.", "x-one-of-name": "asset.DeviceRegistration.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/asset.DeviceRegistration.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "asset.DeviceRegistration.Relationship": { "description": "A relationship to the 'asset.DeviceRegistration' resource, or the expanded 'asset.DeviceRegistration' resource, or the 'null' value.", "x-one-of-name": "asset.DeviceRegistration.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/asset.DeviceRegistration" } ], "discriminator": { "propertyName": "ClassId" } }, "asset.DeviceRegistration": { "title": "Asset:Device Registration", "description": "The DeviceRegistration object represents a device connector-enabled endpoint that has registered with Intersight. It is a concrete object central to the management of devices, allowing them to be claimed, configured, and monitored within Intersight's infrastructure.\n#### Purpose\nThe DeviceRegistration serves as the primary interface for representing devices within Intersight. It facilitates device management, enabling users to perform operations like claiming, updating, or deleting device-related data. It is essential for capturing the status and configuration of devices interacting with Intersight services.\n#### Key Concepts\n- **Claiming and Ownership:** Supports claiming devices into a user's account, establishing ownership and enabling management operations.\n- **Connectivity Status:** Provides insights into the device's connection status with Intersight, including persistent connection details.\n- **Device Identity:** Maintains device-specific information, such as serial numbers and product IDs, crucial for device validation and tracking.\n- **Security and Access:** Ensures secure management through authentication keys and tokens, facilitating safe device operation and interaction with Intersight.", "x-allOf-name": "asset.DeviceRegistration", "allOf": [ { "$ref": "#/components/schemas/asset.DeviceConnection" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.DeviceRegistration', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.DeviceRegistration" ], "default": "asset.DeviceRegistration", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.DeviceRegistration" ], "default": "asset.DeviceRegistration", "x-enum-as-string": true }, "AccessKeyId": { "description": "An identifier for the credential used by the device connector to authenticate with the Intersight web socket gateway.", "type": "string", "x-omitempty": true }, "ClaimedByUserName": { "description": "The name of the user who claimed the device for the account.", "type": "string", "readOnly": true, "x-omitempty": true }, "ClaimedTime": { "description": "The date and time at which the device was claimed to this account.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "DeviceHostname": { "type": "array", "items": { "description": "The hostnames of the managed device. There can be multiple hostnames depending on the number of elements managed (i.e. HA clusters).", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "DeviceIpAddress": { "type": "array", "items": { "description": "The IP Addresses of the managed device. There can be multiple management IPs depending on the number of elements managed (i.e. HA clusters) and in-band/out-of-band connectivity.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "ExecutionMode": { "description": "Indicates if the platform is an actual device or an emulated device for testing, demos, etc. Permitted values are [Normal, Emulator, ContainerEmulator].\n* `` - The device reported an empty or unrecognized executionMode.\n* `Normal` - The device connector is running in normal mode, i.e. it is not a simulation.\n* `Emulator` - The device connector is running in simulation mode inside an emulated device.\n* `ContainerEmulator` - The device connector is running in simulation mode inside a containerized emulated device.", "type": "string", "enum": [ "", "Normal", "Emulator", "ContainerEmulator" ], "default": "", "x-createOnly": true, "x-omitempty": true }, "ParentSignature": { "description": "A signature generated by a parent device or target used to auto-claim a device into a user account at time of registration.", "$ref": "#/components/schemas/asset.ClaimSignature", "x-createOnly": true, "x-omitempty": true }, "Pid": { "type": "array", "items": { "description": "The product Id of the managed device.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "PlatformType": { "description": "The platform type on which device connector is executing.\n* `` - An unrecognized platform type.\n* `APIC` - A Cisco Application Policy Infrastructure Controller (APIC) cluster.\n* `CAPIC` - A Cisco Cloud Application Policy Infrastructure Controller (Cloud APIC) instance.\n* `DCNM` - A Cisco Data Center Network Manager (DCNM) instance.\n* `UCSFI` - A Cisco UCS Fabric Interconnect that is managed by Cisco UCS Manager (UCSM).\n* `UCSFIISM` - A Cisco UCS Fabric Interconnect that is managed by Cisco Intersight.\n* `IMC` - A standalone Cisco UCS rack server (Deprecated).\n* `IMCM4` - A standalone Cisco UCS C-Series or S-Series M4 server.\n* `IMCM5` - A standalone Cisco UCS C-Series or S-Series M5 server.\n* `IMCRack` - A standalone Cisco UCS C-Series or S-Series M6 or newer server.\n* `UCSIOM` - A Cisco UCS Blade Chassis I/O Module (IOM).\n* `UCSPCIeNODE` - A Cisco UCS PCIe Node in a blade form factor.\n* `UCSXFM` - A Cisco UCS Fabric Extender Module (XFM).\n* `HX` - A Cisco HyperFlex (HX) cluster.\n* `UCSD` - A Cisco UCS Director (UCSD) instance.\n* `UCSXECMC` - A Cisco UCSXE Chassis Management Controller.\n* `UCSXESecureRouter` - A secure networking router node designed to operate as part of a UCSXE chassis.\n* `IntersightAppliance` - A Cisco Intersight Connected Virtual Appliance instance.\n* `IntersightAssist` - A Cisco Intersight Assist instance.\n* `PureStorageFlashArray` - A Pure Storage FlashArray that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer and storage management features are supported on this device.\n* `PureStorageFlashBladeSystem` - A Pure Storage FlashBlade target that is managed using Cisco Intersight Assist. Storage management feature is supported on this device.\n* `NexusDevice` - A Cisco Nexus Network Switch that is managed using Cisco Intersight Assist.\n* `ACISwitch` - A Cisco Nexus Network Switch with the embedded Device Connector and is a part of the Cisco ACI fabric.\n* `NexusSwitch` - A standalone Cisco Nexus Network Switch with the embedded Device Connector.\n* `MDSSwitch` - A Cisco MDS Switch that is managed using the embedded Device Connector.\n* `MDSDevice` - A Cisco MDS Switch that is managed using Cisco Intersight Assist.\n* `UCSC885` - A standalone Cisco UCS C885 Server.\n* `CAI845A` - A standalone Cisco AI 845A Server.\n* `UCSC890` - A standalone Cisco UCS C890 server managed using Cisco Intersight Assist.\n* `RedfishServer` - A generic target type for servers that support Redfish APIs and is managed using Cisco Intersight Assist. Support is limited to HPE and Dell Servers.\n* `NetAppOntap` - A Netapp ONTAP Storage system that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this device.\n* `NetAppActiveIqUnifiedManager` - A NetApp Active IQ Unified Manager (AIQUM) that is managed using Cisco Intersight Assist.\n* `EmcScaleIo` - An EMC ScaleIO Software Defined Storage system that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this device.\n* `EmcVmax` - An EMC VMAX 2 or 3 series enterprise storage array that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this device.\n* `EmcVplex` - An EMC VPLEX virtual storage system that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this device.\n* `EmcXtremIo` - An EMC XtremIO SSD storage system that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this device.\n* `VmwareVcenter` - A VMware vCenter instance that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer and Virtualization features are supported on this hypervisor.\n* `MicrosoftHyperV` - A Microsoft Hyper-V host that is managed using Cisco Intersight Assist. Optionally, other hosts in the cluster can be discovered through this host. Cisco Intersight Workload Optimizer features are supported on this hypervisor.\n* `AppDynamics` - An AppDynamics controller running in a SaaS or on-prem datacenter. On-prem AppDynamics instance is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this controller.\n* `Dynatrace` - A Dynatrace Server instance running in a SaaS or on-prem datacenter. On-prem Dynatrace instance is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this server.\n* `NewRelic` - A NewRelic user account. The NewRelic instance monitors the application infrastructure. Cisco Intersight Workload Optimizer features are supported on this server.\n* `ServiceNow` - A cloud-based workflow automation platform that enables enterprise organizations to improve operational efficiencies by streamlining and automating routine work tasks.\n* `Umbrella` - Umbrella cloud target that discovers and monitors an organization. It discovers entities like Datacenters, Devices, Tunnels, Networks, etc.\n* `CloudFoundry` - An open source cloud platform on which developers can build, deploy, run and scale applications.\n* `MicrosoftAzureApplicationInsights` - A feature of Azure Monitor, is an extensible Application Performance Management service for developers and DevOps professionals to monitor their live applications.\n* `OpenStack` - An OpenStack target manages Virtual Machines, Physical Machines, Datacenters and Virtual Datacenters using different OpenStack services as administrative endpoints.\n* `MicrosoftSqlServer` - A Microsoft SQL database server that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this database.\n* `MySqlServer` - A MySQL database server that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this database.\n* `OracleDatabaseServer` - An Oracle database server that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this database.\n* `IBMWebSphereApplicationServer` - An IBM WebSphere Application server that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this application server.\n* `OracleWebLogicServer` - Oracle WebLogic Server is a unified and extensible platform for developing, deploying and running enterprise applications, such as Java, for on-premises and in the cloud. WebLogic Server offers a robust, mature, and scalable implementation of Java Enterprise Edition (EE) and Jakarta EE.\n* `ApacheTomcatServer` - An Apache Tomcat server that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this server.\n* `JavaVirtualMachine` - A JVM Application with JMX configured that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this application.\n* `RedHatJBossApplicationServer` - JBoss Application Server is an open-source, cross-platform Java application server developed by JBoss, a division of Red Hat Inc. It is an open-source implementation of Java 2 Enterprise Edition (J2EE) that is used for implementing Java applications and other Web-based applications and software.\n* `Kubernetes` - A Kubernetes cluster that runs containerized applications, with Kubernetes Collector installed. Cisco Intersight Workload Optimizer features are supported on Kubernetes cluster.\n* `AmazonWebService` - An Amazon Web Service cloud account. Cisco Intersight Workload Optimizer and Virtualization features are supported on this cloud.\n* `AmazonWebServiceBilling` - An Amazon Web Service cloud billing account used to retrieve billing information stored in S3 bucket. Cisco Intersight Workload Optimizer features are supported on this cloud.\n* `GoogleCloudPlatform` - A Google Cloud Platform service account with access to one or more projects. Cisco Intersight Workload Optimizer features are supported on this cloud.\n* `GoogleCloudPlatformBilling` - A Google Cloud Platform service account used to retrieve billing information from BigQuery. Cisco Intersight Workload Optimizer features are supported on this cloud.\n* `MicrosoftAzureServicePrincipal` - A Microsoft Azure Service Principal account with access to Azure subscriptions. Cisco Intersight Workload Optimizer features are supported on this cloud.\n* `MicrosoftAzureEnterpriseAgreement` - A Microsoft Azure Enterprise Agreement enrolment used to retrieve pricing and billing information. Cisco Intersight Workload Optimizer features are supported on this cloud.\n* `MicrosoftAzureBilling` - A Microsoft Azure Service Principal account with access to billing information. Cisco Intersight Workload Optimizer features are supported on this cloud.\n* `DellCompellent` - A Dell EMC SC Series (Compellent) storage system that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this device.\n* `HPE3Par` - A HPE 3PAR StoreServ system that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this device.\n* `RedHatEnterpriseVirtualization` - A Red Hat Enterprise Virtualization Hypervisor system that manages Virtual Machines.\n* `NutanixAcropolis` - A Nutanix Acropolis cluster that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this cluster.\n* `NutanixPrismCentral` - A Nutanix Prism Central cluster. Prism central is a virtual appliance for managing Nutanix clusters and services.\n* `HPEOneView` - A HPE OneView system that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this system.\n* `ServiceEngine` - Cisco Application Services Engine. Cisco Application Services Engine is a platform to deploy and manage applications.\n* `HitachiVirtualStoragePlatform` - A Hitachi Virtual Storage Platform (Hitachi VSP) that is managed using Cisco Intersight Assist.\n* `GenericTarget` - A generic third-party target supported only in Partner Integration Appliance. This target type is used for development purposes and will not be supported in production environment.\n* `IMCBlade` - A Cisco UCS blade server managed by Cisco Intersight.\n* `TerraformCloud` - A Terraform Cloud Business Tier account.\n* `TerraformAgent` - A Terraform Cloud Agent that will be deployed on Cisco Intersight Assist. The agent can be used to plan and apply Terraform runs from a Terraform Cloud workspace.\n* `CustomTarget` - CustomTarget is deprecated. Use HTTPEndpoint type to claim HTTP endpoints.\n* `AnsibleEndpoint` - An external endpoint that is added as a target which can be accessed through Ansible in Intersight Cloud Orchestrator automation workflows.\n* `HTTPEndpoint` - An HTTP endpoint that can be accessed in Intersight Orchestrator workflows directly or using Cisco Intersight Assist. Authentication Schemes supported are Basic and Bearer Token.\n* `SSHEndpoint` - An SSH endpoint that can be accessed in Intersight Orchestrator workflows using Cisco Intersight Assist.\n* `CiscoCatalyst` - A Cisco Catalyst networking switch device.\n* `PowerShellEndpoint` - A Windows operating system server on which PowerShell scripts can be executed using Cisco Intersight Assist.\n* `CiscoDNAC` - A Cisco Digital Network Architecture (DNA) Center appliance.\n* `CiscoFMC` - A Cisco Secure Firewall Management Center.\n* `ViptelaCloud` - ViptelaCloud is deprecated. Use CatalystSDWANManager type to claim Catalyst SDWAN Manager which can manage Catalyst SDWAN devices.\n* `CatalystSDWANManager` - A Cisco Catalyst SD-WAN Manager.\n* `MerakiCloud` - A Cisco Meraki Organization.\n* `CiscoISE` - A Cisco Identity Services Engine (ISE) target.", "type": "string", "enum": [ "", "APIC", "CAPIC", "DCNM", "UCSFI", "UCSFIISM", "IMC", "IMCM4", "IMCM5", "IMCRack", "UCSIOM", "UCSPCIeNODE", "UCSXFM", "HX", "UCSD", "UCSXECMC", "UCSXESecureRouter", "IntersightAppliance", "IntersightAssist", "PureStorageFlashArray", "PureStorageFlashBladeSystem", "NexusDevice", "ACISwitch", "NexusSwitch", "MDSSwitch", "MDSDevice", "UCSC885", "CAI845A", "UCSC890", "RedfishServer", "NetAppOntap", "NetAppActiveIqUnifiedManager", "EmcScaleIo", "EmcVmax", "EmcVplex", "EmcXtremIo", "VmwareVcenter", "MicrosoftHyperV", "AppDynamics", "Dynatrace", "NewRelic", "ServiceNow", "Umbrella", "CloudFoundry", "MicrosoftAzureApplicationInsights", "OpenStack", "MicrosoftSqlServer", "MySqlServer", "OracleDatabaseServer", "IBMWebSphereApplicationServer", "OracleWebLogicServer", "ApacheTomcatServer", "JavaVirtualMachine", "RedHatJBossApplicationServer", "Kubernetes", "AmazonWebService", "AmazonWebServiceBilling", "GoogleCloudPlatform", "GoogleCloudPlatformBilling", "MicrosoftAzureServicePrincipal", "MicrosoftAzureEnterpriseAgreement", "MicrosoftAzureBilling", "DellCompellent", "HPE3Par", "RedHatEnterpriseVirtualization", "NutanixAcropolis", "NutanixPrismCentral", "HPEOneView", "ServiceEngine", "HitachiVirtualStoragePlatform", "GenericTarget", "IMCBlade", "TerraformCloud", "TerraformAgent", "CustomTarget", "AnsibleEndpoint", "HTTPEndpoint", "SSHEndpoint", "CiscoCatalyst", "PowerShellEndpoint", "CiscoDNAC", "CiscoFMC", "ViptelaCloud", "CatalystSDWANManager", "MerakiCloud", "CiscoISE" ], "default": "", "x-createOnly": true, "x-omitempty": true }, "PublicAccessKey": { "description": "The device connector's public key used by Intersight to authenticate a connection from the device connector. The public key is used to verify that the signature a device connector sends on connect has been signed by the connector's private key stored on the device's filesystem. Must be a PEM encoded RSA or Ed22519 public key string.", "type": "string", "readOnly": true, "x-omitempty": true }, "PublicAccessKeyRotated": { "description": "The device connectors rotated public key. The device connector may rotate its key pair in conditions where it has been determined the key may have been compromised or if the key type is changing (e.g. moving from RSA to elliptical curve). The device connector will rotate its key in a two step process in order to ensure Intersight has received and committed the new key before invalidating the previous. Device connectors will first send the new public key on PublicAccessKeyRotated, the public key string will also be signed by the current private key. On receipt of a 200 response from Intersight the device connector commits the new key to its local database and will use it for all future authentication requests. Intersight will then allow both the previous and rotated key periods until the device connects with the rotated key, at which point the previous key is invalidated and removed.", "type": "string", "readOnly": true, "x-omitempty": true }, "PublicEncryptionKey": { "description": "The device connector public key used by Intersight for encryption. The public key is used to encrypt ephemeral aes keys to be used for decrypting sensitive data from Intersight. Must be a PEM encoded RSA public key string.", "type": "string", "readOnly": true, "x-omitempty": true }, "ReadOnly": { "description": "Flag reported by devices to indicate an administrator of the device has disabled management operations of the device connector and only monitoring is permitted.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "RotateAccessKey": { "description": "Request the device to rotate its key pair. SRE team may set this field to trigger the device to rotate its key pair in conditions where it has been identified that the device's key has been compromised. When RotateAccessKey is set to true the device will be forced to re-connect and rotate its key.", "type": "boolean", "x-omitempty": true }, "Serial": { "type": "array", "items": { "description": "A list of serial numbers of the individual device elements (e.g. HA primary/secondary or cluster members) which are exposed as a single unit of management by the device connector.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Vendor": { "description": "The vendor of the managed device.", "type": "string", "readOnly": true, "x-omitempty": true }, "Account": { "$ref": "#/components/schemas/iam.Account.Relationship", "description": "A reference to a iamAccount resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "ClaimedByUser": { "$ref": "#/components/schemas/iam.User.Relationship", "description": "A reference to a iamUser resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "ClusterMembers": { "description": "An array of relationships to assetClusterMember resources.", "type": "array", "items": { "$ref": "#/components/schemas/asset.ClusterMember.Relationship" }, "nullable": true, "readOnly": true }, "CustomPermissionResources": { "description": "An array of relationships to moBaseMo resources.", "type": "array", "items": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo.Relationship" }, "nullable": true, "readOnly": true }, "DeviceClaim": { "$ref": "#/components/schemas/asset.DeviceClaim.Relationship", "description": "A reference to a assetDeviceClaim resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "DeviceConfiguration": { "$ref": "#/components/schemas/asset.DeviceConfiguration.Relationship", "description": "A reference to a assetDeviceConfiguration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "DomainGroup": { "$ref": "#/components/schemas/iam.DomainGroup.Relationship", "description": "A reference to a iamDomainGroup resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "ParentConnection": { "$ref": "#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Target": { "$ref": "#/components/schemas/asset.Target.Relationship", "description": "A reference to a assetTarget resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "asset.DeviceRegistration.List": { "title": "List of 'asset.DeviceRegistration' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'asset.DeviceRegistration' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'asset.DeviceRegistration' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/asset.DeviceRegistration" }, "nullable": true } } } ] }, "asset.DeviceStatistics": { "title": "Asset:Device Statistics", "description": "Type for saving device statistics related information for HyperFlex and UCS devices. It is used in asset.DeploymentDevice object to save the current device statistics.", "x-allOf-name": "asset.DeviceStatistics", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.DeviceStatistics', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.DeviceStatistics" ], "default": "asset.DeviceStatistics", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.DeviceStatistics" ], "default": "asset.DeviceStatistics", "x-enum-as-string": true }, "ClusterDeploymentType": { "description": "Deployment type of HyperFlex cluster.", "type": "string", "readOnly": true, "x-omitempty": true }, "ClusterDeviceMoid": { "description": "Reference to HyperFlex cluster target device ID.", "type": "string", "readOnly": true, "x-omitempty": true }, "ClusterName": { "description": "Name of the cluster. It is specified only for HyperFlex based devices.", "type": "string", "readOnly": true, "x-omitempty": true }, "ClusterReplicationFactor": { "description": "Data replication factor of HyperFlex cluster.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Connected": { "description": "The status of the persistent connection between the device connector and Intersight, for HyperFlex or UCS device. 1 represents being connected and 0 represents being disconnected.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "MembershipRatio": { "description": "Defines the average proportion of resources used by the device within the cluster. example in a cluster having 3 nodes, the membershipRatio of each node is 1/3 or 0.33. It is specified only for HyperFlex based devices.", "type": "number", "format": "float", "readOnly": true, "x-omitempty": true }, "MemoryMirroringFactor": { "description": "Memory Reliability, availability and serviceability (RAS) factor.", "type": "number", "format": "float", "readOnly": true, "x-omitempty": true }, "VmHost": { "description": "VM host which is associated with the serial. It is updated only for devices which has vm installation.", "$ref": "#/components/schemas/asset.VmHost", "readOnly": true, "x-omitempty": true } } } ] }, "asset.DeviceTransaction": { "title": "Asset:Device Transaction", "description": "Type for saving the device transaction history. It is used in asset.DeploymentDeviceInformation object to save the device transactions.", "x-allOf-name": "asset.DeviceTransaction", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.DeviceTransaction', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.DeviceTransaction" ], "default": "asset.DeviceTransaction", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.DeviceTransaction" ], "default": "asset.DeviceTransaction", "x-enum-as-string": true }, "Action": { "description": "The action taken by Cisco Install Base on the device.", "type": "string", "readOnly": true, "x-omitempty": true }, "StatusDescription": { "description": "Description of status of Cisco device reported by Cisco Install Base.", "type": "string", "readOnly": true, "x-omitempty": true }, "StatusId": { "description": "Status ID of device reported by Cisco Install Base.\n* `0` - A default value to catch cases where device status is not correctly detected.\n* `10000` - Device is installed successfully.\n* `1010041` - Device is currently in Return Material Authorization process.\n* `10005` - Device is replaced successfully with another device.\n* `10007` - Device is returned succcessfuly.\n* `10009` - Device is terminated at customer's end.", "type": "integer", "enum": [ 0, 10000, 1010041, 10005, 10007, 10009 ], "default": 0, "readOnly": true, "x-omitempty": true }, "Timestamp": { "description": "Timestamp field reported by Cisco Install Base.", "type": "string", "readOnly": true, "x-omitempty": true }, "TransactionBatchId": { "description": "Transaction batch ID reported by Cisco Install Base.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "TransactionDate": { "description": "Transaction Date reported by Cisco Install Base.", "type": "string", "readOnly": true, "x-omitempty": true }, "TransactionSequence": { "description": "Transaction sequence reported by Cisco Install Base.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true } } } ] }, "asset.GenericTargetClaimOptions": { "title": "Asset:Generic Target Claim Options", "description": "Captures the generic set of options required to claim a generic target managed via assist. Should be used only by partners who are developing their integration using the Partner Integration appliance.", "x-allOf-name": "asset.GenericTargetClaimOptions", "allOf": [ { "$ref": "#/components/schemas/asset.ServiceOptions" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.GenericTargetClaimOptions', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.GenericTargetClaimOptions" ], "default": "asset.GenericTargetClaimOptions", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.GenericTargetClaimOptions" ], "default": "asset.GenericTargetClaimOptions", "x-enum-as-string": true }, "TargetOptions": { "description": "The generic device connector will consume these options.", "nullable": true, "x-omitempty": true } } } ] }, "asset.GeoLocation.Response": { "description": "The response body of a HTTP GET request for the 'asset.GeoLocation' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'asset.GeoLocation' resources.", "x-one-of-name": "asset.GeoLocation.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/asset.GeoLocation.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "asset.GeoLocation.Relationship": { "description": "A relationship to the 'asset.GeoLocation' resource, or the expanded 'asset.GeoLocation' resource, or the 'null' value.", "x-one-of-name": "asset.GeoLocation.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/asset.GeoLocation" } ], "discriminator": { "propertyName": "ClassId" } }, "asset.GeoLocation": { "title": "Asset:Geo Location", "description": "The geographic location of a managed target.", "x-allOf-name": "asset.GeoLocation", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.GeoLocation', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.GeoLocation" ], "default": "asset.GeoLocation", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.GeoLocation" ], "default": "asset.GeoLocation", "x-enum-as-string": true }, "Address": { "description": "The location's street address.", "$ref": "intersight-hyperflex-v3-1.0.11-20260807064027971.json#/components/schemas/comm.PhysicalAddress", "x-omitempty": true }, "Coordinates": { "description": "The location's longitude and latitude coordinates.", "$ref": "intersight-hyperflex-v3-1.0.11-20260807064027971.json#/components/schemas/comm.GeoPoint", "x-omitempty": true }, "Name": { "description": "A user provided name for the location.", "type": "string", "x-omitempty": true }, "Account": { "$ref": "#/components/schemas/iam.Account.Relationship", "description": "A reference to a iamAccount resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "asset.GeoLocation.List": { "title": "List of 'asset.GeoLocation' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'asset.GeoLocation' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'asset.GeoLocation' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/asset.GeoLocation" }, "nullable": true } } } ] }, "asset.GlobalUltimate": { "title": "Asset:Global Ultimate", "description": "Type for customer information of the BillToGlobal.", "x-allOf-name": "asset.GlobalUltimate", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.GlobalUltimate', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.GlobalUltimate" ], "default": "asset.GlobalUltimate", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.GlobalUltimate" ], "default": "asset.GlobalUltimate", "x-enum-as-string": true }, "Id": { "description": "ID of the user in BillToGlobal.", "type": "string", "readOnly": true, "x-omitempty": true }, "Name": { "description": "Name of the user in BillToGlobal.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "asset.GoogleCloudPlatformServiceAccountKeyCredential": { "title": "Asset:Google Cloud Platform Service Account Key Credential", "description": "Google APIs use the OAuth 2.0 protocol for authentication and authorization. Google Cloud Platform (GCP) service account's key JSON file to get an access token to call Google APIs. Documentation : [link](https://cloud.google.com/iam/docs/creating-managing-service-account-keys).", "x-allOf-name": "asset.GoogleCloudPlatformServiceAccountKeyCredential", "allOf": [ { "$ref": "#/components/schemas/asset.Credential" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.GoogleCloudPlatformServiceAccountKeyCredential', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.GoogleCloudPlatformServiceAccountKeyCredential" ], "default": "asset.GoogleCloudPlatformServiceAccountKeyCredential", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.GoogleCloudPlatformServiceAccountKeyCredential" ], "default": "asset.GoogleCloudPlatformServiceAccountKeyCredential", "x-enum-as-string": true }, "IsServiceAccountKeySet": { "description": "Indicates whether the value of the 'serviceAccountKey' property has been set.", "type": "boolean", "default": false, "readOnly": true, "x-omitempty": true }, "KeyType": { "description": "Google Cloud Platform (GCP) service account's key type.\n* `JSON` - JavaScript Object Notation (JSON) is a standard text-based format for representing structured data based on JavaScript object syntax. It is commonly used for transmitting data in web applications.\n* `P12` - PKCS #12 is an archive file format for storing many cryptography objects as a single file. It is commonly used to bundle a private key with its X.509 certificate or to bundle all the members of a chain of trust.", "type": "string", "enum": [ "JSON", "P12" ], "default": "JSON", "x-omitempty": true }, "ServiceAccountKey": { "description": "Google Cloud Platform (GCP) service account's key file content in the format of the keyType specified.", "type": "string", "writeOnly": true, "x-omitempty": true } } } ] }, "asset.HttpConnection": { "title": "Asset:Http Connection", "description": "HttpConnection provides the necessary details for Intersight to connect to and authenticate with a managed target over an HTTP connection.", "x-allOf-name": "asset.HttpConnection", "allOf": [ { "$ref": "#/components/schemas/asset.Connection" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.HttpConnection', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.HttpConnection" ], "default": "asset.HttpConnection", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.HttpConnection" ], "default": "asset.HttpConnection", "x-enum-as-string": true }, "CertificateAuthority": { "description": "The certificate authority of the target. If set and connection is secure the connection will be validate using the servers identity with this certificate. If not set no validation will be done of the identity.", "type": "string", "x-omitempty": true }, "IsSecure": { "description": "Indicates whether a connection to the target should be established using HTTPS.", "type": "boolean", "default": true, "x-omitempty": true }, "ManagementAddress": { "description": "The DNS hostname or IP Address, either IPv4 or IPv6, to be used to connect to the managed target.", "type": "string", "x-omitempty": true }, "Port": { "description": "The port number to be used to connect to the managed target. Values 1-65535 indicate a port number to be used. A value of 0 is not a valid port number and instead indicates that the default management port, as defined by the documentation of the managed target, should be used to establish a connection.", "type": "integer", "format": "int64", "minimum": 0, "maximum": 65535, "x-omitempty": true } } } ] }, "asset.IntersightDeviceConnectorConnection": { "title": "Asset:Intersight Device Connector Connection", "description": "Target is connected to Intersight using a Device Connector.", "x-allOf-name": "asset.IntersightDeviceConnectorConnection", "allOf": [ { "$ref": "#/components/schemas/asset.Connection" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.IntersightDeviceConnectorConnection', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.IntersightDeviceConnectorConnection" ], "default": "asset.IntersightDeviceConnectorConnection", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.IntersightDeviceConnectorConnection" ], "default": "asset.IntersightDeviceConnectorConnection", "x-enum-as-string": true }, "PreClaim": { "description": "A pre-claim of an embedded target. Does not require a security token to be provided at target create, target will be created in a pre-claim state.", "type": "boolean", "writeOnly": true, "x-omitempty": true }, "SecurityToken": { "description": "The SecurityToken object holds a time-limited random string used for claiming a device. It is created implicitly for each device connector at the time of registration, providing a secure mechanism for users to assert administrative access during device claim operations.\n#### Purpose\nSecurityToken acts as a temporary credential that proves a user's administrative access to a device, allowing them to claim the device within Intersight. It strengthens the security of claim operations, preventing unauthorized device claims by restricting access to users who possess the token.\n#### Key Concepts\n- **Time-Bound Security:** Tokens are generated with expiration times, ensuring they are only valid for a limited duration to reduce the risk of misuse.\n- **Claim Validation:** Used during claim operations to validate that the user has the necessary privileges to manage the device.\n- **Access Control:** Integrates with Intersight's security model, providing controlled access to device claim functionalities.", "type": "string", "writeOnly": true, "x-omitempty": true }, "SerialNumber": { "description": "Obtained from the device connector management UI or API (REST endpoint '/connector/DeviceIdentifiers').", "type": "string", "writeOnly": true, "x-omitempty": true } } } ] }, "asset.MerakiCloudOptions": { "title": "Asset:Meraki Cloud Options", "description": "Captures the Meraki organization Id that is mapped to the claimed target.", "x-allOf-name": "asset.MerakiCloudOptions", "allOf": [ { "$ref": "#/components/schemas/asset.ServiceOptions" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.MerakiCloudOptions', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.MerakiCloudOptions" ], "default": "asset.MerakiCloudOptions", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.MerakiCloudOptions" ], "default": "asset.MerakiCloudOptions", "x-enum-as-string": true }, "OrganizationId": { "description": "The Meraki organization id that is mapped to the target being claimed.", "type": "string", "x-omitempty": true } } } ] }, "asset.MeteringType": { "title": "Asset:Metering Type", "description": "Type for saving Metering details.", "x-allOf-name": "asset.MeteringType", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.MeteringType', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.MeteringType" ], "default": "asset.MeteringType", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.MeteringType" ], "default": "asset.MeteringType", "x-enum-as-string": true }, "Name": { "description": "Metric type used to calculate metering for the device sent from the IB Contract. example Node, vMemory, vCPU.\n* `None` - A default value to catch cases where metric type is not correctly detected.\n* `Node` - The metering of the device is on the basis of Power state.\n* `Storage` - The metering of the device is on the basis of used Storage.\n* `vMemory` - The metering of the device is on the basis of VM Memory.\n* `vCPU` - The metering of the device is on the basis of vCPU.\n* `vStorage` - The metering of the device is on the basis of used virtual Storage.\n* `Switch` - The metering of the device is on the basis of Switch.", "type": "string", "enum": [ "None", "Node", "Storage", "vMemory", "vCPU", "vStorage", "Switch" ], "default": "None", "readOnly": true, "x-omitempty": true }, "Unit": { "description": "Metric unit used to calculate metering for the device sent from the IB Contract. example Node, GiB, Cores.\n* `None` - A default value to catch cases where metric unit is not correctly detected.\n* `Node` - It is applicable for Node Metric type.\n* `GiB` - It is applicable for VMemory, vStorage and Storage Metric types.\n* `TiB` - It is applicable for VMemory, vStorage and Storage Metric types.\n* `Cores` - It is applicable for vCPU Metric type.\n* `Switch` - It is applicable for Switch Metric type.\n* `Port` - It is applicable for Switch Metric type.", "type": "string", "enum": [ "None", "Node", "GiB", "TiB", "Cores", "Switch", "Port" ], "default": "None", "readOnly": true, "x-omitempty": true } } } ] }, "asset.NewRelicCredential": { "title": "Asset:New Relic Credential", "description": "Credentials for authenticating with a NewRelic target. Management of a NewRelic target leverages multiple management interfaces and this credential object contains all necessary credentials.", "x-allOf-name": "asset.NewRelicCredential", "allOf": [ { "$ref": "#/components/schemas/asset.Credential" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.NewRelicCredential', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.NewRelicCredential" ], "default": "asset.NewRelicCredential", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.NewRelicCredential" ], "default": "asset.NewRelicCredential", "x-enum-as-string": true }, "GraphQlCredential": { "description": "A credential for authenticating with the NewRelic GraphQL interface.", "$ref": "#/components/schemas/asset.ApiKeyCredential", "x-omitempty": true }, "RestApiCredential": { "description": "A credential for authenticating with the NewRelic Rest API interface.", "$ref": "#/components/schemas/asset.ApiKeyCredential", "x-omitempty": true } } } ] }, "asset.NoAuthenticationCredential": { "title": "Asset:No Authentication Credential", "description": "Used against a target which does not require any credential.", "x-allOf-name": "asset.NoAuthenticationCredential", "allOf": [ { "$ref": "#/components/schemas/asset.Credential" } ] }, "asset.OauthBearerTokenCredential": { "title": "Asset:Oauth Bearer Token Credential", "description": "A credential which performs authentication based on a bearer token.", "x-allOf-name": "asset.OauthBearerTokenCredential", "allOf": [ { "$ref": "#/components/schemas/asset.Credential" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.OauthBearerTokenCredential', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.OauthBearerTokenCredential" ], "default": "asset.OauthBearerTokenCredential", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.OauthBearerTokenCredential" ], "default": "asset.OauthBearerTokenCredential", "x-enum-as-string": true }, "IsTokenSet": { "description": "Indicates whether the value of the 'token' property has been set.", "type": "boolean", "default": false, "readOnly": true, "x-omitempty": true }, "ScopeType": { "description": "Scope type for the crendetial i.e. User, Organization, Team.", "type": "string", "x-omitempty": true }, "ScopeValue": { "description": "Scope value for the credential i.e. username, organization name or team name.", "type": "string", "x-omitempty": true }, "Token": { "description": "The token used to authenticate with a managed target.", "type": "string", "writeOnly": true, "x-omitempty": true } } } ] }, "asset.OauthClientIdSecretCredential": { "title": "Asset:Oauth Client Id Secret Credential", "description": "An OAuth credential which performs authentication based on a client ID and client Secret.", "x-allOf-name": "asset.OauthClientIdSecretCredential", "allOf": [ { "$ref": "#/components/schemas/asset.Credential" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.OauthClientIdSecretCredential', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.OauthClientIdSecretCredential" ], "default": "asset.OauthClientIdSecretCredential", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.OauthClientIdSecretCredential" ], "default": "asset.OauthClientIdSecretCredential", "x-enum-as-string": true }, "ClientId": { "description": "The client ID used to authenticate with a managed target.", "type": "string", "x-omitempty": true }, "ClientSecret": { "description": "The client secret used to authenticate with a managed target.", "type": "string", "writeOnly": true, "x-omitempty": true }, "IsClientSecretSet": { "description": "Indicates whether the value of the 'clientSecret' property has been set.", "type": "boolean", "default": false, "readOnly": true, "x-omitempty": true } } } ] }, "asset.OrchestrationCivpVmwareVcenterOptions": { "title": "Asset:Orchestration Civp Vmware Vcenter Options", "description": "Captures configuration specific to the VMware Vcenter target for the VSphere Remote Plugin.", "x-allOf-name": "asset.OrchestrationCivpVmwareVcenterOptions", "allOf": [ { "$ref": "#/components/schemas/asset.ServiceOptions" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.OrchestrationCivpVmwareVcenterOptions', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.OrchestrationCivpVmwareVcenterOptions" ], "default": "asset.OrchestrationCivpVmwareVcenterOptions", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.OrchestrationCivpVmwareVcenterOptions" ], "default": "asset.OrchestrationCivpVmwareVcenterOptions", "x-enum-as-string": true }, "CivpEnabled": { "description": "CivpEnabled controls whether VSphere Remote Plugin is enabled or not. vCenter Server version 8.0 or later.", "type": "boolean", "x-omitempty": true }, "IsClientSecretSet": { "description": "Indicates whether the value of the 'clientSecret' property has been set.", "type": "boolean", "default": false, "readOnly": true, "x-omitempty": true } } } ] }, "asset.OrchestrationHitachiVirtualStoragePlatformOptions": { "title": "Asset:Orchestration Hitachi Virtual Storage Platform Options", "description": "Captures configuration specific to the Hitachi Virtual Storage Platform target for the Orchestration service.", "x-allOf-name": "asset.OrchestrationHitachiVirtualStoragePlatformOptions", "allOf": [ { "$ref": "#/components/schemas/asset.ServiceOptions" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.OrchestrationHitachiVirtualStoragePlatformOptions', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.OrchestrationHitachiVirtualStoragePlatformOptions" ], "default": "asset.OrchestrationHitachiVirtualStoragePlatformOptions", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.OrchestrationHitachiVirtualStoragePlatformOptions" ], "default": "asset.OrchestrationHitachiVirtualStoragePlatformOptions", "x-enum-as-string": true }, "OpsCenterManagementAddress": { "description": "The DNS hostname or IP address of the Hitachi Ops Center API Configuration Manager used to manage the Hitachi Virtual Storage Platform.", "type": "string", "x-omitempty": true } } } ] }, "asset.OrchestrationHsmVmwareVcenterOptions": { "title": "Asset:Orchestration Hsm Vmware Vcenter Options", "description": "Captures configuration specific to the VMware Vcenter target for the Hardware Support Manager.", "x-allOf-name": "asset.OrchestrationHsmVmwareVcenterOptions", "allOf": [ { "$ref": "#/components/schemas/asset.ServiceOptions" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.OrchestrationHsmVmwareVcenterOptions', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.OrchestrationHsmVmwareVcenterOptions" ], "default": "asset.OrchestrationHsmVmwareVcenterOptions", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.OrchestrationHsmVmwareVcenterOptions" ], "default": "asset.OrchestrationHsmVmwareVcenterOptions", "x-enum-as-string": true }, "HsmEnabled": { "description": "HsmEnabled controls whether Hardware Support Manager is enabled or not. vCenter Server version 7.0 or later.", "type": "boolean", "x-omitempty": true }, "IsClientSecretSet": { "description": "Indicates whether the value of the 'clientSecret' property has been set.", "type": "boolean", "default": false, "readOnly": true, "x-omitempty": true } } } ] }, "asset.OrchestrationService": { "title": "Asset:Orchestration Service", "description": "OrchestrationService provides the necessary configuration details to enable Intersight Orchestration on the selected managed target. Subject to licensing.", "x-allOf-name": "asset.OrchestrationService", "allOf": [ { "$ref": "#/components/schemas/asset.Service" } ] }, "asset.ParentConnectionSignature": { "title": "Asset:Parent Connection Signature", "description": "A signature generated by a device connector with its private key. Signature is passed to leaf device connectors to authenticate connectivity between devices.", "x-allOf-name": "asset.ParentConnectionSignature", "allOf": [ { "$ref": "#/components/schemas/asset.ClaimSignature" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.ParentConnectionSignature', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.ParentConnectionSignature" ], "default": "asset.ParentConnectionSignature", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.ParentConnectionSignature" ], "default": "asset.ParentConnectionSignature", "x-enum-as-string": true }, "DeviceId": { "description": "The moid of the parent device registration.", "type": "string", "x-omitempty": true }, "NodeId": { "description": "The node identity of the parent device, corresponds to the parents ClusterMember.memberIdentity. Used on connect to establish through which device in a cluster the child is connected through.", "type": "string", "x-omitempty": true } } } ] }, "asset.PreClaim": { "title": "Asset:Pre Claim", "description": "The PreClaim object is a specialized component of the device management system designed to facilitate the completion of the claim process for pre-provisioned assets. It acts as a bridge for targets that are defined in the system before their physical endpoints have established a connection to the management platform.\n#### Purpose\nA PreClaim serves to facilitate the completion of the claim process for hardware that has been staged or provisioned in advance. The object specifically manages the association between a pre-defined target and the unique security credentials of the connecting hardware.\n#### Key Concepts\n- **Secure Validation**: Facilitates the completion of the claim process by requiring a security token and serial number, ensuring that only authorized physical devices can assume the identity of a pre-provisioned target.\n- **Lifecycle Transition**: Manages the status of the claim from an initial pre-provisioned state to a finalized \"claimed\" state, at which point the device is fully integrated and manageable.\n- **Role-Based Management**: Access is strictly governed by specific privilege sets, such as Account Administrator and Claim Device roles, ensuring that only authorized personnel can complete the onboarding of assets.", "x-allOf-name": "asset.PreClaim", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.PreClaim', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.PreClaim" ], "default": "asset.PreClaim", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.PreClaim" ], "default": "asset.PreClaim", "x-enum-as-string": true }, "SecurityToken": { "description": "Obtained from the device connector management UI or API (REST endpoint '/connector/SecurityTokens').", "type": "string", "writeOnly": true, "x-omitempty": true }, "SerialNumber": { "description": "Obtained from the device connector management UI or API (REST endpoint '/connector/DeviceIdentifiers').", "type": "string", "x-omitempty": true }, "Target": { "$ref": "#/components/schemas/asset.Target.Relationship", "description": "A reference to a assetTarget resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "asset.PrivateKeyCredential": { "title": "Asset:Private Key Credential", "description": "A credential which performs authentication based on a private key for targets like SSH Endpoint. PrivateKeyCredential used to establish password-less SSH connection to the endpoint.", "x-allOf-name": "asset.PrivateKeyCredential", "allOf": [ { "$ref": "#/components/schemas/asset.Credential" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.PrivateKeyCredential', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.PrivateKeyCredential" ], "default": "asset.PrivateKeyCredential", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.PrivateKeyCredential" ], "default": "asset.PrivateKeyCredential", "x-enum-as-string": true }, "IsPassphraseSet": { "description": "Indicates whether the value of the 'passphrase' property has been set.", "type": "boolean", "default": false, "readOnly": true, "x-omitempty": true }, "IsPrivateKeySet": { "description": "Indicates whether the value of the 'privateKey' property has been set.", "type": "boolean", "default": false, "readOnly": true, "x-omitempty": true }, "Passphrase": { "description": "The passphrase associated with the private key - Optional.", "type": "string", "writeOnly": true, "x-omitempty": true }, "PrivateKey": { "description": "The private key used to authenticate with a managed target. The corresponding public key needs to be added in the auth list of the remote endpoint.", "type": "string", "writeOnly": true, "x-omitempty": true }, "Username": { "description": "The username used to authenticate with a managed target.", "type": "string", "x-omitempty": true } } } ] }, "asset.ProductInformation": { "title": "Asset:Product Information", "description": "Type for saving the product information.", "x-allOf-name": "asset.ProductInformation", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.ProductInformation', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.ProductInformation" ], "default": "asset.ProductInformation", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.ProductInformation" ], "default": "asset.ProductInformation", "x-enum-as-string": true }, "BillTo": { "description": "Billing address provided by customer while buying this Cisco product.", "$ref": "#/components/schemas/asset.AddressInformation", "readOnly": true, "x-omitempty": true }, "Description": { "description": "Short description of the Cisco product that helps identify the product easily. example \"DISTI:UCS 6248UP 1RU Fabric Int/No PSU/32 UP/ 12p LIC\".", "type": "string", "readOnly": true, "x-omitempty": true }, "Family": { "description": "Family that the product belongs to. Example \"UCSB\".", "type": "string", "readOnly": true, "x-omitempty": true }, "Group": { "description": "Group that the product belongs to. It is one higher level categorization above family. example \"Switch\".", "type": "string", "readOnly": true, "x-omitempty": true }, "Number": { "description": "Product number that identifies the product. example PID. example \"UCS-FI-6248UP-CH2\".", "type": "string", "readOnly": true, "x-omitempty": true }, "ShipTo": { "description": "Shipping address provided by customer while buying this Cisco product.", "$ref": "#/components/schemas/asset.AddressInformation", "readOnly": true, "x-omitempty": true }, "SubType": { "description": "Sub type of the product being specified. example \"UCS 6200 SER\".", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "asset.ScopedTargetConnection": { "title": "Asset:Scoped Target Connection", "description": "ScopedTargetConnection provides the necessary details for Intersight to connect to and authenticate with a managed scoped target such as msSQL, mySQL and Oracle Database etc.", "x-allOf-name": "asset.ScopedTargetConnection", "allOf": [ { "$ref": "#/components/schemas/asset.Connection" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.ScopedTargetConnection', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.ScopedTargetConnection" ], "default": "asset.ScopedTargetConnection", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.ScopedTargetConnection" ], "default": "asset.ScopedTargetConnection", "x-enum-as-string": true }, "FullValidation": { "description": "When this flag is set to true, every IWO entity in the scope targets will be checked and discovery of the scope target will be regarded as a failure when anyone of these entities cannot be connected and validated.", "type": "boolean", "x-omitempty": true }, "IsSecure": { "description": "Indicates whether a connection to the target should be established using TLS.", "type": "boolean", "default": true, "x-omitempty": true }, "Port": { "description": "The port number to be used to connect to the managed target. Values 1-65535 indicate a port number to be used. A value of 0 is not a valid port number and instead indicates that the default management port, as defined by the documentation of the managed target, should be used to establish a connection.", "type": "integer", "format": "int64", "minimum": 0, "maximum": 65535, "x-omitempty": true }, "Scope": { "description": "The group id of IWO entities upon which the discover of a scoped target is performed. For example, a database target may be scoped to the group of virtual machines upon which the database application is running. Scope value is group id created for all those virtual machines in this scope.", "type": "string", "x-omitempty": true } } } ] }, "asset.Service": { "title": "Asset:Service", "description": "A service that is enabled on a managed target. For example, Intersight Orchestration or Intersight Workload Optimizer.", "x-allOf-name": "asset.Service", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.Service', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "asset.OrchestrationService", "asset.TerraformIntegrationService", "asset.VirtualizationService", "asset.WorkloadOptimizerService" ], "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "asset.OrchestrationService", "asset.TerraformIntegrationService", "asset.VirtualizationService", "asset.WorkloadOptimizerService" ], "x-enum-as-string": true }, "Options": { "description": "Captures configuration that is specific to a target type for a specific service.", "$ref": "#/components/schemas/asset.ServiceOptions", "x-omitempty": true } } } ] }, "asset.ServiceNowCredential": { "title": "Asset:Service Now Credential", "description": "Credentials for authenticating with a ServiceNow target. Management of a ServiceNow target leverages multiple management interfaces and this credential object contains all necessary credentials.", "x-allOf-name": "asset.ServiceNowCredential", "allOf": [ { "$ref": "#/components/schemas/asset.Credential" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.ServiceNowCredential', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.ServiceNowCredential" ], "default": "asset.ServiceNowCredential", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.ServiceNowCredential" ], "default": "asset.ServiceNowCredential", "x-enum-as-string": true }, "OauthAuthenticationCredential": { "description": "Optional client id/secret credential used for OAuth authentication with ServiceNow target. ServiceNow requires this to be used for OAuth authentication combining with user/password credential.", "$ref": "#/components/schemas/asset.OauthClientIdSecretCredential", "x-omitempty": true }, "UserPasswordCredential": { "description": "Minimum required user/password credential to validate and discover ServiceNow target.", "$ref": "#/components/schemas/asset.UsernamePasswordCredential", "x-omitempty": true } } } ] }, "asset.ServiceOptions": { "title": "Asset:Service Options", "description": "ServiceOptions captures configuration that is specific to a target type for a specific service.", "x-allOf-name": "asset.ServiceOptions", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" } ] }, "asset.SplunkTokenCredential": { "title": "Asset:Splunk Token Credential", "description": "A credential which performs authentication based on Splunk token.", "x-allOf-name": "asset.SplunkTokenCredential", "allOf": [ { "$ref": "#/components/schemas/asset.Credential" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.SplunkTokenCredential', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.SplunkTokenCredential" ], "default": "asset.SplunkTokenCredential", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.SplunkTokenCredential" ], "default": "asset.SplunkTokenCredential", "x-enum-as-string": true }, "IsTokenSet": { "description": "Indicates whether the value of the 'token' property has been set.", "type": "boolean", "default": false, "readOnly": true, "x-omitempty": true }, "Token": { "description": "The Splunk token used to authenticate with a managed target.", "type": "string", "writeOnly": true, "x-omitempty": true } } } ] }, "asset.SshConnection": { "title": "Asset:Ssh Connection", "description": "SshConnection provides the necessary details for Intersight to connect and authenticate with a managed target over an SSH connection.", "x-allOf-name": "asset.SshConnection", "allOf": [ { "$ref": "#/components/schemas/asset.Connection" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.SshConnection', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.SshConnection" ], "default": "asset.SshConnection", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.SshConnection" ], "default": "asset.SshConnection", "x-enum-as-string": true }, "ManagementAddress": { "description": "The DNS hostname or IPv4 Address to be used to connect to the managed target.", "type": "string", "x-omitempty": true }, "Port": { "description": "The port number to be used to connect to the managed target. Valid values are 1 - 65535. If not provided, a default port of 22 is used to establish the SSH connection to the given target.", "type": "integer", "format": "int64", "minimum": 0, "maximum": 65535, "x-omitempty": true } } } ] }, "asset.Subscription.Response": { "description": "The response body of a HTTP GET request for the 'asset.Subscription' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'asset.Subscription' resources.", "x-one-of-name": "asset.Subscription.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/asset.Subscription.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "asset.Subscription.Relationship": { "description": "A relationship to the 'asset.Subscription' resource, or the expanded 'asset.Subscription' resource, or the 'null' value.", "x-one-of-name": "asset.Subscription.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/asset.Subscription" } ], "discriminator": { "propertyName": "ClassId" } }, "asset.Subscription": { "title": "Asset:Subscription", "description": "The Subscription object is central to managing consumption-based subscriptions within the Cisco technology ecosystem. It encapsulates details about the subscriptions linked to Cisco devices, facilitating automated updates and management through integration with Cisco Install Base.\n#### Purpose\nSubscription provides a comprehensive structure for managing consumption-based subscriptions, ensuring seamless integration with Cisco Install Base for accurate data representation and updates. This information is also queried by downstream OPUS team for billing purposes. \n#### Key Concepts\n- **Integration:** Automates subscription management through real-time updates from Cisco Install Base, ensuring data accuracy and currency.\n- **Data Management:** Supports efficient tracking and management of consumption-based subscriptions.\n- **Access Control:** Ensures secure handling of subscription data through defined privileges and permissions.\n- **Relationship Management:** Maintains robust linkage with associated accounts and deployments, supporting comprehensive subscription management.", "x-allOf-name": "asset.Subscription", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.Subscription', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.Subscription" ], "default": "asset.Subscription", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.Subscription" ], "default": "asset.Subscription", "x-enum-as-string": true }, "ApplicationName": { "description": "Application name reported by Cisco Install Base.", "type": "string", "readOnly": true, "x-omitempty": true }, "SubscriptionRefId": { "description": "Identifies the consumption-based subscription.", "type": "string", "readOnly": true, "x-omitempty": true }, "Deployments": { "description": "An array of relationships to assetDeployment resources.", "type": "array", "items": { "$ref": "#/components/schemas/asset.Deployment.Relationship" }, "nullable": true, "readOnly": true }, "SubscriptionAccount": { "$ref": "#/components/schemas/asset.SubscriptionAccount.Relationship", "description": "A reference to a assetSubscriptionAccount resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "asset.Subscription.List": { "title": "List of 'asset.Subscription' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'asset.Subscription' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'asset.Subscription' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/asset.Subscription" }, "nullable": true } } } ] }, "asset.SubscriptionAccount.Response": { "description": "The response body of a HTTP GET request for the 'asset.SubscriptionAccount' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'asset.SubscriptionAccount' resources.", "x-one-of-name": "asset.SubscriptionAccount.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/asset.SubscriptionAccount.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "asset.SubscriptionAccount.Relationship": { "description": "A relationship to the 'asset.SubscriptionAccount' resource, or the expanded 'asset.SubscriptionAccount' resource, or the 'null' value.", "x-one-of-name": "asset.SubscriptionAccount.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/asset.SubscriptionAccount" } ], "discriminator": { "propertyName": "ClassId" } }, "asset.SubscriptionAccount": { "title": "Asset:Subscription Account", "description": "The SubscriptionAccount object is a foundational element within the subscription management framework, acting as a placeholder for the account collection. Its primary function is to ensure stability and continuity in subscription-related operations by preventing data updates during account change events.\n#### Purpose\nSubscriptionAccount acts as a stabilizing component within the subscription management system, safeguarding data integrity during account modifications. This provides a structured approach to manage and reference account-related subscription data.\n#### Key Concepts\n- **Data Stability:** Protects subscription data from unintended updates during account changes, ensuring operational consistency.\n- **Account Integration:** Serves as a reference point for subscription data, maintaining a clear linkage between accounts and subscriptions.\n- **Access Control:** Leveraging permissions, it ensures only authorized users can interact with account-related subscription data.\n- **Dependency Management:** Plays a key role in managing relationships and dependencies within the subscription ecosystem.", "x-allOf-name": "asset.SubscriptionAccount", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.SubscriptionAccount', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.SubscriptionAccount" ], "default": "asset.SubscriptionAccount", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.SubscriptionAccount" ], "default": "asset.SubscriptionAccount", "x-enum-as-string": true }, "Account": { "$ref": "#/components/schemas/iam.Account.Relationship", "description": "A reference to a iamAccount resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." } } } ] }, "asset.SubscriptionAccount.List": { "title": "List of 'asset.SubscriptionAccount' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'asset.SubscriptionAccount' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'asset.SubscriptionAccount' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/asset.SubscriptionAccount" }, "nullable": true } } } ] }, "asset.SubscriptionDeviceContractInformation.Response": { "description": "The response body of a HTTP GET request for the 'asset.SubscriptionDeviceContractInformation' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'asset.SubscriptionDeviceContractInformation' resources.", "x-one-of-name": "asset.SubscriptionDeviceContractInformation.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/asset.SubscriptionDeviceContractInformation.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "asset.SubscriptionDeviceContractInformation": { "title": "Asset:Subscription Device Contract Information", "description": "The SubscriptionDeviceContractInformation object is a crucial component of asset management within the Cisco ecosystem, designed to encapsulate information regarding devices associated with consumption-based subscriptions. It plays a vital role in tracking device installation status, customer details, and managing returns and replacements.\n#### Purpose\nSubscriptionDeviceContractInformation serves as a comprehensive repository for device-related information under consumption-based subscriptions. It ensures a seamless integration with Cisco Install Base, providing up-to-date data on device status and associated customer information.\n#### Key Concepts\n- **Device Association:** Centralizes information about Cisco devices under subscriptions, facilitating efficient management and tracking.\n- **Integration with Install Base:** Listens to messages from Cisco Install Base for automated updates, ensuring accurate and current data representation.\n- **Ownership and Access:** Managed by the system with defined access privileges, supporting secure and controlled access by authorized users.\n- **Information Persistence:** Ensures data integrity and reliability by maintaining detailed records of device installation status and transaction history.", "x-allOf-name": "asset.SubscriptionDeviceContractInformation", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.SubscriptionDeviceContractInformation', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.SubscriptionDeviceContractInformation" ], "default": "asset.SubscriptionDeviceContractInformation", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.SubscriptionDeviceContractInformation" ], "default": "asset.SubscriptionDeviceContractInformation", "x-enum-as-string": true }, "DeviceId": { "description": "Unique identifier of the Cisco device.", "type": "string", "readOnly": true, "x-omitempty": true }, "DeviceInformation": { "description": "Detailed device information including installation status and customer address.", "$ref": "#/components/schemas/asset.DeviceInformation", "readOnly": true, "x-omitempty": true }, "DevicePid": { "description": "Product identifier for the specified Cisco device. It is used to distinguish between HyperFlex and UCS devices.", "type": "string", "readOnly": true, "x-omitempty": true }, "SubscriptionRefId": { "description": "Identifies the consumption-based subscription.", "type": "string", "readOnly": true, "x-omitempty": true }, "DeviceContractInformation": { "$ref": "#/components/schemas/asset.DeviceContractInformation.Relationship", "description": "A reference to a assetDeviceContractInformation resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "asset.SubscriptionDeviceContractInformation.List": { "title": "List of 'asset.SubscriptionDeviceContractInformation' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'asset.SubscriptionDeviceContractInformation' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'asset.SubscriptionDeviceContractInformation' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/asset.SubscriptionDeviceContractInformation" }, "nullable": true } } } ] }, "asset.SudiInfo": { "title": "Asset:Sudi Info", "description": "The SUDI is an X.509v3 certificate, which maintains the product identifier and serial number. The identity is implemented at manufacturing and chained to a publicly identifiable root certificate authority. It can be used as an unchangeable identity for configuration, security, auditing, and management. This structure contains the SUDI information read from the device's Trust Anchor Module (TAM).\nWhen the Intersight service receives a SUDI signature, it performs the following steps: 1. Validate the SUDI certificate is valid and has been issued by a trusted Certificate Authority. 2. Validate the 'signature'. In DC ApiVersion >= 16, the signature is expected to be a JWT signed by the TAM private key. 3. Set the 'status' property to indicate whether the signature is valid or not.", "x-allOf-name": "asset.SudiInfo", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.SudiInfo', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.SudiInfo" ], "default": "asset.SudiInfo", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.SudiInfo" ], "default": "asset.SudiInfo", "x-enum-as-string": true }, "Jti": { "description": "The SUDI challenge jti generated by Intersight. The device reads the current JTI and signs it as part of its SUDI claims and sends to Intersight. Intersight verifies SUDI with the JTI claim. A new JTI is generated after each time a device sends updated SUDI information.", "type": "string", "readOnly": true, "x-omitempty": true }, "Pid": { "description": "The device model (PID) extracted from the X.509 SUDI leaf certificate.", "type": "string", "readOnly": true, "x-omitempty": true }, "SerialNumber": { "description": "The device SerialNumber extracted from the X.509 SUDI leaf certificate.", "type": "string", "readOnly": true, "x-omitempty": true }, "Signature": { "description": "The base64-encoding of a SUDI signature, signed with the provided Trust Anchor Module (TAM) private key and signatureScheme.", "type": "string", "readOnly": true, "x-omitempty": true }, "Status": { "description": "The validation status of the device.\n* `DeviceStatusUnknown` - SUDI validation is done on the establishment of a connection. Before a device connects or after it disconnects, the SUDI validation status is set to this value.\n* `Verified` - The SUDI signature and certificate have been validated by the device. The device PID, Serial Number, Status and X.509 certificates were validated by a Trusted Anchor Module. The Intersight services have not cross-validated the SUDI signature.\n* `EndToEndVerified` - The SUDI signature and certificate have been validated by the device and by the Intersight services. The device PID, Serial Number, Status and X.509 certificates were validated by a Trusted Anchor Module.\n* `ChallengeVerified` - The SUDI signature includes a challenge provided by Intersight which has been validated by Intersight. The SUDI signature and certificate have been validated by the device and by the Intersight services. The device PID, Serial Number, Status and X.509 certificates were validated by a Trusted Anchor Module.\n* `CertificateValidationFailed` - Validation of the certificate signing chain failed.\n* `UnsupportedSignatureScheme` - The SUDI signature scheme is not supported.\n* `SignatureValidationFailed` - Validation of the SUDI signature has failed.\n* `UnsupportedFirmware` - The firmware version of the Cisco IMC that is installed does not contain the SUDI APIs needed to perform validation.\n* `UnsupportedHardware` - The device is a model that does not contain a Trust Anchor Module (TAM) and thus cannot be validated.\n* `DeviceError` - The device returned an error when it received a SUDIrequrest request.\n* `DeviceNotResponding` - A request was sent to the device, but no response was received.\n* `InvalidSignatureEncoding` - The encoding of the SUDI signature is invalid.\n* `MissingSignature` - The SUDI signature is missing.\n* `MissingSignatureScheme` - The SUDI signature scheme is missing.\n* `MissingCertificate` - The SUDI certificate is missing.\n* `InvalidCertificateEncoding` - The encoding of the SUDI certificate is invalid.\n* `InvalidIdentity` - The model or serial number of the device is either missing or does not match the certificate attributes.\n* `Suspect` - The DC claims the SUDI has been verified, but there is no way to validate the claim.", "type": "string", "enum": [ "DeviceStatusUnknown", "Verified", "EndToEndVerified", "ChallengeVerified", "CertificateValidationFailed", "UnsupportedSignatureScheme", "SignatureValidationFailed", "UnsupportedFirmware", "UnsupportedHardware", "DeviceError", "DeviceNotResponding", "InvalidSignatureEncoding", "MissingSignature", "MissingSignatureScheme", "MissingCertificate", "InvalidCertificateEncoding", "InvalidIdentity", "Suspect" ], "default": "DeviceStatusUnknown", "readOnly": true, "x-omitempty": true }, "StatusDetails": { "description": "The detailed validation status of the device, such as an error message explaining why the validation failed.", "type": "string", "readOnly": true, "x-omitempty": true }, "SudiCertificate": { "description": "The X.509 SUDI leaf certificate from the Trust Anchor Module. The certificate is serialized in PEM format (Base64 encoded DER certificate).", "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/x509.Certificate", "readOnly": true, "x-omitempty": true } } } ] }, "asset.Target.Response": { "description": "The response body of a HTTP GET request for the 'asset.Target' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'asset.Target' resources.", "x-one-of-name": "asset.Target.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/asset.Target.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "asset.Target.Relationship": { "description": "A relationship to the 'asset.Target' resource, or the expanded 'asset.Target' resource, or the 'null' value.", "x-one-of-name": "asset.Target.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/asset.Target" } ], "discriminator": { "propertyName": "ClassId" } }, "asset.Target": { "title": "Asset:Target", "description": "The Target object represents an entity managed by Intersight. It encompasses both physical and software entities, such as UCS servers or cloud accounts, and serves as the cornerstone for target management within Intersight's ecosystem.\n#### Purpose\nTarget serves as the interface for managing entities within Intersight, offering a comprehensive view of the status and capabilities of each managed entity. It supports the establishment of connections, monitoring, and service enablement, facilitating effective management of diverse targets.\n#### Key Concepts\n- **Type and Status Management:** Defines the type of the managed entity and provides insights into its connection and operational status.\n- **Service Integration:** Supports the enablement of services for the target, facilitating comprehensive management and optimization.\n- **Connection and Authentication:** Manages methods for connecting to targets, ensuring secure and reliable interaction between Intersight and the managed entities.\n- **Pre-provisioning Workflow**: Enables a \"claim-before-connect\" workflow, allowing system targets to be created and configured in anticipation of physical hardware deployment. It allows administrators to prepare the environment for new devices, ensuring that once a physical endpoint is connected, the transition to a fully managed state is secure and efficient. Pre provisioned Targets can complete their claim with by updating the associated asset.PreClaim object with the security token of the connected device.", "x-allOf-name": "asset.Target", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.Target', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.Target" ], "default": "asset.Target", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.Target" ], "default": "asset.Target", "x-enum-as-string": true }, "AlarmSummary": { "description": "AlarmSummary is a health score calculation and aggregation of alarm counts per severity of alarms which Intersight's ability to manage the Target.", "$ref": "#/components/schemas/asset.AlarmSummary", "readOnly": true, "x-omitempty": true }, "ClaimedByUserName": { "description": "The name or email id of the user who claimed the target.", "type": "string", "readOnly": true, "x-omitempty": true }, "ClaimedTime": { "description": "The date at which the target was claimed to this account. For pre-provisioned targets this is the time at which the claim was completed.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "Connections": { "type": "array", "items": { "description": "A list of methods for connecting to the managed target.", "$ref": "#/components/schemas/asset.Connection", "x-omitempty": true }, "minItems": 1, "maxItems": 1, "nullable": true }, "ConnectorVersion": { "description": "The Device Connector version for target types which are managed by via embedded Device Connector.", "type": "string", "readOnly": true, "x-omitempty": true }, "ExternalIpAddress": { "description": "ExternalIpAddress is applicable for targets which are managed via an Intersight Device Connector. The value is the IP Address of the target as seen from Intersight. It is either the IP Address of the managed target's interface which has a route to the internet or a NAT IP Address when the target is deployed in a private network.", "type": "string", "readOnly": true, "x-omitempty": true }, "IpAddress": { "type": "array", "items": { "description": "The IP Addresses of the managed target. There can be multiple management IPs depending on the number of elements managed (i.e. HA clusters) and in-band/out-of-band connectivity.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "ManagementLocation": { "description": "The location from which Intersight manages the target.\n* `Unknown` - The management mechanism is not detected. Unknown is used as a default by the implementation and is not an allowed user input.\n* `Intersight` - Management of a target is performed directly from Intersight. Network connections are established from Intersight to a management interface of the Target and authenticated using user provided credentials.\n* `IntersightAssist` - Management of a target is performed via a selected Intersight Assist. Network connections are established from the Intersight Assist to a management interface of the Target.\n* `DeviceConnector` - An Intersight Device Connector running within the Target establishes a connection to Intersight and management of the target is performed via this connection.", "type": "string", "enum": [ "Unknown", "Intersight", "IntersightAssist", "DeviceConnector" ], "default": "Unknown", "x-createOnly": true, "x-omitempty": true }, "Name": { "description": "A user provided name for the managed target.", "type": "string", "x-omitempty": true }, "ProductId": { "type": "array", "items": { "description": "The product Id of the managed target.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "ReadOnly": { "description": "For targets which are managed by an embedded Intersight Device Connector, this field indicates that an administrator of the target has disabled management operations of the Device Connector and only monitoring is permitted.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "Services": { "type": "array", "items": { "description": "A list of services which are enabled for the managed target.", "$ref": "#/components/schemas/asset.Service", "x-omitempty": true }, "nullable": true }, "Status": { "description": "Status indicates if Intersight can establish a connection and authenticate with the managed target. Status does not include information about the functional health of the target.\n* `` - The target details have been persisted but Intersight has not yet attempted to connect to the target.\n* `Connected` - Intersight is able to establish a connection to the target and initiate management activities.\n* `NotConnected` - Intersight is unable to establish a connection to the target.\n* `ClaimInProgress` - Claim of the target is in progress. A connection to the target has not been fully established.\n* `UnclaimInProgress` - Unclaim of the target is in progress. Intersight is able to connect to the target and all management operations are supported.\n* `Unclaimed` - The device was un-claimed from the users account by an Administrator of the device. Also indicates the failure to claim Targets of type HTTP Endpoint in Intersight.\n* `Claimed` - Target of type HTTP Endpoint is successfully claimed in Intersight. Currently no validation is performed to verify the Target connectivity from Intersight at the time of creation. However invoking API from Intersight Orchestrator fails if this Target is not reachable from Intersight or if Target API credentials are incorrect.\n* `PreClaimed` - Target has been pre-claimed and is pending claim completion. Pre-claimed targets are pre-provisioned before endpoint is available to connect to Intersight, once target connects the claim can be completed by providing the security token to the pre-claim API.", "type": "string", "enum": [ "", "Connected", "NotConnected", "ClaimInProgress", "UnclaimInProgress", "Unclaimed", "Claimed", "PreClaimed" ], "default": "", "readOnly": true, "x-omitempty": true }, "StatusErrorReason": { "description": "StatusErrorReason provides additional context for the Status.", "type": "string", "readOnly": true, "x-omitempty": true }, "TargetId": { "type": "array", "items": { "description": "The identifier of the managed target such as serial number or UID.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "TargetType": { "description": "The type of the managed target. For example a UCS Server or VMware Vcenter target.\n* `` - An unrecognized platform type.\n* `APIC` - A Cisco Application Policy Infrastructure Controller (APIC) cluster.\n* `CAPIC` - A Cisco Cloud Application Policy Infrastructure Controller (Cloud APIC) instance.\n* `DCNM` - A Cisco Data Center Network Manager (DCNM) instance.\n* `UCSFI` - A Cisco UCS Fabric Interconnect that is managed by Cisco UCS Manager (UCSM).\n* `UCSFIISM` - A Cisco UCS Fabric Interconnect that is managed by Cisco Intersight.\n* `IMC` - A standalone Cisco UCS rack server (Deprecated).\n* `IMCM4` - A standalone Cisco UCS C-Series or S-Series M4 server.\n* `IMCM5` - A standalone Cisco UCS C-Series or S-Series M5 server.\n* `IMCRack` - A standalone Cisco UCS C-Series or S-Series M6 or newer server.\n* `UCSIOM` - A Cisco UCS Blade Chassis I/O Module (IOM).\n* `UCSPCIeNODE` - A Cisco UCS PCIe Node in a blade form factor.\n* `UCSXFM` - A Cisco UCS Fabric Extender Module (XFM).\n* `HX` - A Cisco HyperFlex (HX) cluster.\n* `UCSD` - A Cisco UCS Director (UCSD) instance.\n* `UCSXECMC` - A Cisco UCSXE Chassis Management Controller.\n* `UCSXESecureRouter` - A secure networking router node designed to operate as part of a UCSXE chassis.\n* `IntersightAppliance` - A Cisco Intersight Connected Virtual Appliance instance.\n* `IntersightAssist` - A Cisco Intersight Assist instance.\n* `PureStorageFlashArray` - A Pure Storage FlashArray that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer and storage management features are supported on this device.\n* `PureStorageFlashBladeSystem` - A Pure Storage FlashBlade target that is managed using Cisco Intersight Assist. Storage management feature is supported on this device.\n* `NexusDevice` - A Cisco Nexus Network Switch that is managed using Cisco Intersight Assist.\n* `ACISwitch` - A Cisco Nexus Network Switch with the embedded Device Connector and is a part of the Cisco ACI fabric.\n* `NexusSwitch` - A standalone Cisco Nexus Network Switch with the embedded Device Connector.\n* `MDSSwitch` - A Cisco MDS Switch that is managed using the embedded Device Connector.\n* `MDSDevice` - A Cisco MDS Switch that is managed using Cisco Intersight Assist.\n* `UCSC885` - A standalone Cisco UCS C885 Server.\n* `CAI845A` - A standalone Cisco AI 845A Server.\n* `UCSC890` - A standalone Cisco UCS C890 server managed using Cisco Intersight Assist.\n* `RedfishServer` - A generic target type for servers that support Redfish APIs and is managed using Cisco Intersight Assist. Support is limited to HPE and Dell Servers.\n* `NetAppOntap` - A Netapp ONTAP Storage system that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this device.\n* `NetAppActiveIqUnifiedManager` - A NetApp Active IQ Unified Manager (AIQUM) that is managed using Cisco Intersight Assist.\n* `EmcScaleIo` - An EMC ScaleIO Software Defined Storage system that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this device.\n* `EmcVmax` - An EMC VMAX 2 or 3 series enterprise storage array that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this device.\n* `EmcVplex` - An EMC VPLEX virtual storage system that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this device.\n* `EmcXtremIo` - An EMC XtremIO SSD storage system that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this device.\n* `VmwareVcenter` - A VMware vCenter instance that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer and Virtualization features are supported on this hypervisor.\n* `MicrosoftHyperV` - A Microsoft Hyper-V host that is managed using Cisco Intersight Assist. Optionally, other hosts in the cluster can be discovered through this host. Cisco Intersight Workload Optimizer features are supported on this hypervisor.\n* `AppDynamics` - An AppDynamics controller running in a SaaS or on-prem datacenter. On-prem AppDynamics instance is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this controller.\n* `Dynatrace` - A Dynatrace Server instance running in a SaaS or on-prem datacenter. On-prem Dynatrace instance is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this server.\n* `NewRelic` - A NewRelic user account. The NewRelic instance monitors the application infrastructure. Cisco Intersight Workload Optimizer features are supported on this server.\n* `ServiceNow` - A cloud-based workflow automation platform that enables enterprise organizations to improve operational efficiencies by streamlining and automating routine work tasks.\n* `Umbrella` - Umbrella cloud target that discovers and monitors an organization. It discovers entities like Datacenters, Devices, Tunnels, Networks, etc.\n* `CloudFoundry` - An open source cloud platform on which developers can build, deploy, run and scale applications.\n* `MicrosoftAzureApplicationInsights` - A feature of Azure Monitor, is an extensible Application Performance Management service for developers and DevOps professionals to monitor their live applications.\n* `OpenStack` - An OpenStack target manages Virtual Machines, Physical Machines, Datacenters and Virtual Datacenters using different OpenStack services as administrative endpoints.\n* `MicrosoftSqlServer` - A Microsoft SQL database server that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this database.\n* `MySqlServer` - A MySQL database server that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this database.\n* `OracleDatabaseServer` - An Oracle database server that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this database.\n* `IBMWebSphereApplicationServer` - An IBM WebSphere Application server that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this application server.\n* `OracleWebLogicServer` - Oracle WebLogic Server is a unified and extensible platform for developing, deploying and running enterprise applications, such as Java, for on-premises and in the cloud. WebLogic Server offers a robust, mature, and scalable implementation of Java Enterprise Edition (EE) and Jakarta EE.\n* `ApacheTomcatServer` - An Apache Tomcat server that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this server.\n* `JavaVirtualMachine` - A JVM Application with JMX configured that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this application.\n* `RedHatJBossApplicationServer` - JBoss Application Server is an open-source, cross-platform Java application server developed by JBoss, a division of Red Hat Inc. It is an open-source implementation of Java 2 Enterprise Edition (J2EE) that is used for implementing Java applications and other Web-based applications and software.\n* `Kubernetes` - A Kubernetes cluster that runs containerized applications, with Kubernetes Collector installed. Cisco Intersight Workload Optimizer features are supported on Kubernetes cluster.\n* `AmazonWebService` - An Amazon Web Service cloud account. Cisco Intersight Workload Optimizer and Virtualization features are supported on this cloud.\n* `AmazonWebServiceBilling` - An Amazon Web Service cloud billing account used to retrieve billing information stored in S3 bucket. Cisco Intersight Workload Optimizer features are supported on this cloud.\n* `GoogleCloudPlatform` - A Google Cloud Platform service account with access to one or more projects. Cisco Intersight Workload Optimizer features are supported on this cloud.\n* `GoogleCloudPlatformBilling` - A Google Cloud Platform service account used to retrieve billing information from BigQuery. Cisco Intersight Workload Optimizer features are supported on this cloud.\n* `MicrosoftAzureServicePrincipal` - A Microsoft Azure Service Principal account with access to Azure subscriptions. Cisco Intersight Workload Optimizer features are supported on this cloud.\n* `MicrosoftAzureEnterpriseAgreement` - A Microsoft Azure Enterprise Agreement enrolment used to retrieve pricing and billing information. Cisco Intersight Workload Optimizer features are supported on this cloud.\n* `MicrosoftAzureBilling` - A Microsoft Azure Service Principal account with access to billing information. Cisco Intersight Workload Optimizer features are supported on this cloud.\n* `DellCompellent` - A Dell EMC SC Series (Compellent) storage system that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this device.\n* `HPE3Par` - A HPE 3PAR StoreServ system that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this device.\n* `RedHatEnterpriseVirtualization` - A Red Hat Enterprise Virtualization Hypervisor system that manages Virtual Machines.\n* `NutanixAcropolis` - A Nutanix Acropolis cluster that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this cluster.\n* `NutanixPrismCentral` - A Nutanix Prism Central cluster. Prism central is a virtual appliance for managing Nutanix clusters and services.\n* `HPEOneView` - A HPE OneView system that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this system.\n* `ServiceEngine` - Cisco Application Services Engine. Cisco Application Services Engine is a platform to deploy and manage applications.\n* `HitachiVirtualStoragePlatform` - A Hitachi Virtual Storage Platform (Hitachi VSP) that is managed using Cisco Intersight Assist.\n* `GenericTarget` - A generic third-party target supported only in Partner Integration Appliance. This target type is used for development purposes and will not be supported in production environment.\n* `IMCBlade` - A Cisco UCS blade server managed by Cisco Intersight.\n* `TerraformCloud` - A Terraform Cloud Business Tier account.\n* `TerraformAgent` - A Terraform Cloud Agent that will be deployed on Cisco Intersight Assist. The agent can be used to plan and apply Terraform runs from a Terraform Cloud workspace.\n* `CustomTarget` - CustomTarget is deprecated. Use HTTPEndpoint type to claim HTTP endpoints.\n* `AnsibleEndpoint` - An external endpoint that is added as a target which can be accessed through Ansible in Intersight Cloud Orchestrator automation workflows.\n* `HTTPEndpoint` - An HTTP endpoint that can be accessed in Intersight Orchestrator workflows directly or using Cisco Intersight Assist. Authentication Schemes supported are Basic and Bearer Token.\n* `SSHEndpoint` - An SSH endpoint that can be accessed in Intersight Orchestrator workflows using Cisco Intersight Assist.\n* `CiscoCatalyst` - A Cisco Catalyst networking switch device.\n* `PowerShellEndpoint` - A Windows operating system server on which PowerShell scripts can be executed using Cisco Intersight Assist.\n* `CiscoDNAC` - A Cisco Digital Network Architecture (DNA) Center appliance.\n* `CiscoFMC` - A Cisco Secure Firewall Management Center.\n* `ViptelaCloud` - ViptelaCloud is deprecated. Use CatalystSDWANManager type to claim Catalyst SDWAN Manager which can manage Catalyst SDWAN devices.\n* `CatalystSDWANManager` - A Cisco Catalyst SD-WAN Manager.\n* `MerakiCloud` - A Cisco Meraki Organization.\n* `CiscoISE` - A Cisco Identity Services Engine (ISE) target.", "type": "string", "enum": [ "", "APIC", "CAPIC", "DCNM", "UCSFI", "UCSFIISM", "IMC", "IMCM4", "IMCM5", "IMCRack", "UCSIOM", "UCSPCIeNODE", "UCSXFM", "HX", "UCSD", "UCSXECMC", "UCSXESecureRouter", "IntersightAppliance", "IntersightAssist", "PureStorageFlashArray", "PureStorageFlashBladeSystem", "NexusDevice", "ACISwitch", "NexusSwitch", "MDSSwitch", "MDSDevice", "UCSC885", "CAI845A", "UCSC890", "RedfishServer", "NetAppOntap", "NetAppActiveIqUnifiedManager", "EmcScaleIo", "EmcVmax", "EmcVplex", "EmcXtremIo", "VmwareVcenter", "MicrosoftHyperV", "AppDynamics", "Dynatrace", "NewRelic", "ServiceNow", "Umbrella", "CloudFoundry", "MicrosoftAzureApplicationInsights", "OpenStack", "MicrosoftSqlServer", "MySqlServer", "OracleDatabaseServer", "IBMWebSphereApplicationServer", "OracleWebLogicServer", "ApacheTomcatServer", "JavaVirtualMachine", "RedHatJBossApplicationServer", "Kubernetes", "AmazonWebService", "AmazonWebServiceBilling", "GoogleCloudPlatform", "GoogleCloudPlatformBilling", "MicrosoftAzureServicePrincipal", "MicrosoftAzureEnterpriseAgreement", "MicrosoftAzureBilling", "DellCompellent", "HPE3Par", "RedHatEnterpriseVirtualization", "NutanixAcropolis", "NutanixPrismCentral", "HPEOneView", "ServiceEngine", "HitachiVirtualStoragePlatform", "GenericTarget", "IMCBlade", "TerraformCloud", "TerraformAgent", "CustomTarget", "AnsibleEndpoint", "HTTPEndpoint", "SSHEndpoint", "CiscoCatalyst", "PowerShellEndpoint", "CiscoDNAC", "CiscoFMC", "ViptelaCloud", "CatalystSDWANManager", "MerakiCloud", "CiscoISE" ], "default": "", "x-omitempty": true }, "Vendor": { "description": "The vendor of the managed target.", "type": "string", "readOnly": true, "x-omitempty": true }, "Account": { "$ref": "#/components/schemas/iam.Account.Relationship", "description": "A reference to a iamAccount resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "AssignedLocation": { "$ref": "#/components/schemas/asset.GeoLocation.Relationship", "description": "A reference to a assetGeoLocation resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "Assist": { "$ref": "#/components/schemas/asset.Target.Relationship", "description": "A reference to a assetTarget resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true }, "CustomPermissionResources": { "description": "An array of relationships to moBaseMo resources.", "type": "array", "items": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo.Relationship" }, "nullable": true, "readOnly": true }, "RegisteredDevice": { "$ref": "#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Reservation": { "$ref": "#/components/schemas/resource.Reservation.Relationship", "description": "A reference to a resourceReservation resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true }, "TrustPoint": { "$ref": "#/components/schemas/iam.TrustPoint.Relationship", "description": "A reference to a iamTrustPoint resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "WorkflowInfo": { "$ref": "intersight-orchestrator-v3-1.0.11-20260807064027971.json#/components/schemas/workflow.WorkflowInfo.Relationship", "description": "A reference to a workflowWorkflowInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "asset.Target.List": { "title": "List of 'asset.Target' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'asset.Target' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'asset.Target' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/asset.Target" }, "nullable": true } } } ] }, "asset.TargetKey": { "title": "Asset:Target Key", "description": "Holds a key and signature that can be sent in a device registration request to associate it with a target.", "x-allOf-name": "asset.TargetKey", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.TargetKey', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.TargetKey" ], "default": "asset.TargetKey", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.TargetKey" ], "default": "asset.TargetKey", "x-enum-as-string": true }, "IsPrivateKeySet": { "description": "Indicates whether the value of the 'privateKey' property has been set.", "type": "boolean", "default": false, "readOnly": true, "x-omitempty": true } } } ] }, "asset.TargetSignature": { "title": "Asset:Target Signature", "description": "A signature generated by Intersight on creation of a target.", "x-allOf-name": "asset.TargetSignature", "allOf": [ { "$ref": "#/components/schemas/asset.ClaimSignature" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.TargetSignature', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.TargetSignature" ], "default": "asset.TargetSignature", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.TargetSignature" ], "default": "asset.TargetSignature", "x-enum-as-string": true }, "TargetId": { "description": "The moid of the associated target.", "type": "string", "x-omitempty": true } } } ] }, "asset.TargetStatusDetails": { "title": "Asset:Target Status Details", "description": "TargetStatusDetails provides per component detailed status information. This information is normalized into a single status value which is presented to users. Alarms may be raised based on the status details.", "x-allOf-name": "asset.TargetStatusDetails", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" } ] }, "asset.TerraformIntegrationService": { "title": "Asset:Terraform Integration Service", "description": "TerraformIntegrationService provides the necessary configuration details to enable Intersight Cloud Region on the selected Terraform Cloud.", "x-allOf-name": "asset.TerraformIntegrationService", "allOf": [ { "$ref": "#/components/schemas/asset.Service" } ] }, "asset.TerraformIntegrationTerraformAgentOptions": { "title": "Asset:Terraform Integration Terraform Agent Options", "description": "Cloud options for Terrraform Agent platform type.", "x-allOf-name": "asset.TerraformIntegrationTerraformAgentOptions", "allOf": [ { "$ref": "#/components/schemas/asset.ServiceOptions" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.TerraformIntegrationTerraformAgentOptions', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.TerraformIntegrationTerraformAgentOptions" ], "default": "asset.TerraformIntegrationTerraformAgentOptions", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.TerraformIntegrationTerraformAgentOptions" ], "default": "asset.TerraformIntegrationTerraformAgentOptions", "x-enum-as-string": true }, "ManagedHosts": { "type": "array", "items": { "description": "Managed hosts collection for Terraform Agent platform type.", "type": "string", "x-omitempty": true }, "nullable": true }, "TerraformAgentPoolName": { "description": "Agent pool name for Terraform Agent platform type.", "type": "string", "x-omitempty": true }, "TerraformOrganization": { "description": "Organization for Terraform Agent platform type.", "type": "string", "x-omitempty": true } } } ] }, "asset.TerraformIntegrationTerraformCloudOptions": { "title": "Asset:Terraform Integration Terraform Cloud Options", "description": "Cloud options for Terraform Cloud platform type.", "x-allOf-name": "asset.TerraformIntegrationTerraformCloudOptions", "allOf": [ { "$ref": "#/components/schemas/asset.ServiceOptions" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.TerraformIntegrationTerraformCloudOptions', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.TerraformIntegrationTerraformCloudOptions" ], "default": "asset.TerraformIntegrationTerraformCloudOptions", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.TerraformIntegrationTerraformCloudOptions" ], "default": "asset.TerraformIntegrationTerraformCloudOptions", "x-enum-as-string": true }, "DefaultManagedHosts": { "type": "array", "items": { "description": "List of default IP addresses, Hostnames or subnets of endpoints that will be configured by the Terraform Agent.", "type": "string", "x-omitempty": true }, "nullable": true }, "DefaultTerraformOrganization": { "description": "Default organization for Terraform Cloud platform type.", "type": "string", "x-omitempty": true } } } ] }, "asset.Token": { "title": "Asset:Token", "description": "A token that is generated by an Intersight user to claim a device. The token is used by the device administrator to configure and claim the device connector to the users Intersight account.", "x-allOf-name": "asset.Token", "allOf": [ { "$ref": "#/components/schemas/asset.ClaimSignature" } ] }, "asset.UsernamePasswordCredential": { "title": "Asset:Username Password Credential", "description": "A credential which performs authentication based on a username and password.", "x-allOf-name": "asset.UsernamePasswordCredential", "allOf": [ { "$ref": "#/components/schemas/asset.Credential" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.UsernamePasswordCredential', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.UsernamePasswordCredential" ], "default": "asset.UsernamePasswordCredential", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.UsernamePasswordCredential" ], "default": "asset.UsernamePasswordCredential", "x-enum-as-string": true }, "IsPasswordSet": { "description": "Indicates whether the value of the 'password' property has been set.", "type": "boolean", "default": false, "readOnly": true, "x-omitempty": true }, "Password": { "description": "The password used to authenticate with a managed target.", "type": "string", "writeOnly": true, "x-omitempty": true }, "Username": { "description": "The username used to authenticate with a managed target.", "type": "string", "x-omitempty": true } } } ] }, "asset.VirtualizationAmazonWebServiceOptions": { "title": "Asset:Virtualization Amazon Web Service Options", "description": "Captures Virtualization Service configuration specific to AWS.", "x-allOf-name": "asset.VirtualizationAmazonWebServiceOptions", "allOf": [ { "$ref": "#/components/schemas/asset.VirtualizationCloudOptions" } ] }, "asset.VirtualizationCloudOptions": { "title": "Asset:Virtualization Cloud Options", "description": "Captures Virtualization service configuration.", "x-allOf-name": "asset.VirtualizationCloudOptions", "allOf": [ { "$ref": "#/components/schemas/asset.ServiceOptions" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.VirtualizationCloudOptions', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "asset.VirtualizationAmazonWebServiceOptions" ], "default": "asset.VirtualizationAmazonWebServiceOptions", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "asset.VirtualizationAmazonWebServiceOptions" ], "default": "asset.VirtualizationAmazonWebServiceOptions", "x-enum-as-string": true }, "ManagedRegions": { "type": "array", "items": { "description": "List of regions managed by this target. Needs to have reference to cloud.Regions.", "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef", "x-omitempty": true }, "minItems": 1, "nullable": true }, "RegionGroup": { "description": "The name of the region group to which the managedRegions belong. Populated from the group property in cloud.Regions.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "asset.VirtualizationService": { "title": "Asset:Virtualization Service", "description": "The necessary configuration details to enable Intersight Virtualization features on the selected managed target.", "x-allOf-name": "asset.VirtualizationService", "allOf": [ { "$ref": "#/components/schemas/asset.Service" } ] }, "asset.VmHost": { "title": "Asset:Vm Host", "description": "Type for saving VM host details.", "x-allOf-name": "asset.VmHost", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.VmHost', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.VmHost" ], "default": "asset.VmHost", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.VmHost" ], "default": "asset.VmHost", "x-enum-as-string": true }, "AccountMoid": { "description": "Reference to virtualization target account ID.", "type": "string", "readOnly": true, "x-omitempty": true }, "ClusterIdentity": { "description": "Reference to virtualization cluster identity.", "type": "string", "readOnly": true, "x-omitempty": true }, "ClusterMoid": { "description": "Reference to virtualization cluster ID.", "type": "string", "readOnly": true, "x-omitempty": true }, "ClusterName": { "description": "Reference to virtualization cluster name.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "asset.WorkloadOptimizerAmazonWebServicesBillingOptions": { "title": "Asset:Workload Optimizer Amazon Web Services Billing Options", "description": "Captures configuration specific to the Amazon web service (AWS) target for Workload Optimizer service. Following explanation is for S3 parameters for configuring billing and costs reports. S3 bucket parameters help in programmatically gaining access to the S3 bucket for billing and cost management. The user must first have Amazon web service billing data being generated for their Amazon web service account. Since this is not enabled in Amazon web service by default, follow the instructions from Amazon web service to generate the bill hourly. Use \"Daily\" time unit frequency on which report data are measured and displayed. [link](https://aws.amazon.com/blogs/aws/new-programmatic-access-to-aws-billing-data/) [link](https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/billing-getting-started.html).", "x-allOf-name": "asset.WorkloadOptimizerAmazonWebServicesBillingOptions", "allOf": [ { "$ref": "#/components/schemas/asset.ServiceOptions" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.WorkloadOptimizerAmazonWebServicesBillingOptions', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.WorkloadOptimizerAmazonWebServicesBillingOptions" ], "default": "asset.WorkloadOptimizerAmazonWebServicesBillingOptions", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.WorkloadOptimizerAmazonWebServicesBillingOptions" ], "default": "asset.WorkloadOptimizerAmazonWebServicesBillingOptions", "x-enum-as-string": true }, "CostAndUsageReportBucket": { "description": "Name of S3 bucket that contains the Amazon web service Cost and Usage report to get cloud service spend.", "type": "string", "x-omitempty": true }, "CostAndUsageReportPath": { "description": "Report path prefix for the Amazon web service cost and usage report to get cloud service spend.", "type": "string", "x-omitempty": true }, "CostAndUsageReportRegion": { "description": "Region for S3 bucket that contains the Amazon web service Cost and Usage report to get cloud service spend.", "type": "string", "x-omitempty": true } } } ] }, "asset.WorkloadOptimizerDynatraceOptions": { "title": "Asset:Workload Optimizer Dynatrace Options", "description": "Captures configuration specific to the Dynatrace target for the Workload Optimizer service.", "x-allOf-name": "asset.WorkloadOptimizerDynatraceOptions", "allOf": [ { "$ref": "#/components/schemas/asset.ServiceOptions" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.WorkloadOptimizerDynatraceOptions', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.WorkloadOptimizerDynatraceOptions" ], "default": "asset.WorkloadOptimizerDynatraceOptions", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.WorkloadOptimizerDynatraceOptions" ], "default": "asset.WorkloadOptimizerDynatraceOptions", "x-enum-as-string": true }, "CollectTagInfo": { "description": "Collect tag information from Dynatrace.", "type": "boolean", "default": false, "x-omitempty": true }, "CollectVmMetrics": { "description": "Overwrite Hypervisor or Cloud Provider Virtual Machine metrics with data from the target.", "type": "boolean", "x-omitempty": true }, "EnvironmentId": { "description": "Each environment monitored with Dynatrace is identified with a unique character string\u2014the environment ID. The Dynatrace API relies heavily on environment IDs to ensure that it pulls monitoring data from and pushes relevant external events to the correct Dynatrace environments.", "type": "string", "x-omitempty": true } } } ] }, "asset.WorkloadOptimizerGoogleCloudPlatformBillingOptions": { "title": "Asset:Workload Optimizer Google Cloud Platform Billing Options", "description": "Captures configuration specific to the Google Cloud Platform (GCP) Billing target for Workload Optimizer service.", "x-allOf-name": "asset.WorkloadOptimizerGoogleCloudPlatformBillingOptions", "allOf": [ { "$ref": "#/components/schemas/asset.ServiceOptions" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.WorkloadOptimizerGoogleCloudPlatformBillingOptions', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.WorkloadOptimizerGoogleCloudPlatformBillingOptions" ], "default": "asset.WorkloadOptimizerGoogleCloudPlatformBillingOptions", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.WorkloadOptimizerGoogleCloudPlatformBillingOptions" ], "default": "asset.WorkloadOptimizerGoogleCloudPlatformBillingOptions", "x-enum-as-string": true }, "BillingAccountId": { "description": "The Google Cloud Platform (GCP) Billing Account ID.", "type": "string", "x-omitempty": true }, "CostExportDataSetName": { "description": "Name of Google BigQuery Cost Export Data Set which is the dataset for the billed cost export.", "type": "string", "x-omitempty": true }, "CostExportTableName": { "description": "Google BigQuery Cost Export Table Name. This table will store the exported data from the Cost Export.", "type": "string", "x-omitempty": true }, "PricingExportDataSetName": { "description": "Name of the BigQuery Pricing Export Data Set which is the dataset for negotiated pricing.", "type": "string", "x-omitempty": true }, "PricingExportTableName": { "description": "The Google BigQuery Pricing Export Table Name field is auto-populated with the table used in BigQuery, cloud_pricing_export. There is no need to modify this name, unless you use a different table for negotiated pricing. The Default name is \"cloud_pricing_export\".", "type": "string", "x-omitempty": true }, "ProjectId": { "description": "The unique ID assigned to the project containing the cost and pricing exports. If the exports are in separate projects, multiple billing targets will be necessary.", "type": "string", "x-omitempty": true }, "ResourceLevelCostEnabled": { "description": "This flag will enable querying of detailed usage cost with resource level information included. If not enabled, cost export data will be queried, if dataset and table name are provided.", "type": "boolean", "x-omitempty": true } } } ] }, "asset.WorkloadOptimizerHypervOptions": { "title": "Asset:Workload Optimizer Hyperv Options", "description": "Captures configuration specific to the Hyper-V target for the Workload Optimizer service.", "x-allOf-name": "asset.WorkloadOptimizerHypervOptions", "allOf": [ { "$ref": "#/components/schemas/asset.ServiceOptions" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.WorkloadOptimizerHypervOptions', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.WorkloadOptimizerHypervOptions" ], "default": "asset.WorkloadOptimizerHypervOptions", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.WorkloadOptimizerHypervOptions" ], "default": "asset.WorkloadOptimizerHypervOptions", "x-enum-as-string": true }, "DiscoverHostCluster": { "description": "When enabled, all Hyper-V hosts in the same cluster of specified Hyper-V host target will be discovered Each server must still be configured to allow remote management (for example, configuring WinRM using a GPO).", "type": "boolean", "x-omitempty": true }, "FullDomainName": { "description": "Fully qualified domain name of the Hyper-V target. It is used to get the name of the Hyper-V cluster node and do Active Directory authentication process through Kerberos scheme.", "type": "string", "x-omitempty": true } } } ] }, "asset.WorkloadOptimizerMicrosoftAzureApplicationInsightsOptions": { "title": "Asset:Workload Optimizer Microsoft Azure Application Insights Options", "description": "Captures configuration specific to the Microsoft Azure Application Intersight target for the Workload Optimizer service.", "x-allOf-name": "asset.WorkloadOptimizerMicrosoftAzureApplicationInsightsOptions", "allOf": [ { "$ref": "#/components/schemas/asset.ServiceOptions" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.WorkloadOptimizerMicrosoftAzureApplicationInsightsOptions', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.WorkloadOptimizerMicrosoftAzureApplicationInsightsOptions" ], "default": "asset.WorkloadOptimizerMicrosoftAzureApplicationInsightsOptions", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.WorkloadOptimizerMicrosoftAzureApplicationInsightsOptions" ], "default": "asset.WorkloadOptimizerMicrosoftAzureApplicationInsightsOptions", "x-enum-as-string": true }, "EnrollmentNumber": { "description": "Enrollment number of this Azure account.", "type": "string", "x-omitempty": true }, "OfferId": { "description": "The offer ID of this account. Default value is \"MS-AZR-0003P\", a pay-as-you-go subscription lets you pay for the services and resources that you use on a monthly basis.", "type": "string", "x-omitempty": true }, "SubscriptionId": { "description": "The Azure Subscription ID.", "type": "string", "x-omitempty": true }, "TenantId": { "description": "Tenant ID associated with Azure Account.", "type": "string", "x-omitempty": true } } } ] }, "asset.WorkloadOptimizerMicrosoftAzureBillingOptions": { "title": "Asset:Workload Optimizer Microsoft Azure Billing Options", "description": "Captures configuration specific to the Microsoft Azure Billing target for the Workload Optimizer service.", "x-allOf-name": "asset.WorkloadOptimizerMicrosoftAzureBillingOptions", "allOf": [ { "$ref": "#/components/schemas/asset.ServiceOptions" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.WorkloadOptimizerMicrosoftAzureBillingOptions', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.WorkloadOptimizerMicrosoftAzureBillingOptions" ], "default": "asset.WorkloadOptimizerMicrosoftAzureBillingOptions", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.WorkloadOptimizerMicrosoftAzureBillingOptions" ], "default": "asset.WorkloadOptimizerMicrosoftAzureBillingOptions", "x-enum-as-string": true }, "BillingAccountId": { "description": "The Microsoft Azure Billing Account ID.", "type": "string", "x-omitempty": true }, "CostExportName": { "description": "Name of the Cost Export Data that exports cost management data.", "type": "string", "x-omitempty": true }, "TenantId": { "description": "Id of the tenant used while authenticating the managed target.", "type": "string", "x-omitempty": true }, "UseCostExport": { "description": "For larger topologies, use cost export to fetch billed cost data.", "type": "boolean", "default": false, "x-omitempty": true } } } ] }, "asset.WorkloadOptimizerMicrosoftAzureEnterpriseAgreementOptions": { "title": "Asset:Workload Optimizer Microsoft Azure Enterprise Agreement Options", "description": "Captures configuration specific to the Microsoft Azure Enterprise Agreement target for the Workload Optimizer service.", "x-allOf-name": "asset.WorkloadOptimizerMicrosoftAzureEnterpriseAgreementOptions", "allOf": [ { "$ref": "#/components/schemas/asset.ServiceOptions" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.WorkloadOptimizerMicrosoftAzureEnterpriseAgreementOptions', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.WorkloadOptimizerMicrosoftAzureEnterpriseAgreementOptions" ], "default": "asset.WorkloadOptimizerMicrosoftAzureEnterpriseAgreementOptions", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.WorkloadOptimizerMicrosoftAzureEnterpriseAgreementOptions" ], "default": "asset.WorkloadOptimizerMicrosoftAzureEnterpriseAgreementOptions", "x-enum-as-string": true }, "EnrollmentNumber": { "description": "Enrollment number for Azure EA.", "type": "string", "x-omitempty": true } } } ] }, "asset.WorkloadOptimizerMicrosoftAzureServicePrincipalOptions": { "title": "Asset:Workload Optimizer Microsoft Azure Service Principal Options", "description": "Captures configuration specific to the Microsoft Azure Service Principal target for the Workload Optimizer service.", "x-allOf-name": "asset.WorkloadOptimizerMicrosoftAzureServicePrincipalOptions", "allOf": [ { "$ref": "#/components/schemas/asset.ServiceOptions" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.WorkloadOptimizerMicrosoftAzureServicePrincipalOptions', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.WorkloadOptimizerMicrosoftAzureServicePrincipalOptions" ], "default": "asset.WorkloadOptimizerMicrosoftAzureServicePrincipalOptions", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.WorkloadOptimizerMicrosoftAzureServicePrincipalOptions" ], "default": "asset.WorkloadOptimizerMicrosoftAzureServicePrincipalOptions", "x-enum-as-string": true }, "AzureCloudType": { "description": "Azure has different endpoints for managing Germany subscriptions. Azure cloud type helps in differentiating between regular subscriptions and Germany subscriptions to manage the Azure services for workload optimization. Documentation for germany cloud [link](https://docs.microsoft.com/en-us/azure/germany/germany-manage-subscriptions).\n* `Global` - Global cloud type for Azure subscription.\n* `Germany` - Germany cloud type for Azure subscription.", "type": "string", "enum": [ "Global", "Germany" ], "default": "Global", "x-omitempty": true }, "TenantId": { "description": "ID of the tenant used while authenticating the managed target.", "type": "string", "x-omitempty": true } } } ] }, "asset.WorkloadOptimizerMicrosoftSqlServerOptions": { "title": "Asset:Workload Optimizer Microsoft Sql Server Options", "description": "Captures configuration specific to the Microsoft SQL Server target for the Workload Optimizer service.", "x-allOf-name": "asset.WorkloadOptimizerMicrosoftSqlServerOptions", "allOf": [ { "$ref": "#/components/schemas/asset.ServiceOptions" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.WorkloadOptimizerMicrosoftSqlServerOptions', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.WorkloadOptimizerMicrosoftSqlServerOptions" ], "default": "asset.WorkloadOptimizerMicrosoftSqlServerOptions", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.WorkloadOptimizerMicrosoftSqlServerOptions" ], "default": "asset.WorkloadOptimizerMicrosoftSqlServerOptions", "x-enum-as-string": true }, "BrowserServicePort": { "description": "Port that Microsoft SQL Server Browser listens for incoming requests for SQL Server resources and provides information about SQL Server instances that are installed on the computer. When this port is specified, Database will be communicated through the Browser Service with this port instead of default SQLServer port.", "type": "integer", "format": "int64", "minimum": 0, "maximum": 65535, "x-omitempty": true }, "DiscoveryPath": { "description": "Discovery path to define if its scope target entities or hostname or IP address.", "type": "string", "default": "targetEntities", "x-omitempty": true }, "FullDomainName": { "description": "Active Directory domain, if required for this account.", "type": "string", "x-omitempty": true } } } ] }, "asset.WorkloadOptimizerNewRelicOptions": { "title": "Asset:Workload Optimizer New Relic Options", "description": "Captures configuration specific to the NewRelic target for the Workload Optimizer service.", "x-allOf-name": "asset.WorkloadOptimizerNewRelicOptions", "allOf": [ { "$ref": "#/components/schemas/asset.ServiceOptions" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.WorkloadOptimizerNewRelicOptions', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.WorkloadOptimizerNewRelicOptions" ], "default": "asset.WorkloadOptimizerNewRelicOptions", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.WorkloadOptimizerNewRelicOptions" ], "default": "asset.WorkloadOptimizerNewRelicOptions", "x-enum-as-string": true }, "AccountId": { "description": "Your NewRelic account id.", "type": "string", "x-omitempty": true }, "CollectTagInfo": { "description": "Collect tag information from NewRelic.", "type": "boolean", "default": false, "x-omitempty": true }, "CollectVmMetrics": { "description": "Overwrite Hypervisor or Cloud Provider Virtual Machine metrics with data from the target.", "type": "boolean", "x-omitempty": true }, "Region": { "description": "The region associated with the NewRelic account.\n* `US` - The United States (US) region.\n* `EU` - The European Union (EU) region.", "type": "string", "enum": [ "US", "EU" ], "default": "US", "x-omitempty": true } } } ] }, "asset.WorkloadOptimizerOpenStackOptions": { "title": "Asset:Workload Optimizer Open Stack Options", "description": "Captures configuration specific to the OpenStack target for the Workload Optimizer service.", "x-allOf-name": "asset.WorkloadOptimizerOpenStackOptions", "allOf": [ { "$ref": "#/components/schemas/asset.ServiceOptions" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.WorkloadOptimizerOpenStackOptions', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.WorkloadOptimizerOpenStackOptions" ], "default": "asset.WorkloadOptimizerOpenStackOptions", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.WorkloadOptimizerOpenStackOptions" ], "default": "asset.WorkloadOptimizerOpenStackOptions", "x-enum-as-string": true }, "Domain": { "description": "OpenStack Identity Service (keystone) domain name. Domain is an additional namespaces you can create in keystone to partition users, groups, and projects. Default domain name value is \"Default\".", "type": "string", "x-omitempty": true }, "Tenant": { "description": "The name of tenant which has assigned administrator role this OpenStack target user is in. A tenant or project is referred to as a group of users of OpenStack. Each tenant can be assigned a role which gives all its member users their rights and privileges to perform a specific set of operations.", "type": "string", "x-omitempty": true } } } ] }, "asset.WorkloadOptimizerOracleDatabaseServerOptions": { "title": "Asset:Workload Optimizer Oracle Database Server Options", "description": "Captures configuration specific to the Oracle Database Server target for the Workload Optimizer service.", "x-allOf-name": "asset.WorkloadOptimizerOracleDatabaseServerOptions", "allOf": [ { "$ref": "#/components/schemas/asset.ServiceOptions" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.WorkloadOptimizerOracleDatabaseServerOptions', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.WorkloadOptimizerOracleDatabaseServerOptions" ], "default": "asset.WorkloadOptimizerOracleDatabaseServerOptions", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.WorkloadOptimizerOracleDatabaseServerOptions" ], "default": "asset.WorkloadOptimizerOracleDatabaseServerOptions", "x-enum-as-string": true }, "DatabaseId": { "description": "A unique name for an Oracle database instance on a specific host.", "type": "string", "x-omitempty": true } } } ] }, "asset.WorkloadOptimizerRedHatOpenStackOptions": { "title": "Asset:Workload Optimizer Red Hat Open Stack Options", "description": "Captures configuration specific to the RedHat OpenStack target for the Workload Optimizer service.", "x-allOf-name": "asset.WorkloadOptimizerRedHatOpenStackOptions", "allOf": [ { "$ref": "#/components/schemas/asset.ServiceOptions" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.WorkloadOptimizerRedHatOpenStackOptions', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.WorkloadOptimizerRedHatOpenStackOptions" ], "default": "asset.WorkloadOptimizerRedHatOpenStackOptions", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.WorkloadOptimizerRedHatOpenStackOptions" ], "default": "asset.WorkloadOptimizerRedHatOpenStackOptions", "x-enum-as-string": true }, "Domain": { "description": "RedHat OpenStack Identity Service (keystone) domain name. Domain is an additional namespaces you can create in keystone to partition users, groups, and projects. Default domain name value is \"Default\".", "type": "string", "x-omitempty": true }, "Tenant": { "description": "The name of tenant which has assigned administrator role this RedHat OpenStack target user is in. A tenant or project is referred to as a group of users of RedHat OpenStack. Each tenant can be assigned a role which gives all its member users their rights and privileges to perform a specific set of operations.", "type": "string", "x-omitempty": true } } } ] }, "asset.WorkloadOptimizerService": { "title": "Asset:Workload Optimizer Service", "description": "WorkloadOptimizerService provides the necessary configuration details to enable Intersight Workflow Optimizer on the selected managed target. Subject to licensing.", "x-allOf-name": "asset.WorkloadOptimizerService", "allOf": [ { "$ref": "#/components/schemas/asset.Service" } ] }, "asset.WorkloadOptimizerVmwareVcenterOptions": { "title": "Asset:Workload Optimizer Vmware Vcenter Options", "description": "Captures configuration specific to the VMware Vcenter target for the Workload Optimizer service.", "x-allOf-name": "asset.WorkloadOptimizerVmwareVcenterOptions", "allOf": [ { "$ref": "#/components/schemas/asset.ServiceOptions" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.WorkloadOptimizerVmwareVcenterOptions', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.WorkloadOptimizerVmwareVcenterOptions" ], "default": "asset.WorkloadOptimizerVmwareVcenterOptions", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.WorkloadOptimizerVmwareVcenterOptions" ], "default": "asset.WorkloadOptimizerVmwareVcenterOptions", "x-enum-as-string": true }, "DatastoreBrowsingEnabled": { "description": "DatastoreBrowsingEnabled controls whether Workload Optimizer scans vCenter datastores to identify files which are not used and can be deleted to reclaim space and improve actual disk utilization. For example orphaned VMDK files.", "type": "boolean", "x-omitempty": true }, "GuestMetricsEnabled": { "description": "Enable retrieval of advanced memory metrics. Only supported on vCenter Server version 6.5U3 or later. Guest VMs must run VMWare Tools 10.3.2 Build 10338 or later.", "type": "boolean", "x-omitempty": true } } } ] }, "catalystsdwan.ConfigGroup.Response": { "description": "The response body of a HTTP GET request for the 'catalystsdwan.ConfigGroup' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'catalystsdwan.ConfigGroup' resources.", "x-one-of-name": "catalystsdwan.ConfigGroup.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/catalystsdwan.ConfigGroup.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "catalystsdwan.ConfigGroup": { "title": "Catalystsdwan:Config Group", "description": "Details for the Catalyst SDWAN config groups.", "x-allOf-name": "catalystsdwan.ConfigGroup", "allOf": [ { "$ref": "#/components/schemas/catalystsdwan.InventoryEntity" }, { "type": "object", "description": "Definition of the list of properties defined in 'catalystsdwan.ConfigGroup', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "catalystsdwan.ConfigGroup" ], "default": "catalystsdwan.ConfigGroup", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "catalystsdwan.ConfigGroup" ], "default": "catalystsdwan.ConfigGroup", "x-enum-as-string": true }, "ConfigGroupId": { "description": "UUID for the Catalyst SDWAN config group.", "type": "string", "x-omitempty": true }, "Devices": { "type": "array", "items": { "description": "The Catalyst SDWAN config group devices.", "type": "string", "x-omitempty": true }, "nullable": true }, "Name": { "description": "The Catalyst SDWAN config group name.", "type": "string", "x-omitempty": true }, "NumberOfDevices": { "description": "The Catalyst SDWAN config group number of devices.", "type": "integer", "format": "int64", "x-omitempty": true }, "Solution": { "description": "The Catalyst SDWAN config group solution.", "type": "string", "x-omitempty": true } } } ] }, "catalystsdwan.ConfigGroup.List": { "title": "List of 'catalystsdwan.ConfigGroup' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'catalystsdwan.ConfigGroup' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'catalystsdwan.ConfigGroup' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/catalystsdwan.ConfigGroup" }, "nullable": true } } } ] }, "catalystsdwan.Interface.Response": { "description": "The response body of a HTTP GET request for the 'catalystsdwan.Interface' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'catalystsdwan.Interface' resources.", "x-one-of-name": "catalystsdwan.Interface.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/catalystsdwan.Interface.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "catalystsdwan.Interface": { "title": "Catalystsdwan:Interface", "description": "Details for the WAN Edge Device L3 interfaces (Portchannel, sub-interfaces, tunnels, SVIs, Routed ports).", "x-allOf-name": "catalystsdwan.Interface", "allOf": [ { "$ref": "#/components/schemas/catalystsdwan.InventoryEntity" }, { "type": "object", "description": "Definition of the list of properties defined in 'catalystsdwan.Interface', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "catalystsdwan.Interface" ], "default": "catalystsdwan.Interface", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "catalystsdwan.Interface" ], "default": "catalystsdwan.Interface", "x-enum-as-string": true }, "AdminState": { "description": "The administrative state of the WAN Edge Device interface.\n* `Unknown` - Administrative state is unknown.\n* `Up` - Administrative state is up.\n* `Down` - Administrative state is down.", "type": "string", "enum": [ "Unknown", "Up", "Down" ], "default": "Unknown", "readOnly": true, "x-omitempty": true }, "Dn": { "description": "The distinguished name of the interface.", "type": "string", "readOnly": true, "x-omitempty": true }, "InterfaceName": { "description": "The name of the interface on the WAN Edge Device.", "type": "string", "readOnly": true, "x-omitempty": true }, "InterfaceType": { "description": "The type of the interface (Portchannel, Sub-interfaces, tunnels, SVIs, Routed ports).\n* `Unknown` - Interface type is unknown.\n* `Loopback` - Interface type is loopback.\n* `Port Channel` - Interface type is port channel.\n* `Sub-Interface` - Interface type is sub-interface.\n* `Tunnel` - Interface type is tunnel.\n* `SVI` - Interface type is SVI (Switched Virtual Interface).\n* `Routed Port` - Interface type is routed port.", "type": "string", "enum": [ "Unknown", "Loopback", "Port Channel", "Sub-Interface", "Tunnel", "SVI", "Routed Port" ], "default": "Unknown", "readOnly": true, "x-omitempty": true }, "IpAddress": { "description": "The IP address assigned to the WAN Edge Device interface.", "type": "string", "readOnly": true, "x-omitempty": true }, "IsNativeVlan": { "description": "Indicates whether the sub-interface's VLAN is configured as a native VLAN.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "LocalSystemIp": { "description": "The local System IP address of the WAN Edge Device configured on the device.", "type": "string", "readOnly": true, "x-omitempty": true }, "MacAddress": { "description": "The MAC address of the interface.", "type": "string", "readOnly": true, "x-omitempty": true }, "OperState": { "description": "The operational state of the WAN Edge Device interface.\n* `Unknown` - Operational state of physical port or port channel or interface is unknown.\n* `Up` - Operational state of physical port or port channel or interface is up.\n* `Down` - Operational state of physical port or port channel or interface is down.", "type": "string", "enum": [ "Unknown", "Up", "Down" ], "default": "Unknown", "readOnly": true, "x-omitempty": true }, "Subnet": { "description": "The subnet configured on the WAN Edge Device interface.", "type": "string", "readOnly": true, "x-omitempty": true }, "SystemIp": { "description": "The internal system IP of the WAN Edge Device assigned by Catalyst SD-WAN Manager for internal communication.", "type": "string", "readOnly": true, "x-omitempty": true }, "Uuid": { "description": "The UUID of the WAN Edge Device to which this interface belongs.", "type": "string", "readOnly": true, "x-omitempty": true }, "VlanId": { "description": "The VLAN ID configured on the sub-interface.", "type": "integer", "format": "int64", "default": 1, "readOnly": true, "x-omitempty": true }, "VpnId": { "description": "The VPN ID associated with this interface.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "WanEdgeDevice": { "$ref": "#/components/schemas/catalystsdwan.WanEdgeDevice.Relationship", "description": "A reference to a catalystsdwanWanEdgeDevice resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "catalystsdwan.Interface.List": { "title": "List of 'catalystsdwan.Interface' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'catalystsdwan.Interface' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'catalystsdwan.Interface' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/catalystsdwan.Interface" }, "nullable": true } } } ] }, "catalystsdwan.InventoryEntity": { "title": "Catalystsdwan:Inventory Entity", "description": "Base object type for all Catalyst SDWAN WAN Edge inventory items.", "x-allOf-name": "catalystsdwan.InventoryEntity", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'catalystsdwan.InventoryEntity', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "catalystsdwan.ConfigGroup", "catalystsdwan.Interface", "catalystsdwan.PhysicalPort", "catalystsdwan.PolicyGroup", "catalystsdwan.PortChannel", "catalystsdwan.Vlan" ], "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "catalystsdwan.ConfigGroup", "catalystsdwan.Interface", "catalystsdwan.PhysicalPort", "catalystsdwan.PolicyGroup", "catalystsdwan.PortChannel", "catalystsdwan.Vlan" ], "x-enum-as-string": true }, "RegisteredDevice": { "$ref": "#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "catalystsdwan.PhysicalPort.Response": { "description": "The response body of a HTTP GET request for the 'catalystsdwan.PhysicalPort' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'catalystsdwan.PhysicalPort' resources.", "x-one-of-name": "catalystsdwan.PhysicalPort.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/catalystsdwan.PhysicalPort.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "catalystsdwan.PhysicalPort": { "title": "Catalystsdwan:Physical Port", "description": "Physical ports belonging to a WAN Edge Device.", "x-allOf-name": "catalystsdwan.PhysicalPort", "allOf": [ { "$ref": "#/components/schemas/catalystsdwan.InventoryEntity" }, { "type": "object", "description": "Definition of the list of properties defined in 'catalystsdwan.PhysicalPort', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "catalystsdwan.PhysicalPort" ], "default": "catalystsdwan.PhysicalPort", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "catalystsdwan.PhysicalPort" ], "default": "catalystsdwan.PhysicalPort", "x-enum-as-string": true }, "AdminSpeed": { "description": "Admin speed of the physical port.", "type": "string", "readOnly": true, "x-omitempty": true }, "AdminState": { "description": "Administrative state of the physical port.\n* `Unknown` - Administrative state is unknown.\n* `Up` - Administrative state is up.\n* `Down` - Administrative state is down.", "type": "string", "enum": [ "Unknown", "Up", "Down" ], "default": "Unknown", "readOnly": true, "x-omitempty": true }, "AllowedVlanIds": { "description": "List of configured allowed VLAN IDs.", "type": "string", "readOnly": true, "x-omitempty": true }, "AutoNegotiation": { "description": "Indicates if auto-negotiation is enabled.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "DefaultVlanId": { "description": "Default or Native VLAN configured on the port.", "type": "integer", "format": "int64", "default": 1, "readOnly": true, "x-omitempty": true }, "Dn": { "description": "The distinguished name of the physical port.", "type": "string", "readOnly": true, "x-omitempty": true }, "FecEnabled": { "description": "Indicates if FEC is enabled on the physical port.", "type": "boolean", "default": false, "readOnly": true, "x-omitempty": true }, "LocalSystemIp": { "description": "The System IP address of the WAN Edge Device configured on the device.", "type": "string", "readOnly": true, "x-omitempty": true }, "MacAddress": { "description": "MAC address of the physical port.", "type": "string", "readOnly": true, "x-omitempty": true }, "Mode": { "description": "Configured physical port mode. Value will be 'access' or 'trunk' when configured as a switch port; 'backplane' for internal backplane ports and 'routed' all other ports.\n* `Routed` - Port mode is routed. This mode will be set when switchport mode is disabled regardless of the port configuration.\n* `Access` - Port mode is access. This mode will be set when switchport mode is enabled and the port is configured as an access port.\n* `Trunk` - Port mode is trunk. This mode will be set when switchport mode is enabled and the port is configured as a trunk port.", "type": "string", "enum": [ "Routed", "Access", "Trunk" ], "default": "Routed", "readOnly": true, "x-omitempty": true }, "Mtu": { "description": "MTU configured on the physical port.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "NegotiatedSpeed": { "description": "Negotiated speed of the physical port.", "type": "string", "readOnly": true, "x-omitempty": true }, "OperState": { "description": "Operational state of the physical port.\n* `Unknown` - Operational state of physical port or port channel or interface is unknown.\n* `Up` - Operational state of physical port or port channel or interface is up.\n* `Down` - Operational state of physical port or port channel or interface is down.", "type": "string", "enum": [ "Unknown", "Up", "Down" ], "default": "Unknown", "readOnly": true, "x-omitempty": true }, "PortChannelId": { "description": "Port channel ID if the physical port is part of a port channel.", "type": "integer", "format": "int64", "default": 0, "readOnly": true, "x-omitempty": true }, "PortChannelName": { "description": "Port channel name if the physical port is part of a port channel.", "type": "string", "readOnly": true, "x-omitempty": true }, "PortName": { "description": "Physical port name of the WAN Edge Device.", "type": "string", "readOnly": true, "x-omitempty": true }, "PortType": { "description": "Type of the physical port (e.g., Backplane and frontpanel).\n* `Front Panel` - The physical ports that are located on the front panel of Catalyst SDWAN devices.\n* `Backplane` - The internal backplane ports on Catalyst SDWAN devices.", "type": "string", "enum": [ "Front Panel", "Backplane" ], "default": "Front Panel", "readOnly": true, "x-omitempty": true }, "SystemIp": { "description": "The internal system IP of the WAN Edge Device assigned by Catalyst SD-WAN Manager for internal communication.", "type": "string", "readOnly": true, "x-omitempty": true }, "Uuid": { "description": "The UUID of the WAN Edge Device to which this physical port belongs.", "type": "string", "readOnly": true, "x-omitempty": true }, "WanEdgeDevice": { "$ref": "#/components/schemas/catalystsdwan.WanEdgeDevice.Relationship", "description": "A reference to a catalystsdwanWanEdgeDevice resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "catalystsdwan.PhysicalPort.List": { "title": "List of 'catalystsdwan.PhysicalPort' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'catalystsdwan.PhysicalPort' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'catalystsdwan.PhysicalPort' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/catalystsdwan.PhysicalPort" }, "nullable": true } } } ] }, "catalystsdwan.PolicyGroup.Response": { "description": "The response body of a HTTP GET request for the 'catalystsdwan.PolicyGroup' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'catalystsdwan.PolicyGroup' resources.", "x-one-of-name": "catalystsdwan.PolicyGroup.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/catalystsdwan.PolicyGroup.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "catalystsdwan.PolicyGroup": { "title": "Catalystsdwan:Policy Group", "description": "Details for the Catalyst SDWAN policy groups.", "x-allOf-name": "catalystsdwan.PolicyGroup", "allOf": [ { "$ref": "#/components/schemas/catalystsdwan.InventoryEntity" }, { "type": "object", "description": "Definition of the list of properties defined in 'catalystsdwan.PolicyGroup', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "catalystsdwan.PolicyGroup" ], "default": "catalystsdwan.PolicyGroup", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "catalystsdwan.PolicyGroup" ], "default": "catalystsdwan.PolicyGroup", "x-enum-as-string": true }, "Devices": { "type": "array", "items": { "description": "The Catalyst SDWAN policy group devices.", "type": "string", "x-omitempty": true }, "nullable": true }, "Name": { "description": "The Catalyst SDWAN policy group name.", "type": "string", "x-omitempty": true }, "NumberOfDevices": { "description": "The Catalyst SDWAN policy group number of devices.", "type": "integer", "format": "int64", "x-omitempty": true }, "NumberOfDevicesUpToDate": { "description": "The Catalyst SDWAN policy group number of devices up to date.", "type": "integer", "format": "int64", "x-omitempty": true }, "PolicyGroupId": { "description": "UUID for the Catalyst SDWAN policy group.", "type": "string", "x-omitempty": true }, "Solution": { "description": "The Catalyst SDWAN policy group solution.", "type": "string", "x-omitempty": true }, "Version": { "description": "The Catalyst SDWAN policy group version.", "type": "integer", "format": "int64", "x-omitempty": true } } } ] }, "catalystsdwan.PolicyGroup.List": { "title": "List of 'catalystsdwan.PolicyGroup' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'catalystsdwan.PolicyGroup' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'catalystsdwan.PolicyGroup' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/catalystsdwan.PolicyGroup" }, "nullable": true } } } ] }, "catalystsdwan.PortChannel.Response": { "description": "The response body of a HTTP GET request for the 'catalystsdwan.PortChannel' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'catalystsdwan.PortChannel' resources.", "x-one-of-name": "catalystsdwan.PortChannel.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/catalystsdwan.PortChannel.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "catalystsdwan.PortChannel": { "title": "Catalystsdwan:Port Channel", "description": "Details for the WAN Edge Device port channels.", "x-allOf-name": "catalystsdwan.PortChannel", "allOf": [ { "$ref": "#/components/schemas/catalystsdwan.InventoryEntity" }, { "type": "object", "description": "Definition of the list of properties defined in 'catalystsdwan.PortChannel', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "catalystsdwan.PortChannel" ], "default": "catalystsdwan.PortChannel", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "catalystsdwan.PortChannel" ], "default": "catalystsdwan.PortChannel", "x-enum-as-string": true }, "AdminState": { "description": "The administrative state of the WAN Edge Device port channel.\n* `Unknown` - Administrative state is unknown.\n* `Up` - Administrative state is up.\n* `Down` - Administrative state is down.", "type": "string", "enum": [ "Unknown", "Up", "Down" ], "default": "Unknown", "readOnly": true, "x-omitempty": true }, "AllowedVlanIds": { "description": "The allowed VLAN IDs configured on the WAN Edge Device port channel.", "type": "string", "readOnly": true, "x-omitempty": true }, "DefaultVlanId": { "description": "The default VLAN ID configured on the WAN Edge Device port channel.", "type": "integer", "format": "int64", "default": 1, "readOnly": true, "x-omitempty": true }, "Dn": { "description": "The distinguished name of the port channel.", "type": "string", "readOnly": true, "x-omitempty": true }, "LocalSystemIp": { "description": "The system IP address of the WAN Edge Device configured on the device.", "type": "string", "readOnly": true, "x-omitempty": true }, "Mode": { "description": "Portchannel mode on WAN Edge Device will be 'access' or 'trunk' when switchport mode is enabled; otherwise, the mode is 'routed'.\n* `Routed` - Port mode is routed. This mode will be set when switchport mode is disabled regardless of the port configuration.\n* `Access` - Port mode is access. This mode will be set when switchport mode is enabled and the port is configured as an access port.\n* `Trunk` - Port mode is trunk. This mode will be set when switchport mode is enabled and the port is configured as a trunk port.", "type": "string", "enum": [ "Routed", "Access", "Trunk" ], "default": "Routed", "readOnly": true, "x-omitempty": true }, "Mtu": { "description": "The MTU of the WAN Edge Device port channel.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "OperSpeed": { "description": "The operational speed (in Mbps) of the WAN Edge Device port channel.", "type": "string", "readOnly": true, "x-omitempty": true }, "OperState": { "description": "The operational state of the WAN Edge Device port channel.\n* `Unknown` - Operational state of physical port or port channel or interface is unknown.\n* `Up` - Operational state of physical port or port channel or interface is up.\n* `Down` - Operational state of physical port or port channel or interface is down.", "type": "string", "enum": [ "Unknown", "Up", "Down" ], "default": "Unknown", "readOnly": true, "x-omitempty": true }, "PortChannelName": { "description": "Port channel name of the WAN Edge Device.", "type": "string", "readOnly": true, "x-omitempty": true }, "SystemIp": { "description": "The internal system IP of the WAN Edge Device assigned by Catalyst SD-WAN Manager for internal communication.", "type": "string", "readOnly": true, "x-omitempty": true }, "Uuid": { "description": "The UUID of the WAN Edge Device to which this port channel belongs.", "type": "string", "readOnly": true, "x-omitempty": true }, "WanEdgeDevice": { "$ref": "#/components/schemas/catalystsdwan.WanEdgeDevice.Relationship", "description": "A reference to a catalystsdwanWanEdgeDevice resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "catalystsdwan.PortChannel.List": { "title": "List of 'catalystsdwan.PortChannel' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'catalystsdwan.PortChannel' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'catalystsdwan.PortChannel' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/catalystsdwan.PortChannel" }, "nullable": true } } } ] }, "catalystsdwan.VedgeDevice.Response": { "description": "The response body of a HTTP GET request for the 'catalystsdwan.VedgeDevice' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'catalystsdwan.VedgeDevice' resources.", "x-one-of-name": "catalystsdwan.VedgeDevice.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/catalystsdwan.VedgeDevice.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "catalystsdwan.VedgeDevice": { "title": "Catalystsdwan:Vedge Device", "description": "VedgeDevice is deprecated. Going forward WanEdgeDevice will be used to store details for the Catalyst SDWAN Vedge entities.", "x-allOf-name": "catalystsdwan.VedgeDevice", "allOf": [ { "$ref": "intersight-server-v3-1.0.11-20260807064027971.json#/components/schemas/equipment.AbstractDevice" }, { "type": "object", "description": "Definition of the list of properties defined in 'catalystsdwan.VedgeDevice', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "catalystsdwan.VedgeDevice" ], "default": "catalystsdwan.VedgeDevice", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "catalystsdwan.VedgeDevice" ], "default": "catalystsdwan.VedgeDevice", "x-enum-as-string": true }, "ConfigStatusMessage": { "description": "The Catalyst SDWAN device config status message.", "type": "string", "x-omitempty": true }, "DeviceId": { "description": "The Catalyst SDWAN device id.", "type": "string", "x-omitempty": true }, "DeviceState": { "description": "The Catalyst SDWAN device state.", "type": "string", "x-omitempty": true }, "HostName": { "description": "The Catalyst SDWAN device host name.", "type": "string", "x-omitempty": true }, "PlatformFamily": { "description": "The Catalyst SDWAN device platform family.", "type": "string", "x-omitempty": true }, "Reachability": { "description": "The Catalyst SDWAN device reachability.", "type": "string", "x-omitempty": true }, "SiteId": { "description": "The Catalyst SDWAN device site id.", "type": "string", "x-omitempty": true }, "SiteName": { "description": "The Catalyst SDWAN device site name.", "type": "string", "x-omitempty": true }, "SpOrganizationName": { "description": "The Catalyst SDWAN device sp organization name.", "type": "string", "x-omitempty": true }, "SystemIp": { "description": "The Catalyst SDWAN device system IP.", "type": "string", "x-omitempty": true }, "TemplateStatus": { "description": "The Catalyst SDWAN device template status.", "type": "string", "x-omitempty": true }, "Validity": { "description": "The Catalyst SDWAN device validity.", "type": "string", "x-omitempty": true }, "RegisteredDevice": { "$ref": "#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "catalystsdwan.VedgeDevice.List": { "title": "List of 'catalystsdwan.VedgeDevice' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'catalystsdwan.VedgeDevice' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'catalystsdwan.VedgeDevice' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/catalystsdwan.VedgeDevice" }, "nullable": true } } } ] }, "catalystsdwan.Vlan.Response": { "description": "The response body of a HTTP GET request for the 'catalystsdwan.Vlan' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'catalystsdwan.Vlan' resources.", "x-one-of-name": "catalystsdwan.Vlan.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/catalystsdwan.Vlan.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "catalystsdwan.Vlan": { "title": "Catalystsdwan:Vlan", "description": "Details for the WAN Edge Device VLAN entities.", "x-allOf-name": "catalystsdwan.Vlan", "allOf": [ { "$ref": "#/components/schemas/catalystsdwan.InventoryEntity" }, { "type": "object", "description": "Definition of the list of properties defined in 'catalystsdwan.Vlan', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "catalystsdwan.Vlan" ], "default": "catalystsdwan.Vlan", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "catalystsdwan.Vlan" ], "default": "catalystsdwan.Vlan", "x-enum-as-string": true }, "AdminState": { "description": "The administrative state of the WAN Edge Device.\n* `Unknown` - Administrative state is unknown.\n* `Up` - Administrative state is up.\n* `Down` - Administrative state is down.", "type": "string", "enum": [ "Unknown", "Up", "Down" ], "default": "Unknown", "readOnly": true, "x-omitempty": true }, "Dn": { "description": "The distinguished name of the VLAN.", "type": "string", "readOnly": true, "x-omitempty": true }, "LocalSystemIp": { "description": "The local System IP address of the WAN Edge Device configured on the device.", "type": "string", "readOnly": true, "x-omitempty": true }, "SystemIp": { "description": "The internal system IP of the WAN Edge Device assigned by Catalyst SD-WAN Manager for internal communication.", "type": "string", "readOnly": true, "x-omitempty": true }, "Uuid": { "description": "The UUID of the WAN Edge Device to which this VLAN belongs.", "type": "string", "readOnly": true, "x-omitempty": true }, "VlanId": { "description": "The VLAN number configured on the WAN Edge Device.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "VlanState": { "description": "The state of the VLAN on the WAN Edge Device.\n* `Unknown` - VLAN state is unknown on the Catalyst SDWAN device.\n* `Active` - VLAN state is active on the Catalyst SDWAN device.\n* `Inactive` - VLAN state is inactive on the Catalyst SDWAN device.\n* `Suspended` - VLAN state is suspended on the Catalyst SDWAN device.", "type": "string", "enum": [ "Unknown", "Active", "Inactive", "Suspended" ], "default": "Unknown", "readOnly": true, "x-omitempty": true }, "WanEdgeDevice": { "$ref": "#/components/schemas/catalystsdwan.WanEdgeDevice.Relationship", "description": "A reference to a catalystsdwanWanEdgeDevice resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "catalystsdwan.Vlan.List": { "title": "List of 'catalystsdwan.Vlan' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'catalystsdwan.Vlan' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'catalystsdwan.Vlan' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/catalystsdwan.Vlan" }, "nullable": true } } } ] }, "catalystsdwan.WanEdgeDevice.Response": { "description": "The response body of a HTTP GET request for the 'catalystsdwan.WanEdgeDevice' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'catalystsdwan.WanEdgeDevice' resources.", "x-one-of-name": "catalystsdwan.WanEdgeDevice.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/catalystsdwan.WanEdgeDevice.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "catalystsdwan.WanEdgeDevice.Relationship": { "description": "A relationship to the 'catalystsdwan.WanEdgeDevice' resource, or the expanded 'catalystsdwan.WanEdgeDevice' resource, or the 'null' value.", "x-one-of-name": "catalystsdwan.WanEdgeDevice.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/catalystsdwan.WanEdgeDevice" } ], "discriminator": { "propertyName": "ClassId" } }, "catalystsdwan.WanEdgeDevice": { "title": "Catalystsdwan:Wan Edge Device", "description": "Details for the Catalyst SDWAN WAN Edge entities.", "x-allOf-name": "catalystsdwan.WanEdgeDevice", "allOf": [ { "$ref": "intersight-server-v3-1.0.11-20260807064027971.json#/components/schemas/equipment.AbstractDevice" }, { "type": "object", "description": "Definition of the list of properties defined in 'catalystsdwan.WanEdgeDevice', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "catalystsdwan.WanEdgeDevice" ], "default": "catalystsdwan.WanEdgeDevice", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "catalystsdwan.WanEdgeDevice" ], "default": "catalystsdwan.WanEdgeDevice", "x-enum-as-string": true }, "BfdSessions": { "description": "Total number of BFD sessions from the WAN Edge Device to Cisco Catalyst SD-WAN Manager.", "type": "string", "readOnly": true, "x-omitempty": true }, "BfdSessionsUp": { "description": "Number of BFD sessions in up state from the WAN Edge Device to Cisco Catalyst SD-WAN Manager.", "type": "string", "readOnly": true, "x-omitempty": true }, "ConfigDeviceStatus": { "description": "Synchronization status of the WAN Edge Device configuration with Cisco Catalyst SD-WAN Manager.", "type": "string", "readOnly": true, "x-omitempty": true }, "ConfigLocked": { "description": "Indicates if the device configuration is locked.", "type": "string", "readOnly": true, "x-omitempty": true }, "ControlConnections": { "description": "Total number of control connections from the WAN Edge Device to Cisco Catalyst SD-WAN Manager.", "type": "string", "readOnly": true, "x-omitempty": true }, "ControlConnectionsUp": { "description": "Number of control connections in up state from the WAN Edge Device to Cisco Catalyst SD-WAN Manager.", "type": "string", "readOnly": true, "x-omitempty": true }, "DeviceHealth": { "description": "Health status of the WAN Edge Device.", "type": "string", "readOnly": true, "x-omitempty": true }, "DeviceId": { "description": "Device ID of the WAN Edge Device.", "type": "string", "readOnly": true, "x-omitempty": true }, "DeviceState": { "description": "Device state of the WAN Edge Device.", "type": "string", "readOnly": true, "x-omitempty": true }, "HostName": { "description": "Host name of the WAN Edge Device.", "type": "string", "readOnly": true, "x-omitempty": true }, "LocalSystemIp": { "description": "System IP of the WAN Edge Device configured on the device.", "type": "string", "readOnly": true, "x-omitempty": true }, "ManagementPortHwAddr": { "description": "MAC address of the WAN Edge Device management port.", "type": "string", "readOnly": true, "x-omitempty": true }, "ManagementPortIp": { "description": "IP address of the WAN Edge Device management port.", "type": "string", "readOnly": true, "x-omitempty": true }, "ManagementPortSubnet": { "description": "Subnet of the WAN Edge Device management port.", "type": "string", "readOnly": true, "x-omitempty": true }, "OrganizationName": { "description": "The WAN Edge Device organization name.", "type": "string", "readOnly": true, "x-omitempty": true }, "Personality": { "description": "Personality of the WAN Edge Device as seen in the Cisco Catalyst SD-WAN Manager (e.g., vEdge, cEdge).", "type": "string", "readOnly": true, "x-omitempty": true }, "Reachability": { "description": "Reachability of the WAN Edge Device.\n* `Unknown` - Reachability status of the Catalyst SDWAN device from SDWAN Manager is unknown.\n* `Reachable` - The Catalyst SDWAN device is reachable from SDWAN Manager.\n* `Unreachable` - The Catalyst SDWAN device is unreachable from SDWAN Manager.\n* `Authentication Failed` - Authentication failed when SDWAN Manager attempted to connect to the Catalyst SDWAN device.", "type": "string", "enum": [ "Unknown", "Reachable", "Unreachable", "Authentication Failed" ], "default": "Unknown", "readOnly": true, "x-omitempty": true }, "SdwanUserTags": { "description": "User defined tags associated with the WAN Edge Device from Cisco Catalyst SD-WAN Manager.", "type": "string", "readOnly": true, "x-omitempty": true }, "SiteId": { "description": "Site ID of the WAN Edge Device.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "SiteName": { "description": "Site name of the WAN Edge Device.", "type": "string", "readOnly": true, "x-omitempty": true }, "SpOrganizationName": { "description": "The WAN Edge Device sp organization name.", "type": "string", "readOnly": true, "x-omitempty": true }, "SystemIp": { "description": "Internal system IP of the WAN Edge Device assigned by Catalyst SD-WAN Manager for internal communication.", "type": "string", "readOnly": true, "x-omitempty": true }, "Tlocs": { "description": "Total number of TLOCs from the WAN Edge Device to Cisco Catalyst SD-WAN Manager.", "type": "string", "readOnly": true, "x-omitempty": true }, "TlocsUp": { "description": "Number of TLOCs in up state from the WAN Edge Device to Cisco Catalyst SD-WAN Manager.", "type": "string", "readOnly": true, "x-omitempty": true }, "Uptime": { "description": "Uptime of the WAN Edge Device.", "type": "string", "readOnly": true, "x-omitempty": true }, "Validity": { "description": "Validity of the WAN Edge Device.\n* `Unknown` - Validity of the Catalyst SDWAN device configuration is unknown.\n* `Valid` - Configuration on the Catalyst SDWAN device is valid.\n* `Invalid` - Configuration on the Catalyst SDWAN device is invalid.\n* `Prestaging` - Configuration on the Catalyst SDWAN device is in pre-staging state.\n* `Staging` - Configuration on the Catalyst SDWAN device is in staging state.\n* `Config Init` - Configuration on the Catalyst SDWAN device is in initialization state.", "type": "string", "enum": [ "Unknown", "Valid", "Invalid", "Prestaging", "Staging", "Config Init" ], "default": "Unknown", "readOnly": true, "x-omitempty": true }, "RegisteredDevice": { "$ref": "#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "catalystsdwan.WanEdgeDevice.List": { "title": "List of 'catalystsdwan.WanEdgeDevice' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'catalystsdwan.WanEdgeDevice' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'catalystsdwan.WanEdgeDevice' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/catalystsdwan.WanEdgeDevice" }, "nullable": true } } } ] }, "connectorpack.ConnectorPackUpdate": { "title": "Connectorpack:Connector Pack Update", "description": "Connector Pack updates available on UCS Director.", "x-allOf-name": "connectorpack.ConnectorPackUpdate", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'connectorpack.ConnectorPackUpdate', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "connectorpack.ConnectorPackUpdate" ], "default": "connectorpack.ConnectorPackUpdate", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "connectorpack.ConnectorPackUpdate" ], "default": "connectorpack.ConnectorPackUpdate", "x-enum-as-string": true }, "CurrentVersion": { "description": "Version of connector pack currently running in UCS Director.", "type": "string", "readOnly": true, "x-omitempty": true }, "Name": { "description": "Name of the connector pack.", "type": "string", "readOnly": true, "x-omitempty": true }, "NewVersion": { "description": "Version of connector pack to be installed in the next upgrade cycle.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "connectorpack.ConnectorPackUpgrade.Response": { "description": "The response body of a HTTP GET request for the 'connectorpack.ConnectorPackUpgrade' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'connectorpack.ConnectorPackUpgrade' resources.", "x-one-of-name": "connectorpack.ConnectorPackUpgrade.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/connectorpack.ConnectorPackUpgrade.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "connectorpack.ConnectorPackUpgrade": { "title": "Connectorpack:Connector Pack Upgrade", "description": "Used to download or install connector packs on the target device.", "x-allOf-name": "connectorpack.ConnectorPackUpgrade", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'connectorpack.ConnectorPackUpgrade', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "connectorpack.ConnectorPackUpgrade" ], "default": "connectorpack.ConnectorPackUpgrade", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "connectorpack.ConnectorPackUpgrade" ], "default": "connectorpack.ConnectorPackUpgrade", "x-enum-as-string": true }, "ConnectorPackOpType": { "description": "The type of operation to be performed on UCS Director.\n* `Install` - Installs the requisite connector packs on UCS Director.\n* `Push` - Pushes the requisite connector packs to UCS Director.", "type": "string", "enum": [ "Install", "Push" ], "default": "Install", "x-omitempty": true }, "UcsdInfo": { "$ref": "#/components/schemas/iaas.UcsdInfo.Relationship", "description": "A reference to a iaasUcsdInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true }, "Workflow": { "$ref": "#/components/schemas/workflow.WorkflowInfo.Relationship", "description": "A reference to a workflowWorkflowInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "connectorpack.ConnectorPackUpgrade.List": { "title": "List of 'connectorpack.ConnectorPackUpgrade' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'connectorpack.ConnectorPackUpgrade' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'connectorpack.ConnectorPackUpgrade' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/connectorpack.ConnectorPackUpgrade" }, "nullable": true } } } ] }, "connectorpack.UpgradeImpact.Response": { "description": "The response body of a HTTP GET request for the 'connectorpack.UpgradeImpact' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'connectorpack.UpgradeImpact' resources.", "x-one-of-name": "connectorpack.UpgradeImpact.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/connectorpack.UpgradeImpact.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "connectorpack.UpgradeImpact": { "title": "Connectorpack:Upgrade Impact", "description": "The UpgradeImpact object is designed to assess and identify the list of connector packs to be installed or upgraded on UCS Director. It identifies the requisite connector packs for installation during the next upgrade cycle, ensuring a smooth transition and enhanced functionality.\n#### Purpose\nUpgradeImpact object plays a crucial role in planning and executing upgrades for UCS Director, ensuring that all necessary connector packs are identified and managed effectively. It evaluates eligibility for upgrades and provides insights into the upgrade readiness of UCS Director.\n#### Key Concepts\n- **Upgrade Planning:** Facilitates strategic planning for upgrades by identifying necessary connector packs and evaluating upgrade readiness.\n- **Eligibility Assessment:** Assesses UCS Director's eligibility for upgrades, ensuring that all criteria for successful upgrade execution are met.\n- **Download Management:** Manages the download status of connector packs required for upgrades, ensuring readiness for the next iteration.\n- **Relationship Management:** Establishes relationship within connector packs of a UCS Director instance to ensure accurate upgrade of connector packs.", "x-allOf-name": "connectorpack.UpgradeImpact", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'connectorpack.UpgradeImpact', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "connectorpack.UpgradeImpact" ], "default": "connectorpack.UpgradeImpact", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "connectorpack.UpgradeImpact" ], "default": "connectorpack.UpgradeImpact", "x-enum-as-string": true }, "ConnectorPack": { "type": "array", "items": { "description": "Information about connector pack updates available in the next upgrade cycle.", "$ref": "#/components/schemas/connectorpack.ConnectorPackUpdate", "readOnly": true, "x-omitempty": true }, "nullable": true }, "IsEligibleForUpgrade": { "description": "States whether the UCS Director is eligible for an upgrade. Set to true if connector packs are available for upgrade, else set to false.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "IsUpdateDownloaded": { "description": "States whether all the requisite updates have been downloaded to the target UCS Director. Set to true if all connector packs required to upgrade UCS Director to the next iteration have been downloaded, else set to false.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "UcsdInfo": { "$ref": "#/components/schemas/iaas.UcsdInfo.Relationship", "description": "A reference to a iaasUcsdInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." } } } ] }, "connectorpack.UpgradeImpact.List": { "title": "List of 'connectorpack.UpgradeImpact' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'connectorpack.UpgradeImpact' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'connectorpack.UpgradeImpact' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/connectorpack.UpgradeImpact" }, "nullable": true } } } ] }, "convergedinfra.AdapterComplianceDetails.Response": { "description": "The response body of a HTTP GET request for the 'convergedinfra.AdapterComplianceDetails' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'convergedinfra.AdapterComplianceDetails' resources.", "x-one-of-name": "convergedinfra.AdapterComplianceDetails.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/convergedinfra.AdapterComplianceDetails.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "convergedinfra.AdapterComplianceDetails.Relationship": { "description": "A relationship to the 'convergedinfra.AdapterComplianceDetails' resource, or the expanded 'convergedinfra.AdapterComplianceDetails' resource, or the 'null' value.", "x-one-of-name": "convergedinfra.AdapterComplianceDetails.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/convergedinfra.AdapterComplianceDetails" } ], "discriminator": { "propertyName": "ClassId" } }, "convergedinfra.AdapterComplianceDetails": { "title": "Convergedinfra:Adapter Compliance Details", "description": "The AdapterComplianceDetails object captures compliance details for adapters within servers of a converged infrastructure pod, focusing on hardware compatibility and firmware status. \n#### Purpose\nAdapterComplianceDetails provides essential insights into adapter compliance, assessing compatibility with standards and operational criteria necessary for seamless infrastructure operation. \n#### Key Concepts\n- **Hardware Compatibility:** Evaluates adapter compliance against hardware compatibility lists, ensuring alignment with industry standards. \n- **Firmware and Driver Information:** Includes detailed information about adapter firmware and drivers, supporting thorough compliance checks.\n- **Server Integration:** Associates adapter compliance details with server compliance data, promoting integrated compliance assessments.\n- **Administrative Control:** Accessible through defined privilege sets, ensuring secure and authorized interaction with adapter compliance information.", "x-allOf-name": "convergedinfra.AdapterComplianceDetails", "allOf": [ { "$ref": "#/components/schemas/convergedinfra.BaseComplianceDetails" }, { "type": "object", "description": "Definition of the list of properties defined in 'convergedinfra.AdapterComplianceDetails', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "convergedinfra.AdapterComplianceDetails" ], "default": "convergedinfra.AdapterComplianceDetails", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "convergedinfra.AdapterComplianceDetails" ], "default": "convergedinfra.AdapterComplianceDetails", "x-enum-as-string": true }, "DriverName": { "description": "The driver name (e.g. nenic, nfnic) of the adapter.", "type": "string", "readOnly": true, "x-omitempty": true }, "DriverVersion": { "description": "The driver version of the adapter.", "type": "string", "readOnly": true, "x-omitempty": true }, "Firmware": { "description": "The firmware version of the adapter.", "type": "string", "readOnly": true, "x-omitempty": true }, "HclStatus": { "description": "The HCL compatibility status for the adapter.\n* `NotEvaluated` - The interoperability compliance for the component has not be checked.\n* `Approved` - The component is valid as per the interoperability compliance check.\n* `NotApproved` - The component is not valid as per the interoperability compliance check.\n* `Incomplete` - The interoperability compliance check could not be completed for the component due to incomplete data.", "type": "string", "enum": [ "NotEvaluated", "Approved", "NotApproved", "Incomplete" ], "default": "NotEvaluated", "readOnly": true, "x-omitempty": true }, "HclStatusReason": { "description": "The reason for the HCL status when it is not Approved.\n* `Missing-Os-Driver-Info` - The validation failed because the given server has no operating system driver information available in the inventory. Either install ucstools vib or use power shell scripts to tag proper operating system information.\n* `Incompatible-Server-With-Component` - The validation failed for this component because he server model and component model combination was not found in the HCL.\n* `Incompatible-Processor` - The validation failed because the given processor was not found for the given server PID.\n* `Incompatible-Os-Info` - The validation failed because the given operating system vendor and version was not found in HCL for the server PID and processor combination.\n* `Incompatible-Component-Model` - The validation failed because the given Component model was not found in the HCL for the given server PID, processor, server Firmware and operating system vendor and version.\n* `Incompatible-Firmware` - The validation failed because the given server firmware or adapter firmware was not found in the HCL for the given server PID, processor, operating system vendor and version and component model.\n* `Incompatible-Driver` - The validation failed because the given driver version was not found in the HCL for the given Server PID, processor, operating system vendor and version, server firmware and component firmware.\n* `Incompatible-Firmware-Driver` - The validation failed because the given component firmware and driver version was not found in the HCL for the given Server PID, processor, operating system vendor and version and server firmware.\n* `Service-Unavailable` - The validation has failed because HCL data service is temporarily not available. The server will be re-evaluated once HCL data service is back online or finished importing new HCL data.\n* `Service-Error` - The validation has failed because the HCL data service has return a service error or unrecognized result.\n* `Unrecognized-Protocol` - The validation has failed for the HCL component because the HCL data service has return a validation reason that is unknown to this service. This reason is used as a default failure reason reason in case we cannot map the error reason received from the HCL data service unto one of the other enum values.\n* `Not-Evaluated` - The validation for the hardware or software HCL status was not yet evaluated because some previous validation had failed. For example if a server's hardware profile fails to validate with HCL, then the server's software status will not be evaluated.\n* `Compatible` - The validation has passed for this server PID, processor, operating system vendor and version, component model, component firmware and driver version.", "type": "string", "enum": [ "Missing-Os-Driver-Info", "Incompatible-Server-With-Component", "Incompatible-Processor", "Incompatible-Os-Info", "Incompatible-Component-Model", "Incompatible-Firmware", "Incompatible-Driver", "Incompatible-Firmware-Driver", "Service-Unavailable", "Service-Error", "Unrecognized-Protocol", "Not-Evaluated", "Compatible" ], "default": "Missing-Os-Driver-Info", "readOnly": true, "x-omitempty": true }, "Model": { "description": "The model information of the adapter.", "type": "string", "readOnly": true, "x-omitempty": true }, "Adapter": { "$ref": "intersight-server-v3-1.0.11-20260807064027971.json#/components/schemas/adapter.Unit.Relationship", "description": "A reference to a adapterUnit resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "ServerComplianceDetails": { "$ref": "#/components/schemas/convergedinfra.ServerComplianceDetails.Relationship", "description": "A reference to a convergedinfraServerComplianceDetails resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "StorageCompliances": { "description": "An array of relationships to convergedinfraStorageComplianceDetails resources.", "type": "array", "items": { "$ref": "#/components/schemas/convergedinfra.StorageComplianceDetails.Relationship" }, "nullable": true, "readOnly": true } } } ] }, "convergedinfra.AdapterComplianceDetails.List": { "title": "List of 'convergedinfra.AdapterComplianceDetails' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'convergedinfra.AdapterComplianceDetails' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'convergedinfra.AdapterComplianceDetails' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/convergedinfra.AdapterComplianceDetails" }, "nullable": true } } } ] }, "convergedinfra.AlarmSummary": { "title": "Convergedinfra:Alarm Summary", "description": "The summary of alarm counts based on alarm serverity.", "x-allOf-name": "convergedinfra.AlarmSummary", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'convergedinfra.AlarmSummary', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "convergedinfra.AlarmSummary" ], "default": "convergedinfra.AlarmSummary", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "convergedinfra.AlarmSummary" ], "default": "convergedinfra.AlarmSummary", "x-enum-as-string": true }, "Critical": { "description": "The count of alarms that have severity type Critical.", "type": "integer", "format": "int64", "x-omitempty": true }, "Warning": { "description": "The count of alarms that have severity type Warning.", "type": "integer", "format": "int64", "x-omitempty": true } } } ] }, "convergedinfra.BaseComplianceDetails.Relationship": { "description": "A relationship to the 'convergedinfra.BaseComplianceDetails' resource, or the expanded 'convergedinfra.BaseComplianceDetails' resource, or the 'null' value.", "x-one-of-name": "convergedinfra.BaseComplianceDetails.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/convergedinfra.BaseComplianceDetails" } ], "discriminator": { "propertyName": "ClassId" } }, "convergedinfra.BaseComplianceDetails": { "title": "Convergedinfra:Base Compliance Details", "description": "Abstract type for all compliance details that may be part of a converged infrastructure pod.", "x-allOf-name": "convergedinfra.BaseComplianceDetails", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'convergedinfra.BaseComplianceDetails', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "convergedinfra.AdapterComplianceDetails", "convergedinfra.PodComplianceInfo", "convergedinfra.ServerComplianceDetails", "convergedinfra.StorageComplianceDetails", "convergedinfra.SwitchComplianceDetails" ], "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "convergedinfra.AdapterComplianceDetails", "convergedinfra.PodComplianceInfo", "convergedinfra.ServerComplianceDetails", "convergedinfra.StorageComplianceDetails", "convergedinfra.SwitchComplianceDetails" ], "x-enum-as-string": true }, "Name": { "description": "The name of the component for which the compliance is evaluated.", "type": "string", "readOnly": true, "x-omitempty": true }, "Reason": { "description": "Reason for the status, when the status is Incomplete or NotApproved. Reason should help to identify the component that is not compliant.\n* `NotEvaluated` - The validation for the HCL or Interop status is yet to be performed.\n* `Missing-Os-Info` - This means the Interop status for the sever cannot be computed because we have missing OS information. Either install ucstools vib or use power shell scripts to tag proper OS information.\n* `Incompatible-Storage-Os` - The validation failed because the given storage name and version combination is not found in Interop matrix.\n* `Incompatible-Os-Info` - The validation failed because the given OS name and version combination is not found in HCL.\n* `Incompatible-Processor` - The validation failed because the given processor is not found for the given server PID in HCL.\n* `Incompatible-Server-Platform` - The validation failed because the given server platform is not found in the Interop matrix.\n* `Incompatible-Server-Model` - The validation failed because the given server model is not found in the Interop matrix.\n* `Incompatible-Adapter-Model` - The validation failed because the given adapter model is not found in the Interop matrix.\n* `Incompatible-Switch-Model` - The validation failed because the given switch model is not found in the Interop matrix.\n* `Incompatible-Server-Firmware` - The validation failed because the given server firmware version is not found in HCL.\n* `Incompatible-Switch-Firmware` - The validation failed because the given switch firmware version is not found in Interop matrix.\n* `Incompatible-Firmware` - The validation failed because the given adapter firmware version is not found in either HCL or Interop matrix.\n* `Incompatible-Driver` - The validation failed because the given driver version is not found in either HCL or Interop matrix.\n* `Incompatible-Firmware-Driver` - The validation failed because the given adapter firmware and driver version is not found in either HCL or Interop matrix.\n* `Missing-Os-Driver-Info` - The validation failed because the given server has no OS driver information available in the inventory. Either install ucstools vib or use power shell scripts to tag proper OS information.\n* `Missing-Os-Or-Driver-Info` - This means the Interop status for the switch or storage array cannot be computed because we have either missing Host OS information or missing required driver information. Either install ucstools vib or use power shell scripts to tag proper OS information or install required drivers.\n* `Incompatible-Components` - The validation failed for the given server because one or more of its components failed validation.\n* `Compatible` - This means the HCL status and Interop status for the component have passed all validations for all of its related components.", "type": "string", "enum": [ "NotEvaluated", "Missing-Os-Info", "Incompatible-Storage-Os", "Incompatible-Os-Info", "Incompatible-Processor", "Incompatible-Server-Platform", "Incompatible-Server-Model", "Incompatible-Adapter-Model", "Incompatible-Switch-Model", "Incompatible-Server-Firmware", "Incompatible-Switch-Firmware", "Incompatible-Firmware", "Incompatible-Driver", "Incompatible-Firmware-Driver", "Missing-Os-Driver-Info", "Missing-Os-Or-Driver-Info", "Incompatible-Components", "Compatible" ], "default": "NotEvaluated", "readOnly": true, "x-omitempty": true }, "Status": { "description": "Compliance status for the component.\n* `NotEvaluated` - The interoperability compliance for the component has not be checked.\n* `Approved` - The component is valid as per the interoperability compliance check.\n* `NotApproved` - The component is not valid as per the interoperability compliance check.\n* `Incomplete` - The interoperability compliance check could not be completed for the component due to incomplete data.", "type": "string", "enum": [ "NotEvaluated", "Approved", "NotApproved", "Incomplete" ], "default": "NotEvaluated", "readOnly": true, "x-omitempty": true } } } ] }, "convergedinfra.BasePod": { "title": "Convergedinfra:Base Pod", "description": "Abstract base type for all pods.", "x-allOf-name": "convergedinfra.BasePod", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'convergedinfra.BasePod', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "convergedinfra.Pod" ], "default": "convergedinfra.Pod", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "convergedinfra.Pod" ], "default": "convergedinfra.Pod", "x-enum-as-string": true }, "Description": { "description": "Description of the pod. A short note about the nature or purpose of the pod.", "type": "string", "pattern": "^$|^[a-zA-Z0-9]+[\\x00-\\xFF]*$", "maxLength": 1024, "x-omitempty": true }, "Name": { "description": "Name of the pod. Concrete pod will be created with this name.", "type": "string", "pattern": "^[a-zA-Z0-9_.-]{1,64}$", "x-omitempty": true }, "Type": { "description": "Defines the type of the pod.\n* `FlexPod` - Pod type is FlexPod, an integrated infrastructure solution developed by Cisco and NetApp.\n* `FlashStack` - Pod type is FlashStack, an integrated infrastructure solution developed by Cisco and Pure Storage.", "type": "string", "enum": [ "FlexPod", "FlashStack" ], "default": "FlexPod", "x-omitempty": true } } } ] }, "convergedinfra.BasePodSummary": { "title": "Convergedinfra:Base Pod Summary", "description": "Summary information for the base pod. This inclues properties like number of nodes, stroage capacity/utilization, aggregated alarms for all the components of the pod etc.", "x-allOf-name": "convergedinfra.BasePodSummary", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'convergedinfra.BasePodSummary', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "convergedinfra.PodSummary" ], "default": "convergedinfra.PodSummary", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "convergedinfra.PodSummary" ], "default": "convergedinfra.PodSummary", "x-enum-as-string": true }, "AlarmSummary": { "description": "The summary of alarm counts for all elements of a pod based on the severity types (Critical or Warning) .", "$ref": "#/components/schemas/convergedinfra.AlarmSummary", "readOnly": true, "x-omitempty": true }, "ComplianceSummary": { "description": "The summary of compliance count status for all elements of a pod based on if the validation status (Validated/Incomplete/NotEvaluated).", "$ref": "#/components/schemas/convergedinfra.ComplianceSummary", "readOnly": true, "x-omitempty": true }, "NodeCount": { "description": "Number of nodes associated with the pod.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "StorageAvailable": { "description": "The available storage capacity for this pod.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "StorageCapacity": { "description": "The total storage capacity for this pod.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "StorageUtilization": { "description": "The percentage storage utilization for this pod.", "type": "number", "format": "float", "readOnly": true, "x-omitempty": true } } } ] }, "convergedinfra.ComplianceSummary": { "title": "Convergedinfra:Compliance Summary", "description": "The summary of compliance information based on the compliance analysis (HCL, IMT, etc.) of components.", "x-allOf-name": "convergedinfra.ComplianceSummary", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'convergedinfra.ComplianceSummary', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "convergedinfra.ComplianceSummary" ], "default": "convergedinfra.ComplianceSummary", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "convergedinfra.ComplianceSummary" ], "default": "convergedinfra.ComplianceSummary", "x-enum-as-string": true }, "Incomplete": { "description": "The count of elements where compliance information is not available. eg. For HCL of server, OS information is not available.", "type": "integer", "format": "int64", "x-omitempty": true }, "NotEvaluated": { "description": "The count of elements where compliance has not been evaluated. e.g. For HCL of server, status has not been evaluated due to lack of information.", "type": "integer", "format": "int64", "x-omitempty": true }, "NotListed": { "description": "The count of elements where compliance has failed for one or more reason. e.g. For HCL of server, some part of the HCL validation has failed.", "type": "integer", "format": "int64", "x-omitempty": true }, "Validated": { "description": "The count of elements where compliance has passed validation for all components. e.g. For HCL of server, all of the components have passed validation.", "type": "integer", "format": "int64", "x-omitempty": true } } } ] }, "convergedinfra.Pod.Response": { "description": "The response body of a HTTP GET request for the 'convergedinfra.Pod' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'convergedinfra.Pod' resources.", "x-one-of-name": "convergedinfra.Pod.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/convergedinfra.Pod.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "convergedinfra.Pod.Relationship": { "description": "A relationship to the 'convergedinfra.Pod' resource, or the expanded 'convergedinfra.Pod' resource, or the 'null' value.", "x-one-of-name": "convergedinfra.Pod.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/convergedinfra.Pod" } ], "discriminator": { "propertyName": "ClassId" } }, "convergedinfra.Pod": { "title": "Convergedinfra:Pod", "description": "### Overview\nThe Pod object represents a unit of deployment within a converged infrastructure. It encompasses inventory details related to health, hardware compatibility (HCL), storage, nodes, and other aspects that define a pod's operational and compliance status. \n#### Purpose \nThe Pod object serves as a central entity in converged infrastructure management, offering a comprehensive view of the components and their states within a deployment. It acts as a repository of information essential for monitoring, compliance checks, and resource management. \n#### Key Concepts \n- **Deployment Unit:** A Pod is a modular deployment component, enabling scalable and efficient infrastructure management. \n- **Interoperability and Compliance:** Facilitates the assessment of the interoperability status and compliance with predefined standards, ensuring optimal operation. \n- **Resource Integration:** Integrates various resources, including servers, adapters, switches, and storage arrays, into a cohesive management structure. \n- **Privilege Management:** Access to Pod details is controlled through privilege sets, ensuring secure and authorized interactions with the infrastructure data.", "x-allOf-name": "convergedinfra.Pod", "allOf": [ { "$ref": "#/components/schemas/convergedinfra.BasePod" }, { "type": "object", "description": "Definition of the list of properties defined in 'convergedinfra.Pod', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "convergedinfra.Pod" ], "default": "convergedinfra.Pod", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "convergedinfra.Pod" ], "default": "convergedinfra.Pod", "x-enum-as-string": true }, "DeploymentType": { "description": "The deployment type for this integrated system.\n* `FlexPodInfra` - The deployment type for a pod is of Infrastructure.\n* `FlexPodNG` - The deployment type for a pod is of Nextgen type.", "type": "string", "enum": [ "FlexPodInfra", "FlexPodNG" ], "default": "FlexPodInfra", "readOnly": true, "x-omitempty": true }, "InteropStatus": { "description": "The interoperability status for this solution pod.\n* `NotEvaluated` - The interoperability compliance for the component has not be checked.\n* `Approved` - The component is valid as per the interoperability compliance check.\n* `NotApproved` - The component is not valid as per the interoperability compliance check.\n* `Incomplete` - The interoperability compliance check could not be completed for the component due to incomplete data.", "type": "string", "enum": [ "NotEvaluated", "Approved", "NotApproved", "Incomplete" ], "default": "NotEvaluated", "readOnly": true, "x-omitempty": true }, "Summary": { "description": "The summary of pod's health, compliance, storage, number of nodes etc.", "$ref": "#/components/schemas/convergedinfra.PodSummary", "readOnly": true, "x-omitempty": true }, "Organization": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/organization.Organization.Relationship", "description": "A reference to a organizationOrganization resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true }, "PodCompliance": { "$ref": "#/components/schemas/convergedinfra.PodComplianceInfo.Relationship", "description": "A reference to a convergedinfraPodComplianceInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "PodResourceGroup": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/resource.Group.Relationship", "description": "A reference to a resourceGroup resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "ServiceItemInstance": { "$ref": "#/components/schemas/workflow.ServiceItemInstance.Relationship", "description": "A reference to a workflowServiceItemInstance resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "convergedinfra.Pod.List": { "title": "List of 'convergedinfra.Pod' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'convergedinfra.Pod' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'convergedinfra.Pod' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/convergedinfra.Pod" }, "nullable": true } } } ] }, "convergedinfra.PodComplianceInfo.Response": { "description": "The response body of a HTTP GET request for the 'convergedinfra.PodComplianceInfo' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'convergedinfra.PodComplianceInfo' resources.", "x-one-of-name": "convergedinfra.PodComplianceInfo.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/convergedinfra.PodComplianceInfo.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "convergedinfra.PodComplianceInfo.Relationship": { "description": "A relationship to the 'convergedinfra.PodComplianceInfo' resource, or the expanded 'convergedinfra.PodComplianceInfo' resource, or the 'null' value.", "x-one-of-name": "convergedinfra.PodComplianceInfo.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/convergedinfra.PodComplianceInfo" } ], "discriminator": { "propertyName": "ClassId" } }, "convergedinfra.PodComplianceInfo": { "title": "Convergedinfra:Pod Compliance Info", "description": "The PodComplianceInfo object captures compliance information for a converged infrastructure pod, extending the base compliance details to include specific compliance assessments for the pod itself. \n#### Purpose\nPodComplianceInfo provides a detailed view of the compliance status of a pod, highlighting areas that meet or deviate from established standards. This supports comprehensive compliance management and helps identify non-compliant components. \n#### Key Concepts\n- **Compliance Tracking:** Offers insights into the compliance status of the entire pod, facilitating proactive management and remediation. \n- **Inheritance:** Leverages the base compliance details, extending them to encompass pod-specific compliance metrics. \n- **Detailed Relationships:** Establishes connections with the pod and its components, enabling a holistic view of compliance across the infrastructure.\n- **Administrative Access:** Supports a range of privilege sets, allowing different levels of administrative interaction with compliance data.", "x-allOf-name": "convergedinfra.PodComplianceInfo", "allOf": [ { "$ref": "#/components/schemas/convergedinfra.BaseComplianceDetails" }, { "type": "object", "description": "Definition of the list of properties defined in 'convergedinfra.PodComplianceInfo', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "convergedinfra.PodComplianceInfo" ], "default": "convergedinfra.PodComplianceInfo", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "convergedinfra.PodComplianceInfo" ], "default": "convergedinfra.PodComplianceInfo", "x-enum-as-string": true }, "Details": { "description": "An array of relationships to convergedinfraBaseComplianceDetails resources.", "type": "array", "items": { "$ref": "#/components/schemas/convergedinfra.BaseComplianceDetails.Relationship" }, "nullable": true, "readOnly": true }, "Pod": { "$ref": "#/components/schemas/convergedinfra.Pod.Relationship", "description": "A reference to a convergedinfraPod resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "convergedinfra.PodComplianceInfo.List": { "title": "List of 'convergedinfra.PodComplianceInfo' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'convergedinfra.PodComplianceInfo' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'convergedinfra.PodComplianceInfo' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/convergedinfra.PodComplianceInfo" }, "nullable": true } } } ] }, "convergedinfra.PodSummary": { "title": "Convergedinfra:Pod Summary", "description": "Summary information for the Pod, this is extenstion of properties defined in basePodSummary.", "x-allOf-name": "convergedinfra.PodSummary", "allOf": [ { "$ref": "#/components/schemas/convergedinfra.BasePodSummary" }, { "type": "object", "description": "Definition of the list of properties defined in 'convergedinfra.PodSummary', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "convergedinfra.PodSummary" ], "default": "convergedinfra.PodSummary", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "convergedinfra.PodSummary" ], "default": "convergedinfra.PodSummary", "x-enum-as-string": true }, "ActiveNodes": { "description": "Number of Nodes that are powered on and have at least 1 VM associated with the pod.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "VmCount": { "description": "Number of VMs associated with the pod.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true } } } ] }, "convergedinfra.ServerComplianceDetails.Response": { "description": "The response body of a HTTP GET request for the 'convergedinfra.ServerComplianceDetails' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'convergedinfra.ServerComplianceDetails' resources.", "x-one-of-name": "convergedinfra.ServerComplianceDetails.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/convergedinfra.ServerComplianceDetails.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "convergedinfra.ServerComplianceDetails.Relationship": { "description": "A relationship to the 'convergedinfra.ServerComplianceDetails' resource, or the expanded 'convergedinfra.ServerComplianceDetails' resource, or the 'null' value.", "x-one-of-name": "convergedinfra.ServerComplianceDetails.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/convergedinfra.ServerComplianceDetails" } ], "discriminator": { "propertyName": "ClassId" } }, "convergedinfra.ServerComplianceDetails": { "title": "Convergedinfra:Server Compliance Details", "description": "The ServerComplianceDetails object provides compliance information for servers within a converged infrastructure pod, detailing hardware compatibility and operational status. \n#### Purpose \nServerComplianceDetails is focused on evaluating server compliance, ensuring that server components meet hardware compatibility list (HCL) criteria and operational standards necessary for reliable infrastructure performance. \n#### Key Concepts\n- **HCL Compatibility:** Provides status and reasoning related to hardware compatibility, ensuring that server components are aligned with prescribed standards. \n- **Platform Information:** Encompasses detailed information about server platforms, processors, firmware, and operating systems, aiding in compliance evaluation. \n- **Integration with Pod Compliance:** Connects server compliance data with pod-level compliance insights, facilitating integrated compliance management. \n- **Read-Only Access:** Designed for secure consumption of server compliance data, ensuring consistent integration with management interfaces.", "x-allOf-name": "convergedinfra.ServerComplianceDetails", "allOf": [ { "$ref": "#/components/schemas/convergedinfra.BaseComplianceDetails" }, { "type": "object", "description": "Definition of the list of properties defined in 'convergedinfra.ServerComplianceDetails', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "convergedinfra.ServerComplianceDetails" ], "default": "convergedinfra.ServerComplianceDetails", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "convergedinfra.ServerComplianceDetails" ], "default": "convergedinfra.ServerComplianceDetails", "x-enum-as-string": true }, "AdapterCount": { "description": "The number of ethernet NIC adapters in the server.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Firmware": { "description": "The Cisco IMC firmware version of the server.", "type": "string", "readOnly": true, "x-omitempty": true }, "HclStatus": { "description": "The HCL compatibility status of the server.\n* `NotEvaluated` - The interoperability compliance for the component has not be checked.\n* `Approved` - The component is valid as per the interoperability compliance check.\n* `NotApproved` - The component is not valid as per the interoperability compliance check.\n* `Incomplete` - The interoperability compliance check could not be completed for the component due to incomplete data.", "type": "string", "enum": [ "NotEvaluated", "Approved", "NotApproved", "Incomplete" ], "default": "NotEvaluated", "readOnly": true, "x-omitempty": true }, "HclStatusReason": { "description": "The reason for server's HCL status.\n* `Missing-Os-Driver-Info` - The validation failed because the given server has no operating system driver information available in the inventory. Either install UCS Tools VIB on the host ESXi or use OS Discovery Tool scripts to provide proper operating system information.\n* `Incompatible-Server` - The validation failed for this server because the server's model was not listed in the HCL.\n* `Incompatible-Processor` - The validation failed because the given processor was not listed for the given server model.\n* `Incompatible-Os-Info` - The validation failed because the given operating system vendor or version was not listed in HCL for the server PID and processor combination.\n* `Incompatible-Firmware` - The validation failed because the given server firmware was not listed in the HCL for the given server PID, processor, operating system vendor and version.\n* `Service-Unavailable` - The validation has failed because HCL data service is temporarily not available. The server will be re-evaluated once HCL data service is back online or finished importing new HCL data.\n* `Service-Error` - The validation has failed because the HCL data service has returned a service error or unrecognized result.\n* `Not-Evaluated` - This means the HclStatus for the server has not been evaluated because it is exempted.\n* `Incompatible-Components` - The validation has failed for this server because one or more components have \"Not-Listed\" status.\n* `Compatible` - The validation has passed for this server's model, processor, operating system vendor and version.", "type": "string", "enum": [ "Missing-Os-Driver-Info", "Incompatible-Server", "Incompatible-Processor", "Incompatible-Os-Info", "Incompatible-Firmware", "Service-Unavailable", "Service-Error", "Not-Evaluated", "Incompatible-Components", "Compatible" ], "default": "Missing-Os-Driver-Info", "readOnly": true, "x-omitempty": true }, "Model": { "description": "The model information of the server.", "type": "string", "readOnly": true, "x-omitempty": true }, "Os": { "description": "Details of name and version of the operating system running on the server.", "type": "string", "readOnly": true, "x-omitempty": true }, "Platform": { "description": "Details of platform of the server, examples are B-Series, C-Series, X-Series etc.", "type": "string", "readOnly": true, "x-omitempty": true }, "Processor": { "description": "The processor information of the server.", "type": "string", "readOnly": true, "x-omitempty": true }, "PodCompliance": { "$ref": "#/components/schemas/convergedinfra.PodComplianceInfo.Relationship", "description": "A reference to a convergedinfraPodComplianceInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Server": { "$ref": "intersight-server-v3-1.0.11-20260807064027971.json#/components/schemas/compute.PhysicalSummary.Relationship", "description": "A reference to a computePhysicalSummary resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "convergedinfra.ServerComplianceDetails.List": { "title": "List of 'convergedinfra.ServerComplianceDetails' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'convergedinfra.ServerComplianceDetails' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'convergedinfra.ServerComplianceDetails' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/convergedinfra.ServerComplianceDetails" }, "nullable": true } } } ] }, "convergedinfra.StorageComplianceDetails.Response": { "description": "The response body of a HTTP GET request for the 'convergedinfra.StorageComplianceDetails' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'convergedinfra.StorageComplianceDetails' resources.", "x-one-of-name": "convergedinfra.StorageComplianceDetails.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/convergedinfra.StorageComplianceDetails.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "convergedinfra.StorageComplianceDetails.Relationship": { "description": "A relationship to the 'convergedinfra.StorageComplianceDetails' resource, or the expanded 'convergedinfra.StorageComplianceDetails' resource, or the 'null' value.", "x-one-of-name": "convergedinfra.StorageComplianceDetails.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/convergedinfra.StorageComplianceDetails" } ], "discriminator": { "propertyName": "ClassId" } }, "convergedinfra.StorageComplianceDetails": { "title": "Convergedinfra:Storage Compliance Details", "description": "The StorageComplianceDetails object provides compliance information for storage arrays within a converged infrastructure pod, assessing their interoperability and operational standards. \n#### Purpose\nStorageComplianceDetails focuses on evaluating storage compliance, ensuring that storage components meet interoperability criteria and operational guidelines necessary for efficient data management. \n#### Key Concepts\n- **Operating System and Protocol Evaluation:** Assesses compliance of storage arrays based on their operating systems and communication protocols. \n- **Integration with Network Components:** Evaluates storage compliance in relation to switches and adapters, promoting integrated infrastructure assessments. \n- **Pod-Level Compliance:** Connects storage compliance details with broader pod compliance information, supporting cohesive compliance management. \n- **Secure Access:** Provides controlled access to storage compliance data through privilege sets, ensuring secure and authorized interactions.", "x-allOf-name": "convergedinfra.StorageComplianceDetails", "allOf": [ { "$ref": "#/components/schemas/convergedinfra.BaseComplianceDetails" }, { "type": "object", "description": "Definition of the list of properties defined in 'convergedinfra.StorageComplianceDetails', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "convergedinfra.StorageComplianceDetails" ], "default": "convergedinfra.StorageComplianceDetails", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "convergedinfra.StorageComplianceDetails" ], "default": "convergedinfra.StorageComplianceDetails", "x-enum-as-string": true }, "Os": { "description": "The operating system name and version (e.g. NetApp ONTAP 9.10) running on the storage array for which the compliance is getting evaluated.", "type": "string", "readOnly": true, "x-omitempty": true }, "Protocol": { "description": "The protocol configured for the communication between the switch and the storage array.", "type": "string", "readOnly": true, "x-omitempty": true }, "RefDevice": { "description": "The reference device (e.g. adapter, fabric interconnect) against which the storage compliance is getting evaluated.\n* `Server` - The component type for a server in a converged infrastructure pod.\n* `Adapter` - The component type for an adapter on a server in a converged infrastructure pod.\n* `FabricInterconnect` - The component type for a fabric interconnect in a converged infrastructure pod.\n* `Nexus` - The component type for a nexus switch in a converged infrastructure pod.\n* `Storage` - The component type for a storage array in a converged infrastructure pod.", "type": "string", "enum": [ "Server", "Adapter", "FabricInterconnect", "Nexus", "Storage" ], "default": "Server", "readOnly": true, "x-omitempty": true }, "AdapterCompliance": { "$ref": "#/components/schemas/convergedinfra.AdapterComplianceDetails.Relationship", "description": "A reference to a convergedinfraAdapterComplianceDetails resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "PodCompliance": { "$ref": "#/components/schemas/convergedinfra.PodComplianceInfo.Relationship", "description": "A reference to a convergedinfraPodComplianceInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "StorageArray": { "$ref": "intersight-server-v3-1.0.11-20260807064027971.json#/components/schemas/storage.BaseArray.Relationship", "description": "A reference to a storageBaseArray resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "SwitchCompliance": { "$ref": "#/components/schemas/convergedinfra.SwitchComplianceDetails.Relationship", "description": "A reference to a convergedinfraSwitchComplianceDetails resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "convergedinfra.StorageComplianceDetails.List": { "title": "List of 'convergedinfra.StorageComplianceDetails' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'convergedinfra.StorageComplianceDetails' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'convergedinfra.StorageComplianceDetails' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/convergedinfra.StorageComplianceDetails" }, "nullable": true } } } ] }, "convergedinfra.SwitchComplianceDetails.Response": { "description": "The response body of a HTTP GET request for the 'convergedinfra.SwitchComplianceDetails' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'convergedinfra.SwitchComplianceDetails' resources.", "x-one-of-name": "convergedinfra.SwitchComplianceDetails.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/convergedinfra.SwitchComplianceDetails.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "convergedinfra.SwitchComplianceDetails.Relationship": { "description": "A relationship to the 'convergedinfra.SwitchComplianceDetails' resource, or the expanded 'convergedinfra.SwitchComplianceDetails' resource, or the 'null' value.", "x-one-of-name": "convergedinfra.SwitchComplianceDetails.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/convergedinfra.SwitchComplianceDetails" } ], "discriminator": { "propertyName": "ClassId" } }, "convergedinfra.SwitchComplianceDetails": { "title": "Convergedinfra:Switch Compliance Details", "description": "The SwitchComplianceDetails object captures compliance information for switches, such as Fabric Interconnects, Nexus, and MDS, within a converged infrastructure pod. \n#### Purpose \nSwitchComplianceDetails is dedicated to assessing switch compliance, ensuring that switch components meet operational and compatibility standards essential for network connectivity and performance. \n#### Key Concepts \n- **Switch Type Specifics:** Provides compliance evaluation tailored to specific switch types, including Fabric Interconnects, Nexus, and MDS. \n- **Firmware Evaluation:** Includes detailed firmware information necessary for compliance assessments and operational reliability. \n- **Pod Integration:** Links switch compliance data with pod-level compliance insights, supporting comprehensive infrastructure management. \n- **Privilege Sets:** Offers controlled access to switch compliance data, ensuring secure and authorized management interactions.", "x-allOf-name": "convergedinfra.SwitchComplianceDetails", "allOf": [ { "$ref": "#/components/schemas/convergedinfra.BaseComplianceDetails" }, { "type": "object", "description": "Definition of the list of properties defined in 'convergedinfra.SwitchComplianceDetails', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "convergedinfra.SwitchComplianceDetails" ], "default": "convergedinfra.SwitchComplianceDetails", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "convergedinfra.SwitchComplianceDetails" ], "default": "convergedinfra.SwitchComplianceDetails", "x-enum-as-string": true }, "Firmware": { "description": "The firmware of the switch as received from inventory.", "type": "string", "readOnly": true, "x-omitempty": true }, "Model": { "description": "The model information of the switch.", "type": "string", "readOnly": true, "x-omitempty": true }, "Type": { "description": "The type of switch component. It must be set to either Fabric Interconnect, Nexus or MDS.\n* `FabricInterconnect` - The default Switch type of UCSM and IMM mode devices.\n* `NexusDevice` - Switch type of Nexus devices.\n* `MDSDevice` - Switch type of Nexus MDS devices.\n* `EdgeChassisManagementController` - Switch type of Edge Chassis Management Controller.", "type": "string", "enum": [ "FabricInterconnect", "NexusDevice", "MDSDevice", "EdgeChassisManagementController" ], "default": "FabricInterconnect", "readOnly": true, "x-omitempty": true }, "PodCompliance": { "$ref": "#/components/schemas/convergedinfra.PodComplianceInfo.Relationship", "description": "A reference to a convergedinfraPodComplianceInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "StorageCompliances": { "description": "An array of relationships to convergedinfraStorageComplianceDetails resources.", "type": "array", "items": { "$ref": "#/components/schemas/convergedinfra.StorageComplianceDetails.Relationship" }, "nullable": true, "readOnly": true }, "Switch": { "$ref": "intersight-fabric-v3-1.0.11-20260807064027971.json#/components/schemas/network.ElementSummary.Relationship", "description": "A reference to a networkElementSummary resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "convergedinfra.SwitchComplianceDetails.List": { "title": "List of 'convergedinfra.SwitchComplianceDetails' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'convergedinfra.SwitchComplianceDetails' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'convergedinfra.SwitchComplianceDetails' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/convergedinfra.SwitchComplianceDetails" }, "nullable": true } } } ] }, "dnac.Device.Response": { "description": "The response body of a HTTP GET request for the 'dnac.Device' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'dnac.Device' resources.", "x-one-of-name": "dnac.Device.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/dnac.Device.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "dnac.Device": { "title": "Dnac:Device", "description": "The Device object is a comprehensive representation of network devices, facilitating the management and operational integration of network hardware within the system.\n#### Purpose\nA Device object provides detailed insights into the configuration, status, and management of network devices, supporting efficient network operations and maintenance.\n#### Key Concepts\n- **Device Management:** Supports detailed device configuration and status tracking, enhancing network reliability and efficiency.\n- **Identity and Access Control:** Utilizes unique identifiers and privilege sets to ensure secure and controlled interaction with device data.\n- **Operational Integration:** Seamlessly interfaces with other network components, promoting cohesive and efficient network operations.", "x-allOf-name": "dnac.Device", "allOf": [ { "$ref": "#/components/schemas/dnac.InventoryEntity" }, { "type": "object", "description": "Definition of the list of properties defined in 'dnac.Device', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "dnac.Device" ], "default": "dnac.Device", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "dnac.Device" ], "default": "dnac.Device", "x-enum-as-string": true }, "DeviceId": { "description": "Unique identity of the network device.", "type": "string", "x-omitempty": true }, "HostName": { "description": "Host name of the network device.", "type": "string", "x-omitempty": true }, "ManagementIpAddress": { "description": "IP address of the network device.", "type": "string", "x-omitempty": true } } } ] }, "dnac.Device.List": { "title": "List of 'dnac.Device' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'dnac.Device' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'dnac.Device' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/dnac.Device" }, "nullable": true } } } ] }, "dnac.DeviceInterface.Response": { "description": "The response body of a HTTP GET request for the 'dnac.DeviceInterface' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'dnac.DeviceInterface' resources.", "x-one-of-name": "dnac.DeviceInterface.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/dnac.DeviceInterface.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "dnac.DeviceInterface": { "title": "Dnac:Device Interface", "description": "The DeviceInterface object represents the network device interfaces, offering a structured approach to managing device connections and configurations.\n#### Purpose\nA DeviceInterface object provides a detailed framework for managing the interfaces of network devices, supporting efficient communication and connectivity.\n#### Key Concepts\n- **Interface Management:** Allows for detailed configuration and tracking of device interfaces, enhancing network control.\n- **Security and Access:** Ensures secure interaction through privilege sets and controlled access mechanisms.\n- **Operational Integration:** fInterfaces seamlessly with network devices, promoting robust and efficient connectivity.", "x-allOf-name": "dnac.DeviceInterface", "allOf": [ { "$ref": "#/components/schemas/dnac.InventoryEntity" }, { "type": "object", "description": "Definition of the list of properties defined in 'dnac.DeviceInterface', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "dnac.DeviceInterface" ], "default": "dnac.DeviceInterface", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "dnac.DeviceInterface" ], "default": "dnac.DeviceInterface", "x-enum-as-string": true }, "AdminStatus": { "description": "Administrator status for network device interface.", "type": "string", "x-omitempty": true }, "DeviceId": { "description": "Identity of network device.", "type": "string", "x-omitempty": true }, "InterfaceId": { "description": "Unique identity of network device interface.", "type": "string", "x-omitempty": true }, "InterfaceName": { "description": "The name for the network device interface.", "type": "string", "x-omitempty": true }, "InterfaceType": { "description": "Interface type for network device interface.", "type": "string", "x-omitempty": true }, "PortType": { "description": "Port type for network device interface.", "type": "string", "x-omitempty": true } } } ] }, "dnac.DeviceInterface.List": { "title": "List of 'dnac.DeviceInterface' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'dnac.DeviceInterface' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'dnac.DeviceInterface' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/dnac.DeviceInterface" }, "nullable": true } } } ] }, "dnac.ExternalBorderNode.Response": { "description": "The response body of a HTTP GET request for the 'dnac.ExternalBorderNode' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'dnac.ExternalBorderNode' resources.", "x-one-of-name": "dnac.ExternalBorderNode.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/dnac.ExternalBorderNode.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "dnac.ExternalBorderNode": { "title": "Dnac:External Border Node", "description": "The ExternalBorderNode object represents the external boundaries of a network, focusing on the management and configuration of nodes that interact with external network entities.\n#### Purpose\nAn ExternalBorderNode object is essential for defining and managing the interfaces between internal and external networks, ensuring secure and efficient communication.\n#### Key Concepts\n- **Boundary Definition:** Specifies the roles and configurations of external border nodes, clarifying their position within the network architecture.\n- **Security and Roles Management:** Enables detailed role assignment and security configuration, safeguarding network boundaries.\n- **Interoperability:** Designed to facilitate interaction with external networks, promoting seamless and secure connectivity.", "x-allOf-name": "dnac.ExternalBorderNode", "allOf": [ { "$ref": "#/components/schemas/dnac.InventoryEntity" }, { "type": "object", "description": "Definition of the list of properties defined in 'dnac.ExternalBorderNode', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "dnac.ExternalBorderNode" ], "default": "dnac.ExternalBorderNode", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "dnac.ExternalBorderNode" ], "default": "dnac.ExternalBorderNode", "x-enum-as-string": true }, "ExternalBorderNodeId": { "description": "External border node's id.", "type": "string", "x-omitempty": true }, "ExternalBorderNodeName": { "description": "External border node's name.", "type": "string", "x-omitempty": true }, "FabricSiteId": { "description": "Fabric Site id in UUID format.", "type": "string", "x-omitempty": true }, "ImportExternalRoutes": { "description": "Flag to determine if Border Node is External or Internal.", "type": "boolean", "x-omitempty": true }, "Roles": { "type": "array", "items": { "description": "Roles for external border node.", "type": "string", "x-omitempty": true }, "nullable": true } } } ] }, "dnac.ExternalBorderNode.List": { "title": "List of 'dnac.ExternalBorderNode' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'dnac.ExternalBorderNode' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'dnac.ExternalBorderNode' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/dnac.ExternalBorderNode" }, "nullable": true } } } ] }, "dnac.ExternalBorderNodeInterface.Response": { "description": "The response body of a HTTP GET request for the 'dnac.ExternalBorderNodeInterface' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'dnac.ExternalBorderNodeInterface' resources.", "x-one-of-name": "dnac.ExternalBorderNodeInterface.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/dnac.ExternalBorderNodeInterface.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "dnac.ExternalBorderNodeInterface": { "title": "Dnac:External Border Node Interface", "description": "The ExternalBorderNodeInterface object serves as the gateway between a network and external entities, focusing on interface management and configuration.\n#### Purpose\nAn ExternalBorderNodeInterface object provides the framework for managing external network interfaces, supporting secure and efficient data exchange.\n#### Key Concepts\n- **Interface Management:** Offers detailed configuration options for external interfaces, enhancing control over data flow.\n- **Security and Access Control:** Ensures secure interaction through privilege sets and controlled access mechanisms.\n- **Network Integration:** Interfaces seamlessly with external networks, promoting robust and secure connectivity.", "x-allOf-name": "dnac.ExternalBorderNodeInterface", "allOf": [ { "$ref": "#/components/schemas/dnac.InventoryEntity" }, { "type": "object", "description": "Definition of the list of properties defined in 'dnac.ExternalBorderNodeInterface', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "dnac.ExternalBorderNodeInterface" ], "default": "dnac.ExternalBorderNodeInterface", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "dnac.ExternalBorderNodeInterface" ], "default": "dnac.ExternalBorderNodeInterface", "x-enum-as-string": true }, "AdminStatus": { "description": "Administrator status for external border node interface.", "type": "string", "x-omitempty": true }, "ExternalBorderNodeId": { "description": "External border node's id.", "type": "string", "x-omitempty": true }, "InterfaceId": { "description": "The Moid for the interface in the external border node.", "type": "string", "x-omitempty": true }, "InterfaceName": { "description": "The name for the external border node's interface.", "type": "string", "x-omitempty": true }, "InterfaceType": { "description": "Interface type for external border node interface.", "type": "string", "x-omitempty": true }, "PortType": { "description": "Port type for external border node interface.", "type": "string", "x-omitempty": true } } } ] }, "dnac.ExternalBorderNodeInterface.List": { "title": "List of 'dnac.ExternalBorderNodeInterface' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'dnac.ExternalBorderNodeInterface' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'dnac.ExternalBorderNodeInterface' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/dnac.ExternalBorderNodeInterface" }, "nullable": true } } } ] }, "dnac.FabricSite.Response": { "description": "The response body of a HTTP GET request for the 'dnac.FabricSite' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'dnac.FabricSite' resources.", "x-one-of-name": "dnac.FabricSite.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/dnac.FabricSite.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "dnac.FabricSite": { "title": "Dnac:Fabric Site", "description": "The FabricSite object is a critical component within the network management framework, designed to represent and manage the physical or logical sites within the network fabric. This provides a structured approach to organizing and accessing site-specific details, aiding in efficient network operations and resource allocation.\n#### Purpose\nA FabricSite facilitates the management and operational understanding of network sites. This provides a holistic view of site configurations, enabling seamless integration and interaction with other network entities and services.\n#### Key Concepts\n- **Hierarchy Representation:** FabricSite objects maintain a hierarchical structure, allowing for organized and intuitive navigation of site relationships.\n- **Access Control:** Privilege sets ensure secure and controlled access, allowing only authorized users to interact with FabricSite data.\n- **Integration:** FabricSite objects are integral to workflows and network operations, supporting robust interactions with devices, interfaces, and services.", "x-allOf-name": "dnac.FabricSite", "allOf": [ { "$ref": "#/components/schemas/dnac.InventoryEntity" }, { "type": "object", "description": "Definition of the list of properties defined in 'dnac.FabricSite', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "dnac.FabricSite" ], "default": "dnac.FabricSite", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "dnac.FabricSite" ], "default": "dnac.FabricSite", "x-enum-as-string": true }, "AuthenticationProfileName": { "description": "Authentication profile name.", "type": "string", "x-omitempty": true }, "FabricSiteId": { "description": "UUID for the Fabric Site.", "type": "string", "x-omitempty": true }, "FabricSiteNameHierarchy": { "description": "Fabric site name hierarchy.", "type": "string", "x-omitempty": true }, "IsPubSubEnabled": { "description": "Pub sub for the fabric site.", "type": "string", "x-omitempty": true }, "SiteId": { "description": "Site id for the fabric site.", "type": "string", "x-omitempty": true } } } ] }, "dnac.FabricSite.List": { "title": "List of 'dnac.FabricSite' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'dnac.FabricSite' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'dnac.FabricSite' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/dnac.FabricSite" }, "nullable": true } } } ] }, "dnac.InventoryEntity": { "title": "Dnac:Inventory Entity", "description": "Base object type for all Dnac Inventory items.", "x-allOf-name": "dnac.InventoryEntity", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'dnac.InventoryEntity', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "dnac.Device", "dnac.DeviceInterface", "dnac.ExternalBorderNode", "dnac.ExternalBorderNodeInterface", "dnac.FabricSite", "dnac.Site", "dnac.SiteIpPool", "dnac.Template", "dnac.Transit", "dnac.VirtualNetworkFabricSite" ], "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "dnac.Device", "dnac.DeviceInterface", "dnac.ExternalBorderNode", "dnac.ExternalBorderNodeInterface", "dnac.FabricSite", "dnac.Site", "dnac.SiteIpPool", "dnac.Template", "dnac.Transit", "dnac.VirtualNetworkFabricSite" ], "x-enum-as-string": true }, "RegisteredDevice": { "$ref": "#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "dnac.Site.Response": { "description": "The response body of a HTTP GET request for the 'dnac.Site' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'dnac.Site' resources.", "x-one-of-name": "dnac.Site.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/dnac.Site.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "dnac.Site": { "title": "Dnac:Site", "description": "The Site object serves as a detailed representation of a network site, encompassing essential site information required for comprehensive network management. This aids in the logical organization and integration of network sites within broader network operations.\n#### Purpose\nA Site object provides detailed insights into the configuration and status of a network site. It supports network administrators in effectively managing site-specific data, contributing to streamlined network operations.\n#### Key Concepts\n- **Identity Management:** Unique identifiers ensure precise tracking and management of individual sites.\n- **Security and Permissions:** Access control mechanisms safeguard site data, ensuring interaction is restricted to authorized personnel.\n- **Operational Integration:** Site objects are designed to work seamlessly with other network components, promoting efficiency and coherence in network activities.", "x-allOf-name": "dnac.Site", "allOf": [ { "$ref": "#/components/schemas/dnac.InventoryEntity" }, { "type": "object", "description": "Definition of the list of properties defined in 'dnac.Site', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "dnac.Site" ], "default": "dnac.Site", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "dnac.Site" ], "default": "dnac.Site", "x-enum-as-string": true }, "FabricSiteNameHierarchy": { "description": "Fabric site name hierarchy.", "type": "string", "x-omitempty": true }, "SiteId": { "description": "Identification for the Site.", "type": "string", "x-omitempty": true } } } ] }, "dnac.Site.List": { "title": "List of 'dnac.Site' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'dnac.Site' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'dnac.Site' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/dnac.Site" }, "nullable": true } } } ] }, "dnac.SiteIpPool.Response": { "description": "The response body of a HTTP GET request for the 'dnac.SiteIpPool' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'dnac.SiteIpPool' resources.", "x-one-of-name": "dnac.SiteIpPool.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/dnac.SiteIpPool.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "dnac.SiteIpPool": { "title": "Dnac:Site Ip Pool", "description": "The SiteIpPool object provides a structured approach to managing IP pools associated with network sites, ensuring efficient and organized IP address allocation within the network infrastructure.\n#### Purpose\nA SiteIpPool object serves as a central repository for IP pool configurations tied to specific network sites, aiding in systematic IP address management and allocation.\n#### Key Concepts\n- **IP Pool Configuration:** Allows for detailed specification and management of IP pools, facilitating precise control over IP address distribution.\n- **Hierarchical Organization:** Maintains a structured hierarchy for site association, promoting clarity and order in IP management.\n- **Secure Access:** Utilizes privilege sets to control access and modification rights, ensuring secure interaction with IP pool data.", "x-allOf-name": "dnac.SiteIpPool", "allOf": [ { "$ref": "#/components/schemas/dnac.InventoryEntity" }, { "type": "object", "description": "Definition of the list of properties defined in 'dnac.SiteIpPool', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "dnac.SiteIpPool" ], "default": "dnac.SiteIpPool", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "dnac.SiteIpPool" ], "default": "dnac.SiteIpPool", "x-enum-as-string": true }, "IpPoolCidr": { "description": "Ip Pool Cidr in format e.g. 10.0.0.0/24.", "type": "string", "x-omitempty": true }, "IpPoolId": { "description": "Site ip pool identification.", "type": "string", "x-omitempty": true }, "IpPoolName": { "description": "Name for the site ip pool.", "type": "string", "x-omitempty": true }, "SiteId": { "description": "Site to which ip pool is associated with.", "type": "string", "x-omitempty": true }, "SiteNameHierarchy": { "description": "Hierarchy of the site names.", "type": "string", "x-omitempty": true } } } ] }, "dnac.SiteIpPool.List": { "title": "List of 'dnac.SiteIpPool' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'dnac.SiteIpPool' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'dnac.SiteIpPool' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/dnac.SiteIpPool" }, "nullable": true } } } ] }, "dnac.Template.Response": { "description": "The response body of a HTTP GET request for the 'dnac.Template' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'dnac.Template' resources.", "x-one-of-name": "dnac.Template.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/dnac.Template.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "dnac.Template": { "title": "Dnac:Template", "description": "The Template object encapsulates the configuration and management of templates within the network system, supporting standardized and efficient deployment of configurations.\n#### Purpose\nA Template object serves as the blueprint for network configurations, enabling systematic and consistent deployment across the network infrastructure.\n#### Key Concepts\n- **Configuration Standardization:** Facilitates the creation and management of templates, promoting consistency in network configuration.\n- **Versioning and Access Control:** Supports version control and secure access, ensuring safe updates and management.\n- **Integration with Network Processes:** Designed to work cohesively with other network elements, enhancing overall efficiency and reliability.", "x-allOf-name": "dnac.Template", "allOf": [ { "$ref": "#/components/schemas/dnac.InventoryEntity" }, { "type": "object", "description": "Definition of the list of properties defined in 'dnac.Template', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "dnac.Template" ], "default": "dnac.Template", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "dnac.Template" ], "default": "dnac.Template", "x-enum-as-string": true }, "Composite": { "description": "Value indicates the template is composite.", "type": "string", "x-omitempty": true }, "ProjectId": { "description": "Identity of the project template.", "type": "string", "x-omitempty": true }, "ProjectName": { "description": "Name of the project template.", "type": "string", "x-omitempty": true }, "TemplateId": { "description": "Unique identity of the template.", "type": "string", "x-omitempty": true }, "TemplateName": { "description": "Name assigned to the template.", "type": "string", "x-omitempty": true } } } ] }, "dnac.Template.List": { "title": "List of 'dnac.Template' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'dnac.Template' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'dnac.Template' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/dnac.Template" }, "nullable": true } } } ] }, "dnac.Transit.Response": { "description": "The response body of a HTTP GET request for the 'dnac.Transit' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'dnac.Transit' resources.", "x-one-of-name": "dnac.Transit.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/dnac.Transit.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "dnac.Transit": { "title": "Dnac:Transit", "description": "The Transit object is integral to network connectivity, representing transit paths and configurations that facilitate communication between different network segments.\n#### Purpose\nA Transit object defines the connectivity pathways within the network, enabling efficient routing and communication between distinct network areas.\n#### Key Concepts\n- **Connectivity Management:** Facilitates the establishment and management of transit paths, optimizing network traffic flow.\n- **Identity Control:** Utilizes unique identifiers for precise tracking and management of transit entities.\n- **Integration with Network Elements:** Seamlessly interfaces with other network components, enhancing overall network performance.", "x-allOf-name": "dnac.Transit", "allOf": [ { "$ref": "#/components/schemas/dnac.InventoryEntity" }, { "type": "object", "description": "Definition of the list of properties defined in 'dnac.Transit', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "dnac.Transit" ], "default": "dnac.Transit", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "dnac.Transit" ], "default": "dnac.Transit", "x-enum-as-string": true }, "TransitId": { "description": "Identification for the Transit.", "type": "string", "x-omitempty": true }, "TransitName": { "description": "Name identifier for the Transit.", "type": "string", "x-omitempty": true }, "TransitType": { "description": "Transit type for the transit.", "type": "string", "x-omitempty": true } } } ] }, "dnac.Transit.List": { "title": "List of 'dnac.Transit' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'dnac.Transit' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'dnac.Transit' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/dnac.Transit" }, "nullable": true } } } ] }, "dnac.VirtualNetworkFabricSite.Response": { "description": "The response body of a HTTP GET request for the 'dnac.VirtualNetworkFabricSite' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'dnac.VirtualNetworkFabricSite' resources.", "x-one-of-name": "dnac.VirtualNetworkFabricSite.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/dnac.VirtualNetworkFabricSite.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "dnac.VirtualNetworkFabricSite": { "title": "Dnac:Virtual Network Fabric Site", "description": "The VirtualNetworkFabricSite object encapsulates the virtual networking aspects of a fabric site, enabling advanced network configurations and interactions. It plays a pivotal role in the deployment and management of virtual networks within the fabric.\n#### Purpose\nA VirtualNetworkFabricSite object facilitates the establishment and management of virtual networks associated with a fabric site, offering flexibility and scalability in network architecture.\n#### Key Concepts\n- **Virtual Network Management:** Supports the creation, monitoring, and modification of virtual networks, enhancing network adaptability.\n- **Identity and Access Control:** Ensures secure and efficient management through unique identifiers and privilege sets.\n- **Network Integration:** Seamlessly integrates with physical and logical network elements, fostering cohesive network operations.", "x-allOf-name": "dnac.VirtualNetworkFabricSite", "allOf": [ { "$ref": "#/components/schemas/dnac.InventoryEntity" }, { "type": "object", "description": "Definition of the list of properties defined in 'dnac.VirtualNetworkFabricSite', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "dnac.VirtualNetworkFabricSite" ], "default": "dnac.VirtualNetworkFabricSite", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "dnac.VirtualNetworkFabricSite" ], "default": "dnac.VirtualNetworkFabricSite", "x-enum-as-string": true }, "FabricSiteNameHierarchy": { "description": "Fabric site name hierarchy.", "type": "string", "x-omitempty": true }, "SiteId": { "description": "Site id for the virtual network fabric site.", "type": "string", "x-omitempty": true }, "VirtualNetworkId": { "description": "Virtual network id fro the virtual network fabric site.", "type": "string", "x-omitempty": true }, "VirtualNetworkName": { "description": "Virtual network name for the virtual network fabric site.", "type": "string", "x-omitempty": true } } } ] }, "dnac.VirtualNetworkFabricSite.List": { "title": "List of 'dnac.VirtualNetworkFabricSite' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'dnac.VirtualNetworkFabricSite' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'dnac.VirtualNetworkFabricSite' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/dnac.VirtualNetworkFabricSite" }, "nullable": true } } } ] }, "energy.DailyMetrics": { "title": "Energy:Daily Metrics", "description": "Returns carbon intensity, power breakdown, and electricity rate power metrics for a set of locations and a time span.", "x-allOf-name": "energy.DailyMetrics", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" } ] }, "energy.Metrics": { "title": "Energy:Metrics", "description": "Returns carbon intensity, power breakdown, and electricity rate power metrics for a set of locations and a time span.", "x-allOf-name": "energy.Metrics", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" } ] }, "feedback.FeedbackData": { "title": "Feedback:Feedback Data", "description": "Feedback data collected from the user through the UI.", "x-allOf-name": "feedback.FeedbackData", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'feedback.FeedbackData', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "feedback.FeedbackData" ], "default": "feedback.FeedbackData", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "feedback.FeedbackData" ], "default": "feedback.FeedbackData", "x-enum-as-string": true }, "AccountName": { "description": "Account name of the feedback sender, copied for persistence in case of account removal.", "type": "string", "x-omitempty": true }, "AlternativeFollowUpEmails": { "type": "array", "items": { "description": "User's alternative email addresses for follow-up.", "type": "string", "pattern": "^$|^[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$", "x-omitempty": true }, "maxItems": 5, "nullable": true }, "Comment": { "description": "User feedback text (a bug or a suggestion).", "type": "string", "maxLength": 5000, "x-omitempty": true }, "Email": { "description": "User's email address details.", "type": "string", "x-omitempty": true }, "Evaluation": { "description": "Evaluation rating provided by the user to capture user sentiment regarding the issue.\n* `Excellent` - Option indicating user's excellent evaluation.\n* `Poor` - Option indicating user's poor evaluation.\n* `Fair` - Option indicating user's fair evaluation.\n* `Good` - Option indicating user's good evaluation.", "deprecated": true, "x-sunset": "2027-03-01", "type": "string", "enum": [ "Excellent", "Poor", "Fair", "Good" ], "default": "Excellent", "x-omitempty": true }, "FollowUp": { "description": "User's consent for follow-up communication.", "type": "boolean", "x-omitempty": true }, "FullStoryUrl": { "description": "URL generated by FullStory linking to the UI session's recording.", "type": "string", "x-omitempty": true }, "ProductSatisfactionScale": { "description": "User's satisfaction with the product on a 0-10 scale.", "type": "integer", "format": "int64", "minimum": 0, "maximum": 10, "x-omitempty": true }, "SurveyCompleted": { "description": "Survey completion status (True if completed, False otherwise).", "type": "boolean", "x-omitempty": true }, "TraceIds": { "description": "Collection of last traceId for replicating the user's last activity.", "nullable": true, "x-omitempty": true }, "Type": { "description": "Type of the feedback from user.\n* `Evaluation` - User's feedback classified as an evaluation.\n* `Bug` - User's feedback classified as a bug.\n* `Survey` - User's response to a survey.", "type": "string", "enum": [ "Evaluation", "Bug", "Survey" ], "default": "Evaluation", "x-omitempty": true } } } ] }, "feedback.FeedbackPost": { "title": "Feedback:Feedback Post", "description": "The FeedbackPost object serves as the initial entry point for user feedback within the system. This provides a mechanism for users to submit their comments and evaluations directly through the user interface. \n#### Purpose\nFeedback Post enables users to capture and submit first-hand feedback directly from the interface, ensuring that original input is accurately preserved and processed. It supports seamless UI integration, immediate submission, and reliable data retention for effective analysis and response\n#### Key Concepts\n- **User-Driven:** Facilitates direct interaction between users and the feedback system, ensuring that user voices are heard and considered.\n- **Shared Resource:** Functions as a shared organizational resource, accessible across various departments and privilege sets.", "x-allOf-name": "feedback.FeedbackPost", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'feedback.FeedbackPost', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "feedback.FeedbackPost" ], "default": "feedback.FeedbackPost", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "feedback.FeedbackPost" ], "default": "feedback.FeedbackPost", "x-enum-as-string": true }, "FeedbackData": { "description": "Feedback collected from the user and latest activity.", "$ref": "#/components/schemas/feedback.FeedbackData", "x-omitempty": true }, "Account": { "$ref": "#/components/schemas/iam.Account.Relationship", "description": "A reference to a iamAccount resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "fmc.Device.Response": { "description": "The response body of a HTTP GET request for the 'fmc.Device' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'fmc.Device' resources.", "x-one-of-name": "fmc.Device.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/fmc.Device.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "fmc.Device": { "title": "Fmc:Device", "description": "The device details of the FMC.", "x-allOf-name": "fmc.Device", "allOf": [ { "$ref": "#/components/schemas/fmc.InventoryEntity" }, { "type": "object", "description": "Definition of the list of properties defined in 'fmc.Device', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "fmc.Device" ], "default": "fmc.Device", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "fmc.Device" ], "default": "fmc.Device", "x-enum-as-string": true }, "DeviceId": { "description": "Unique identifier for the device.", "type": "string", "readOnly": true, "x-omitempty": true }, "DomainId": { "description": "Unique identifier for the domain.", "type": "string", "readOnly": true, "x-omitempty": true }, "Name": { "description": "User assigned name for the device.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "fmc.Device.List": { "title": "List of 'fmc.Device' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'fmc.Device' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'fmc.Device' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/fmc.Device" }, "nullable": true } } } ] }, "fmc.DeviceHaPair.Response": { "description": "The response body of a HTTP GET request for the 'fmc.DeviceHaPair' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'fmc.DeviceHaPair' resources.", "x-one-of-name": "fmc.DeviceHaPair.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/fmc.DeviceHaPair.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "fmc.DeviceHaPair": { "title": "Fmc:Device Ha Pair", "description": "FMC HA device pair details.", "x-allOf-name": "fmc.DeviceHaPair", "allOf": [ { "$ref": "#/components/schemas/fmc.InventoryEntity" }, { "type": "object", "description": "Definition of the list of properties defined in 'fmc.DeviceHaPair', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "fmc.DeviceHaPair" ], "default": "fmc.DeviceHaPair", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "fmc.DeviceHaPair" ], "default": "fmc.DeviceHaPair", "x-enum-as-string": true }, "DeviceId": { "description": "Unique identifier for the device.", "type": "string", "readOnly": true, "x-omitempty": true }, "DomainId": { "description": "Unique identifier for the domain.", "type": "string", "readOnly": true, "x-omitempty": true }, "Name": { "description": "User assigned name for the device.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "fmc.DeviceHaPair.List": { "title": "List of 'fmc.DeviceHaPair' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'fmc.DeviceHaPair' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'fmc.DeviceHaPair' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/fmc.DeviceHaPair" }, "nullable": true } } } ] }, "fmc.Domain.Response": { "description": "The response body of a HTTP GET request for the 'fmc.Domain' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'fmc.Domain' resources.", "x-one-of-name": "fmc.Domain.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/fmc.Domain.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "fmc.Domain": { "title": "Fmc:Domain", "description": "The domain details of the FMC.", "x-allOf-name": "fmc.Domain", "allOf": [ { "$ref": "#/components/schemas/fmc.InventoryEntity" }, { "type": "object", "description": "Definition of the list of properties defined in 'fmc.Domain', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "fmc.Domain" ], "default": "fmc.Domain", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "fmc.Domain" ], "default": "fmc.Domain", "x-enum-as-string": true }, "Name": { "description": "User assigned name for the FMC domain.", "type": "string", "readOnly": true, "x-omitempty": true }, "Uuid": { "description": "Unique identifier for the domain.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "fmc.Domain.List": { "title": "List of 'fmc.Domain' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'fmc.Domain' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'fmc.Domain' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/fmc.Domain" }, "nullable": true } } } ] }, "fmc.InventoryEntity": { "title": "Fmc:Inventory Entity", "description": "The base object type for all APIC inventory items.", "x-allOf-name": "fmc.InventoryEntity", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'fmc.InventoryEntity', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "fmc.Device", "fmc.DeviceHaPair", "fmc.Domain", "fmc.PhysicalInterface" ], "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "fmc.Device", "fmc.DeviceHaPair", "fmc.Domain", "fmc.PhysicalInterface" ], "x-enum-as-string": true }, "RegisteredDevice": { "$ref": "#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "fmc.PhysicalInterface.Response": { "description": "The response body of a HTTP GET request for the 'fmc.PhysicalInterface' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'fmc.PhysicalInterface' resources.", "x-one-of-name": "fmc.PhysicalInterface.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/fmc.PhysicalInterface.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "fmc.PhysicalInterface": { "title": "Fmc:Physical Interface", "description": "Physical interface of the FMC device.", "x-allOf-name": "fmc.PhysicalInterface", "allOf": [ { "$ref": "#/components/schemas/fmc.InventoryEntity" }, { "type": "object", "description": "Definition of the list of properties defined in 'fmc.PhysicalInterface', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "fmc.PhysicalInterface" ], "default": "fmc.PhysicalInterface", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "fmc.PhysicalInterface" ], "default": "fmc.PhysicalInterface", "x-enum-as-string": true }, "DeviceId": { "description": "Physical interface device Id.", "type": "string", "readOnly": true, "x-omitempty": true }, "DomainId": { "description": "Physical interface domain Id.", "type": "string", "readOnly": true, "x-omitempty": true }, "Name": { "description": "The name for the physical interface.", "type": "string", "readOnly": true, "x-omitempty": true }, "PhysicalInterfaceId": { "description": "The id for the physical interface.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "fmc.PhysicalInterface.List": { "title": "List of 'fmc.PhysicalInterface' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'fmc.PhysicalInterface' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'fmc.PhysicalInterface' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/fmc.PhysicalInterface" }, "nullable": true } } } ] }, "iaas.ConnectorPack.Response": { "description": "The response body of a HTTP GET request for the 'iaas.ConnectorPack' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iaas.ConnectorPack' resources.", "x-one-of-name": "iaas.ConnectorPack.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iaas.ConnectorPack.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iaas.ConnectorPack.Relationship": { "description": "A relationship to the 'iaas.ConnectorPack' resource, or the expanded 'iaas.ConnectorPack' resource, or the 'null' value.", "x-one-of-name": "iaas.ConnectorPack.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iaas.ConnectorPack" } ], "discriminator": { "propertyName": "ClassId" } }, "iaas.ConnectorPack": { "title": "Iaas:Connector Pack", "description": "The ConnectorPack object is essential for managing connector pack versions within UCS Director (UCSD), facilitating configuration and dependency management. \n#### Purpose \nConnectorPack documents the versions and states of connector packs, supporting efficient management and deployment of connectors in UCSD. \n#### Key Concepts \n- **Version Management:** Tracks connector pack versions, ensuring compatibility and optimal performance. \n- **Dependency Tracking:** Monitors dependencies, aiding in configuration management and deployment strategies. \n- **Read-Only Access:** Ensures connector pack information is available for review without alteration.", "x-allOf-name": "iaas.ConnectorPack", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iaas.ConnectorPack', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iaas.ConnectorPack" ], "default": "iaas.ConnectorPack", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iaas.ConnectorPack" ], "default": "iaas.ConnectorPack", "x-enum-as-string": true }, "CompleteVersion": { "description": "Complete version of the connector pack including build number.", "type": "string", "readOnly": true, "x-omitempty": true }, "DependencyNames": { "type": "array", "items": { "description": "List of dependent connectors on the UCSD for this connector. For example BigData depends on UCS Connector.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "DownloadedVersion": { "description": "Version of the connector pack that is last downloaded successfully to UCSD.", "type": "string", "readOnly": true, "x-omitempty": true }, "Name": { "description": "Name of the connector pack running on the UCSD.", "type": "string", "readOnly": true, "x-omitempty": true }, "State": { "description": "State of the connector pack whether it is enabled or disabled.", "type": "string", "readOnly": true, "x-omitempty": true }, "Version": { "description": "Version of the connector pack.", "type": "string", "readOnly": true, "x-omitempty": true }, "Guid": { "$ref": "#/components/schemas/iaas.UcsdInfo.Relationship", "description": "A reference to a iaasUcsdInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "iaas.ConnectorPack.List": { "title": "List of 'iaas.ConnectorPack' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iaas.ConnectorPack' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iaas.ConnectorPack' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iaas.ConnectorPack" }, "nullable": true } } } ] }, "iaas.CustomTaskInfo.Response": { "description": "The response body of a HTTP GET request for the 'iaas.CustomTaskInfo' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iaas.CustomTaskInfo' resources.", "x-one-of-name": "iaas.CustomTaskInfo.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iaas.CustomTaskInfo.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iaas.CustomTaskInfo.Relationship": { "description": "A relationship to the 'iaas.CustomTaskInfo' resource, or the expanded 'iaas.CustomTaskInfo' resource, or the 'null' value.", "x-one-of-name": "iaas.CustomTaskInfo.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iaas.CustomTaskInfo" } ], "discriminator": { "propertyName": "ClassId" } }, "iaas.CustomTaskInfo": { "title": "Iaas:Custom Task Info", "description": "The CustomTaskInfo object offers insights into the execution of custom tasks within UCS Director (UCSD), supporting workflow customization and management. \n#### Purpose \nCustomTaskInfo documents execution details of custom tasks, aiding in workflow personalization and optimization. \n#### Key Concepts \n- **Custom Task Execution:** Tracks execution of custom tasks, supporting process customization and refinement. \n- **Read-Only Access:** Ensures secure access to custom task data without alteration.", "x-allOf-name": "iaas.CustomTaskInfo", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iaas.CustomTaskInfo', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iaas.CustomTaskInfo" ], "default": "iaas.CustomTaskInfo", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iaas.CustomTaskInfo" ], "default": "iaas.CustomTaskInfo", "x-enum-as-string": true }, "TaskDescription": { "description": "Task decription or Comment of the Custom task.", "type": "string", "readOnly": true, "x-omitempty": true }, "TaskExecutionCount": { "description": "Number of times this task has executed.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "TaskLabel": { "description": "Task Label in the Workflow.", "type": "string", "readOnly": true, "x-omitempty": true }, "TaskName": { "description": "Name of the Custom Task in UCSD.", "type": "string", "readOnly": true, "x-omitempty": true }, "Guid": { "$ref": "#/components/schemas/iaas.UcsdInfo.Relationship", "description": "A reference to a iaasUcsdInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "iaas.CustomTaskInfo.List": { "title": "List of 'iaas.CustomTaskInfo' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iaas.CustomTaskInfo' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iaas.CustomTaskInfo' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iaas.CustomTaskInfo" }, "nullable": true } } } ] }, "iaas.DeviceStatus.Response": { "description": "The response body of a HTTP GET request for the 'iaas.DeviceStatus' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iaas.DeviceStatus' resources.", "x-one-of-name": "iaas.DeviceStatus.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iaas.DeviceStatus.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iaas.DeviceStatus.Relationship": { "description": "A relationship to the 'iaas.DeviceStatus' resource, or the expanded 'iaas.DeviceStatus' resource, or the 'null' value.", "x-one-of-name": "iaas.DeviceStatus.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iaas.DeviceStatus" } ], "discriminator": { "propertyName": "ClassId" } }, "iaas.DeviceStatus": { "title": "Iaas:Device Status", "description": "The DeviceStatus object is pivotal in managing infrastructure accounts within UCS Director (UCSD), offering insights into connection status and device details. It aids in maintaining connectivity and operational integrity. \n#### Purpose \nDeviceStatus provides detailed information about infrastructure accounts managed by UCSD, supporting connection monitoring and device management. \n#### Key Concepts \n- **Connection Monitoring:** Tracks connection status between UCSD and managed devices, ensuring operational reliability. \n- **Device Insights:** Offers comprehensive details about device vendors, models, and versions, aiding in effective management. \n- **Read-Only Access:** Ensures secure access to device information without modification.", "x-allOf-name": "iaas.DeviceStatus", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iaas.DeviceStatus', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iaas.DeviceStatus" ], "default": "iaas.DeviceStatus", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iaas.DeviceStatus" ], "default": "iaas.DeviceStatus", "x-enum-as-string": true }, "AccountName": { "description": "The UCSD infra account name. Account Name is created when UCSD admin adds any new infra account (Physical/Virtual/Compute/Network) to be managed by UCSD.", "type": "string", "readOnly": true, "x-omitempty": true }, "AccountType": { "description": "The UCSD Infra Account type.", "type": "string", "readOnly": true, "x-omitempty": true }, "Category": { "description": "The UCSD Infra Account category.", "type": "string", "readOnly": true, "x-omitempty": true }, "ClaimStatus": { "description": "Describes if the device is claimed in Intersight or not.\n* `Unknown` - If UCS Director managed account claim status information is unknown.\n* `Yes` - If UCS Director managed account is claimed in Intersight.\n* `No` - If UCS Director managed account is not claimed in Intersight.\n* `Not Applicable` - If UCS Director managed account is not capable of providing claim status information.", "type": "string", "enum": [ "Unknown", "Yes", "No", "Not Applicable" ], "default": "Unknown", "readOnly": true, "x-omitempty": true }, "ConnectionStatus": { "description": "Describes about the connection status between the UCSD and the actual end device.", "type": "string", "readOnly": true, "x-omitempty": true }, "DeviceModel": { "description": "Describes about the device model.", "type": "string", "readOnly": true, "x-omitempty": true }, "DeviceVendor": { "description": "Describes about the device vendor/manufacturer of the device.", "type": "string", "readOnly": true, "x-omitempty": true }, "DeviceVersion": { "description": "Describes about the current firmware version running on the device.", "type": "string", "readOnly": true, "x-omitempty": true }, "IpAddress": { "description": "The IPAddress of the device.", "type": "string", "readOnly": true, "x-omitempty": true }, "Pod": { "description": "Describes about the pod to which this device belongs to in UCSD.", "type": "string", "readOnly": true, "x-omitempty": true }, "PodType": { "description": "Describes about the podType of Pod to which this device belongs to in UCSD.", "type": "string", "readOnly": true, "x-omitempty": true }, "Guid": { "$ref": "#/components/schemas/iaas.UcsdInfo.Relationship", "description": "A reference to a iaasUcsdInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "iaas.DeviceStatus.List": { "title": "List of 'iaas.DeviceStatus' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iaas.DeviceStatus' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iaas.DeviceStatus' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iaas.DeviceStatus" }, "nullable": true } } } ] }, "iaas.DiagnosticMessages.Response": { "description": "The response body of a HTTP GET request for the 'iaas.DiagnosticMessages' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iaas.DiagnosticMessages' resources.", "x-one-of-name": "iaas.DiagnosticMessages.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iaas.DiagnosticMessages.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iaas.DiagnosticMessages": { "title": "Iaas:Diagnostic Messages", "description": "The DiagnosticMessages object is vital for capturing diagnostic alerts and messages within UCS Director (UCSD), aiding in system health monitoring and issue resolution. \n#### Purpose\nDiagnosticMessages document alerts and recommendations, supporting proactive system management and troubleshooting. \n#### Key Concepts \n- **Alert Tracking:** Records diagnostic alerts, aiding in system health assessment and management. \n- **Recommendation Documentation:** Provides actionable recommendations for alert resolution, supporting efficient troubleshooting. \n- **Read-Only Access:** Ensures secure access to diagnostic data without alteration.", "x-allOf-name": "iaas.DiagnosticMessages", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iaas.DiagnosticMessages', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iaas.DiagnosticMessages" ], "default": "iaas.DiagnosticMessages", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iaas.DiagnosticMessages" ], "default": "iaas.DiagnosticMessages", "x-enum-as-string": true }, "Category": { "description": "Message category of the alerts.", "type": "string", "readOnly": true, "x-omitempty": true }, "Guid": { "description": "Unique ID of UCS Director getting registerd with Intersight.", "type": "string", "readOnly": true, "x-omitempty": true }, "Item": { "description": "Message target type of the alerts.", "type": "string", "readOnly": true, "x-omitempty": true }, "LastChecked": { "description": "Last checked time of the alerts.", "type": "string", "readOnly": true, "x-omitempty": true }, "Message": { "description": "Detailed info about the alert.", "type": "string", "readOnly": true, "x-omitempty": true }, "Recommendation": { "description": "Recommended fix for the alert.", "type": "string", "readOnly": true, "x-omitempty": true }, "Status": { "description": "Status of the given alert.", "type": "string", "readOnly": true, "x-omitempty": true }, "StatusId": { "description": "Status Id of the given alert.", "type": "string", "readOnly": true, "x-omitempty": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "iaas.DiagnosticMessages.List": { "title": "List of 'iaas.DiagnosticMessages' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iaas.DiagnosticMessages' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iaas.DiagnosticMessages' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iaas.DiagnosticMessages" }, "nullable": true } } } ] }, "iaas.LicenseInfo.Response": { "description": "The response body of a HTTP GET request for the 'iaas.LicenseInfo' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iaas.LicenseInfo' resources.", "x-one-of-name": "iaas.LicenseInfo.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iaas.LicenseInfo.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iaas.LicenseInfo.Relationship": { "description": "A relationship to the 'iaas.LicenseInfo' resource, or the expanded 'iaas.LicenseInfo' resource, or the 'null' value.", "x-one-of-name": "iaas.LicenseInfo.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iaas.LicenseInfo" } ], "discriminator": { "propertyName": "ClassId" } }, "iaas.LicenseInfo": { "title": "Iaas:License Info", "description": "The LicenseInfo object is a fundamental component in managing license details within UCS Director (UCSD), providing a structured overview of license types and expiration dates. \n#### Purpose \nLicenseInfo offers comprehensive data about licenses in UCSD, supporting proactive license management and compliance. \n#### Key Concepts \n- **Type and Expiration:** Captures license type and expiration details, aiding in strategic license management. \n- **Utilization Overview:** Provides insights into license utilization, supporting optimization and planning. \n- **Read-Only Access:** Ensures secure access to license data without modification.", "x-allOf-name": "iaas.LicenseInfo", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iaas.LicenseInfo', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iaas.LicenseInfo" ], "default": "iaas.LicenseInfo", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iaas.LicenseInfo" ], "default": "iaas.LicenseInfo", "x-enum-as-string": true }, "LicenseExpirationDate": { "description": "UCS Director license expiration date.", "type": "string", "readOnly": true, "x-omitempty": true }, "LicenseKeysInfo": { "type": "array", "items": { "description": "License keys info for UCSD.", "$ref": "#/components/schemas/iaas.LicenseKeysInfo", "readOnly": true, "x-omitempty": true }, "nullable": true }, "LicenseType": { "description": "License type of UCSD whether it is EVAL/Permanent/Subscription..", "type": "string", "readOnly": true, "x-omitempty": true }, "LicenseUtilizationInfo": { "type": "array", "items": { "description": "List of license utilization info for UCSD.", "$ref": "#/components/schemas/iaas.LicenseUtilizationInfo", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Guid": { "$ref": "#/components/schemas/iaas.UcsdInfo.Relationship", "description": "A reference to a iaasUcsdInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "iaas.LicenseInfo.List": { "title": "List of 'iaas.LicenseInfo' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iaas.LicenseInfo' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iaas.LicenseInfo' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iaas.LicenseInfo" }, "nullable": true } } } ] }, "iaas.LicenseKeysInfo": { "title": "Iaas:License Keys Info", "description": "### Overview\nThe LicenseKeysInfo object serves as an essential element in managing license details within UCS Director. It encapsulates information about unique license identifiers and expiration dates, facilitating effective license management and renewal strategies. \n#### Purpose \nLicenseKeysInfo provides detailed information about the identification and validity of licenses, supporting proactive management and ensuring continuity of service. \n#### Key Concepts \n- **Unique Identification:** - Each license is uniquely identified, enabling precise tracking and management. \n- **Expiration Management:** - Offers insights into license expiration, assisting in timely renewals and preventing service disruptions. \n- **Read-Only Access:** - Designed for secure access to license information without alteration.", "x-allOf-name": "iaas.LicenseKeysInfo", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'iaas.LicenseKeysInfo', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iaas.LicenseKeysInfo" ], "default": "iaas.LicenseKeysInfo", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iaas.LicenseKeysInfo" ], "default": "iaas.LicenseKeysInfo", "x-enum-as-string": true }, "Count": { "description": "Number of licenses available for the UCSD PID (Product ID).", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "ExpirationDate": { "description": "Expiration date for the license.", "type": "string", "readOnly": true, "x-omitempty": true }, "LicenseId": { "description": "UCS Director Unique license ID.", "type": "string", "readOnly": true, "x-omitempty": true }, "Pid": { "description": "PID (Product ID) for UCSD License.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "iaas.LicenseUtilizationInfo": { "title": "Iaas:License Utilization Info", "description": "### Overview\nThe LicenseUtilizationInfo object is crucial for managing and understanding the utilization of licenses within the UCS Director (UCSD). This provides a comprehensive view of license details and their actual usage, enabling efficient resource management and planning. \n#### Purpose \nThe LicenseUtilizationInfo object helps administrators track and optimize the use of licenses associated with various features in UCSD. It ensures that license limits are adhered to while providing insights into actual usage patterns. \n#### Key Concepts \n- **License Tracking:** - Offers a clear view of the licenses available and used within the system, aiding compliance and optimization. \n- **Usage Insights:** - Provides actionable data on how licenses are being utilized, supporting informed decision-making for resource allocation. \n- **Read-Only Access:** - Ensures that the information is accessible for review without modification, maintaining integrity and compliance.", "x-allOf-name": "iaas.LicenseUtilizationInfo", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'iaas.LicenseUtilizationInfo', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iaas.LicenseUtilizationInfo" ], "default": "iaas.LicenseUtilizationInfo", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iaas.LicenseUtilizationInfo" ], "default": "iaas.LicenseUtilizationInfo", "x-enum-as-string": true }, "ActualUsed": { "description": "Number of licenses actually used for this feature.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Label": { "description": "License label of UCSD license.", "type": "string", "readOnly": true, "x-omitempty": true }, "LicensedLimit": { "description": "License limit for this license feature.", "type": "string", "readOnly": true, "x-omitempty": true }, "Sku": { "description": "SKU for the UCSD license.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "iaas.MostRunTasks.Response": { "description": "The response body of a HTTP GET request for the 'iaas.MostRunTasks' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iaas.MostRunTasks' resources.", "x-one-of-name": "iaas.MostRunTasks.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iaas.MostRunTasks.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iaas.MostRunTasks.Relationship": { "description": "A relationship to the 'iaas.MostRunTasks' resource, or the expanded 'iaas.MostRunTasks' resource, or the 'null' value.", "x-one-of-name": "iaas.MostRunTasks.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iaas.MostRunTasks" } ], "discriminator": { "propertyName": "ClassId" } }, "iaas.MostRunTasks": { "title": "Iaas:Most Run Tasks", "description": "The MostRunTasks object provides insights into frequently executed workflow tasks within UCS Director (UCSD). \n#### Purpose \nMostRunTasks captures data about task execution frequency, aiding in workflow analysis and improvement strategies. \n#### Key Concepts \n- **Execution Frequency:** Tracks how often tasks are executed, supporting process refinement and optimization. \n- **Read-Only Access:** Ensures secure access to task data without modification.", "x-allOf-name": "iaas.MostRunTasks", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iaas.MostRunTasks', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iaas.MostRunTasks" ], "default": "iaas.MostRunTasks", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iaas.MostRunTasks" ], "default": "iaas.MostRunTasks", "x-enum-as-string": true }, "TaskCategory": { "description": "A functional area to which a task belongs to.", "type": "string", "readOnly": true, "x-omitempty": true }, "TaskExecutionCount": { "description": "Number of times this task has executed.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "TaskName": { "description": "Name of the task executed in UCSD.", "type": "string", "readOnly": true, "x-omitempty": true }, "TaskType": { "description": "Type of the task whether it is system task or custom task.", "type": "string", "readOnly": true, "x-omitempty": true }, "Guid": { "$ref": "#/components/schemas/iaas.UcsdInfo.Relationship", "description": "A reference to a iaasUcsdInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "iaas.MostRunTasks.List": { "title": "List of 'iaas.MostRunTasks' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iaas.MostRunTasks' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iaas.MostRunTasks' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iaas.MostRunTasks" }, "nullable": true } } } ] }, "iaas.ServiceRequest.Response": { "description": "The response body of a HTTP GET request for the 'iaas.ServiceRequest' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iaas.ServiceRequest' resources.", "x-one-of-name": "iaas.ServiceRequest.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iaas.ServiceRequest.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iaas.ServiceRequest": { "title": "Iaas:Service Request", "description": "The ServiceRequest object is integral to managing service requests within UCS Director (UCSD), capturing essential details about service request and statuses request workflows .\n#### Purpose \nServiceRequest documents and tracks service requests, supporting efficient process management and resolution strategies. \n#### Key Concepts \n- **Workflow Documentation:** Captures information about workflow steps executed in service requests, aiding process refinement. \n- **Status Tracking:** Monitors request statuses, supporting timely resolution and management. \n- **Read-Only Access:** Ensures secure access to service request data without modification.", "x-allOf-name": "iaas.ServiceRequest", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iaas.ServiceRequest', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iaas.ServiceRequest" ], "default": "iaas.ServiceRequest", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iaas.ServiceRequest" ], "default": "iaas.ServiceRequest", "x-enum-as-string": true }, "Duration": { "description": "Service request duration.", "type": "string", "readOnly": true, "x-omitempty": true }, "InitiatingUser": { "description": "Service Request initiating user.", "type": "string", "readOnly": true, "x-omitempty": true }, "RequestEndTime": { "description": "Service request end time.", "type": "string", "readOnly": true, "x-omitempty": true }, "RequestId": { "description": "Service request id of an SR.", "type": "string", "readOnly": true, "x-omitempty": true }, "RequestStartTime": { "description": "Service request start time.", "type": "string", "readOnly": true, "x-omitempty": true }, "RequestType": { "description": "Service request type of an SR.", "type": "string", "readOnly": true, "x-omitempty": true }, "Status": { "description": "UCSD service request status.", "type": "string", "readOnly": true, "x-omitempty": true }, "WorkflowName": { "description": "Executed workflow name for an SR.", "type": "string", "readOnly": true, "x-omitempty": true }, "WorkflowSteps": { "type": "array", "items": { "description": "Step details of Service Request.", "$ref": "#/components/schemas/iaas.WorkflowSteps", "readOnly": true, "x-omitempty": true }, "nullable": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "iaas.ServiceRequest.List": { "title": "List of 'iaas.ServiceRequest' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iaas.ServiceRequest' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iaas.ServiceRequest' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iaas.ServiceRequest" }, "nullable": true } } } ] }, "iaas.SystemTaskInfo.Response": { "description": "The response body of a HTTP GET request for the 'iaas.SystemTaskInfo' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iaas.SystemTaskInfo' resources.", "x-one-of-name": "iaas.SystemTaskInfo.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iaas.SystemTaskInfo.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iaas.SystemTaskInfo.Relationship": { "description": "A relationship to the 'iaas.SystemTaskInfo' resource, or the expanded 'iaas.SystemTaskInfo' resource, or the 'null' value.", "x-one-of-name": "iaas.SystemTaskInfo.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iaas.SystemTaskInfo" } ], "discriminator": { "propertyName": "ClassId" } }, "iaas.SystemTaskInfo": { "title": "Iaas:System Task Info", "description": "The SystemTaskInfo object provides details about library task executions within UCS Director (UCSD), supporting system oversight and process management. \n#### Purpose\nSystemTaskInfo documents task execution data, aiding in workflow task management and optimization strategies. \n#### Key Concepts \n- **Execution Frequency:** Tracks each library tasks execution count, supporting process refinement and optimization.\n- **Functional Categorization:** Provides information regarding the task category to which the library task belongs in UCSD. \n- **Read-Only Access:** Ensures secure access to system task data without modification.", "x-allOf-name": "iaas.SystemTaskInfo", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iaas.SystemTaskInfo', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iaas.SystemTaskInfo" ], "default": "iaas.SystemTaskInfo", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iaas.SystemTaskInfo" ], "default": "iaas.SystemTaskInfo", "x-enum-as-string": true }, "TaskCategory": { "description": "A functional area to which a task belongs to.", "type": "string", "readOnly": true, "x-omitempty": true }, "TaskExecutionCount": { "description": "Number of times this task has been executed.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "TaskName": { "description": "Task name of the UCSD Task.", "type": "string", "readOnly": true, "x-omitempty": true }, "Guid": { "$ref": "#/components/schemas/iaas.UcsdInfo.Relationship", "description": "A reference to a iaasUcsdInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "iaas.SystemTaskInfo.List": { "title": "List of 'iaas.SystemTaskInfo' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iaas.SystemTaskInfo' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iaas.SystemTaskInfo' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iaas.SystemTaskInfo" }, "nullable": true } } } ] }, "iaas.UcsdInfo.Response": { "description": "The response body of a HTTP GET request for the 'iaas.UcsdInfo' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iaas.UcsdInfo' resources.", "x-one-of-name": "iaas.UcsdInfo.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iaas.UcsdInfo.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iaas.UcsdInfo.Relationship": { "description": "A relationship to the 'iaas.UcsdInfo' resource, or the expanded 'iaas.UcsdInfo' resource, or the 'null' value.", "x-one-of-name": "iaas.UcsdInfo.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iaas.UcsdInfo" } ], "discriminator": { "propertyName": "ClassId" } }, "iaas.UcsdInfo": { "title": "Iaas:Ucsd Info", "description": "The UcsdInfo object is a central component in managing UCS Director accounts, offering insights into system configurations and connection status. It facilitates comprehensive management and monitoring of UCSD environments.\n#### Purpose\nUcsdInfo provides a detailed overview of UCS Director instances supporting effective system administration and status evaluation.\n#### Key Concepts\n- **Comprehensive Management:** Captures vital information about UCSD configurations and accounts, aiding efficient system oversight. \n- **Status Evaluation:** Monitors the operational state of UCSD, assisting in maintaining system health and performance. \n- **Access Control:** Supports privilege-based access to ensure secure and authorized system management.", "x-allOf-name": "iaas.UcsdInfo", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iaas.UcsdInfo', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iaas.UcsdInfo" ], "default": "iaas.UcsdInfo", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iaas.UcsdInfo" ], "default": "iaas.UcsdInfo", "x-enum-as-string": true }, "DeviceId": { "description": "Moid of the UCS Director device connector's asset.DeviceRegistration.", "type": "string", "readOnly": true, "x-omitempty": true }, "Guid": { "description": "Unique ID of UCS Director getting registerd with Intersight.", "type": "string", "readOnly": true, "x-omitempty": true }, "HostName": { "description": "The UCS Director hostname for management.", "type": "string", "readOnly": true, "x-omitempty": true }, "Ip": { "description": "The UCS Director IP address for management.", "type": "string", "readOnly": true, "x-omitempty": true }, "LastBackup": { "description": "Last successful backup created for this UCS Director appliance if backup is configured.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "NodeType": { "description": "NodeType specifies if UCS Director is deployed in Stand-alone or Multi Node.", "type": "string", "readOnly": true, "x-omitempty": true }, "ProductName": { "description": "The UCS Director product name.", "type": "string", "readOnly": true, "x-omitempty": true }, "ProductVendor": { "description": "The UCS Director product vendor.", "type": "string", "readOnly": true, "x-omitempty": true }, "ProductVersion": { "description": "The UCS Director product/platform version.", "type": "string", "readOnly": true, "x-omitempty": true }, "Status": { "description": "The UCS Director status. Possible values are Active, Inactive, Unknown.", "type": "string", "readOnly": true, "x-omitempty": true }, "ConnectorPack": { "description": "An array of relationships to iaasConnectorPack resources.", "type": "array", "items": { "$ref": "#/components/schemas/iaas.ConnectorPack.Relationship" }, "nullable": true, "readOnly": true }, "CustomTaskInfo": { "description": "An array of relationships to iaasCustomTaskInfo resources.", "type": "array", "items": { "$ref": "#/components/schemas/iaas.CustomTaskInfo.Relationship" }, "nullable": true, "readOnly": true }, "DeviceStatus": { "description": "An array of relationships to iaasDeviceStatus resources.", "type": "array", "items": { "$ref": "#/components/schemas/iaas.DeviceStatus.Relationship" }, "nullable": true, "readOnly": true }, "LicenseInfo": { "$ref": "#/components/schemas/iaas.LicenseInfo.Relationship", "description": "A reference to a iaasLicenseInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "MostRunTasks": { "description": "An array of relationships to iaasMostRunTasks resources.", "type": "array", "items": { "$ref": "#/components/schemas/iaas.MostRunTasks.Relationship" }, "nullable": true, "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "SystemTaskInfo": { "description": "An array of relationships to iaasSystemTaskInfo resources.", "type": "array", "items": { "$ref": "#/components/schemas/iaas.SystemTaskInfo.Relationship" }, "nullable": true, "readOnly": true }, "UcsdManagedInfra": { "$ref": "#/components/schemas/iaas.UcsdManagedInfra.Relationship", "description": "A reference to a iaasUcsdManagedInfra resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "iaas.UcsdInfo.List": { "title": "List of 'iaas.UcsdInfo' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iaas.UcsdInfo' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iaas.UcsdInfo' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iaas.UcsdInfo" }, "nullable": true } } } ] }, "iaas.UcsdManagedInfra.Response": { "description": "The response body of a HTTP GET request for the 'iaas.UcsdManagedInfra' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iaas.UcsdManagedInfra' resources.", "x-one-of-name": "iaas.UcsdManagedInfra.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iaas.UcsdManagedInfra.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iaas.UcsdManagedInfra.Relationship": { "description": "A relationship to the 'iaas.UcsdManagedInfra' resource, or the expanded 'iaas.UcsdManagedInfra' resource, or the 'null' value.", "x-one-of-name": "iaas.UcsdManagedInfra.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iaas.UcsdManagedInfra" } ], "discriminator": { "propertyName": "ClassId" } }, "iaas.UcsdManagedInfra": { "title": "Iaas:Ucsd Managed Infra", "description": "The UcsdManagedInfra object is critical for overseeing UCS Director (UCSD) managed infrastructure, providing statistics and insights into managed resources.\n#### Purpose\nUcsdManagedInfra offers a detailed view of infrastructure components managed by UCSD, supporting effective resource management and planning.\n#### Key Concepts\n- **Infrastructure Statistics:** Captures data on infrastructure components like hosts and virtual machines, aiding in system oversight. \n- **Resource Management:** Provides insights into user accounts and groups, supporting efficient resource allocation. \n- **Read-Only Access:** Ensures infrastructure data is available for review without modification.", "x-allOf-name": "iaas.UcsdManagedInfra", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iaas.UcsdManagedInfra', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iaas.UcsdManagedInfra" ], "default": "iaas.UcsdManagedInfra", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iaas.UcsdManagedInfra" ], "default": "iaas.UcsdManagedInfra", "x-enum-as-string": true }, "AdvancedCatalogCount": { "description": "Total advanced catalogs in UCSD.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "BmCatalogCount": { "description": "Total bare metal catalogs in UCSD.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "ContainerCatalogCount": { "description": "Total service container catalogs in UCSD.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "EsxiHostCount": { "description": "Total ESXi hosts in UCSD.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "ExternalGroupCount": { "description": "Total external (Ldap) groups in UCSD.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "HypervHostCount": { "description": "Total HyperV hosts in UCSD.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "LocalGroupCount": { "description": "Total local groups in UCSD.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "StandardCatalogCount": { "description": "Total standard catalogs in UCSD.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "UserCount": { "description": "Total user accounts in UCSD.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "VdcCount": { "description": "Total virtual datacenters in UCSD.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "VmCount": { "description": "Total Virtual machines in UCSD.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Guid": { "$ref": "#/components/schemas/iaas.UcsdInfo.Relationship", "description": "A reference to a iaasUcsdInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "iaas.UcsdManagedInfra.List": { "title": "List of 'iaas.UcsdManagedInfra' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iaas.UcsdManagedInfra' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iaas.UcsdManagedInfra' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iaas.UcsdManagedInfra" }, "nullable": true } } } ] }, "iaas.UcsdMessages.Response": { "description": "The response body of a HTTP GET request for the 'iaas.UcsdMessages' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iaas.UcsdMessages' resources.", "x-one-of-name": "iaas.UcsdMessages.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iaas.UcsdMessages.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iaas.UcsdMessages": { "title": "Iaas:Ucsd Messages", "description": "The UcsdMessages object captures messages from UCS Director (UCSD), supporting system communication and alert management. \n#### Purpose\nUcsdMessages document system messages, aiding in communication and issue resolution within UCSD. \n####Key Concepts \n- **Message Documentation:** Records system messages, supporting communication and alert tracking.\n- **Alert Integration:** Integrates message alerts within the system, supporting proactive management and resolution. \n- **Read-Only Access:** Ensures secure access to message data without modification.", "x-allOf-name": "iaas.UcsdMessages", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iaas.UcsdMessages', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iaas.UcsdMessages" ], "default": "iaas.UcsdMessages", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iaas.UcsdMessages" ], "default": "iaas.UcsdMessages", "x-enum-as-string": true }, "StatusId": { "description": "Last checked time of the alerts.", "type": "string", "readOnly": true, "x-omitempty": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "iaas.UcsdMessages.List": { "title": "List of 'iaas.UcsdMessages' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iaas.UcsdMessages' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iaas.UcsdMessages' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iaas.UcsdMessages" }, "nullable": true } } } ] }, "iaas.WorkflowSteps": { "title": "Iaas:Workflow Steps", "description": "### Overview\nThe WorkflowSteps object is integral to managing workflow operations within UCS Director (UCSD), capturing the step-by-step progression of service requests. This provides structured information about each workflow step, facilitating process monitoring and optimization. \n#### Purpose \nWorkflowSteps help in documenting and analyzing the workflow stages in UCSD service requests, enabling better tracking and refinement of operational processes. \n#### Key Concepts \n- **Process Documentation:** - Records detailed information about each step in a workflow, supporting transparency and traceability. \n- **Status Monitoring:** - Provides status updates for workflow steps, aiding in real-time process management. \n- **Read-Only Access:** - Ensures workflow details are available for review without modification.", "x-allOf-name": "iaas.WorkflowSteps", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'iaas.WorkflowSteps', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iaas.WorkflowSteps" ], "default": "iaas.WorkflowSteps", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iaas.WorkflowSteps" ], "default": "iaas.WorkflowSteps", "x-enum-as-string": true }, "CompletedTime": { "description": "Completed time of the workflow step.", "type": "string", "readOnly": true, "x-omitempty": true }, "Name": { "description": "Name of the workflow step.", "type": "string", "readOnly": true, "x-omitempty": true }, "Status": { "description": "Status of the workflow step.", "type": "string", "readOnly": true, "x-omitempty": true }, "StatusMessage": { "description": "Status message of the workflow step.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "iam.AbstractClientApplication.Relationship": { "description": "A relationship to the 'iam.AbstractClientApplication' resource, or the expanded 'iam.AbstractClientApplication' resource, or the 'null' value.", "x-one-of-name": "iam.AbstractClientApplication.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iam.AbstractClientApplication" } ], "discriminator": { "propertyName": "ClassId" } }, "iam.AbstractClientApplication": { "title": "Iam:Abstract Client Application", "description": "Describes an internal application registered against an endpoint in Intersight. The application receives requests specific to \nits use case and these requests require authentication via bearer token validations. The SCIM Client and WebHook Event Receiver Endpoints\nare such examples.", "x-allOf-name": "iam.AbstractClientApplication", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.AbstractClientApplication', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "webhook.Endpoint" ], "default": "webhook.Endpoint", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "webhook.Endpoint" ], "default": "webhook.Endpoint", "x-enum-as-string": true }, "AppCredentials": { "description": "Stores the credentials for the specified authentication type.", "$ref": "#/components/schemas/iam.AppCredentials", "x-createOnly": true, "x-omitempty": true }, "AuthType": { "description": "Type of authentication used by the clientApp.\n* `basic` - The client uses basic username/password authentication. The password is expected to be a JWT token.\n* `none` - No authentication method specified by the client.\n* `bearer-token` - The client uses a long-lived bearer token to authenticate.\n* `auth-code` - The client uses OAuth Authorization Grant Flow without PKCE for authentication.\n* `client-credentials` - The client uses OAuth Client Credentials Flow for authentication.", "type": "string", "enum": [ "basic", "none", "bearer-token", "auth-code", "client-credentials" ], "default": "basic", "x-createOnly": true, "x-omitempty": true }, "CredentialsAction": { "description": "An action to be performed on the credentials.\n* `none` - No action to be performed.\n* `regenerateCredentials` - Allows for revocation and regeneration of a token. The old token associated with the client application. will not be usable and a new token will be generated.", "type": "string", "enum": [ "none", "regenerateCredentials" ], "default": "none", "x-omitempty": true }, "AppRegistration": { "$ref": "#/components/schemas/iam.AppRegistration.Relationship", "description": "A reference to a iamAppRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." } } } ] }, "iam.AbstractQualifier.Relationship": { "description": "A relationship to the 'iam.AbstractQualifier' resource, or the expanded 'iam.AbstractQualifier' resource, or the 'null' value.", "x-one-of-name": "iam.AbstractQualifier.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iam.AbstractQualifier" } ], "discriminator": { "propertyName": "ClassId" } }, "iam.AbstractQualifier": { "title": "Iam:Abstract Qualifier", "description": "Placeholder for different types of qualifiers.", "x-allOf-name": "iam.AbstractQualifier", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.AbstractQualifier', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "iam.Qualifier", "iam.UserQualifier" ], "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "iam.Qualifier", "iam.UserQualifier" ], "x-enum-as-string": true }, "Usergroup": { "$ref": "#/components/schemas/iam.UserGroup.Relationship", "description": "A reference to a iamUserGroup resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." } } } ] }, "iam.Account.Response": { "description": "The response body of a HTTP GET request for the 'iam.Account' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.Account' resources.", "x-one-of-name": "iam.Account.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.Account.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.Account.Relationship": { "description": "A relationship to the 'iam.Account' resource, or the expanded 'iam.Account' resource, or the 'null' value.", "x-one-of-name": "iam.Account.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iam.Account" } ], "discriminator": { "propertyName": "ClassId" } }, "iam.Account": { "title": "Iam:Account", "description": "The Account object defines the organizational framework within which users and resources are managed, serving as the central hub for access and permissions.\n#### Purpose\nAn Account encapsulates the structure and permissions associated with a specific organizational unit, providing a secure environment for managing users and resources.\n#### Key Concepts\n- **Access Management:** Governs user access and permissions, ensuring appropriate roles are assigned to users within the account.\n- **Resource Organization:** Structures resources under the account, facilitating management and oversight of assets.\n- **Security Configuration:** Enforces security policies and configurations, including IP access management and session limits.\n- **Identity Providers:** Integrates with identity providers to streamline authentication and user management, enhancing security and user experience.", "x-allOf-name": "iam.Account", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.Account', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.Account" ], "default": "iam.Account", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.Account" ], "default": "iam.Account", "x-enum-as-string": true }, "ExternalIdentifier": { "description": "External identifier for the account, used for integration with external identity systems.", "type": "string", "readOnly": true, "x-omitempty": true }, "Name": { "description": "Name of the Intersight account. By default, name is same as the MoID of the account.", "type": "string", "pattern": "^$|^[a-zA-Z0-9][a-zA-Z0-9\\-]{0,61}[a-zA-Z0-9]$", "x-omitempty": true }, "Regions": { "type": "array", "items": { "description": "Captures the regions where account is present. For now, account can be present in only one region.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "SingleAdminLockout": { "description": "Indicates if the account is prone to lockout as it has only a single Account Administrator. \nAn account is prone to lockout if it has only one configured Account Administrator and no user groups configured that \ncan grant Account Administrator role to dynamic users.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "Status": { "description": "Status of the account. To activate the Intersight account, claim a device to the account.", "type": "string", "readOnly": true, "x-omitempty": true }, "AppRegistrations": { "description": "An array of relationships to iamAppRegistration resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.AppRegistration.Relationship" }, "nullable": true, "readOnly": true }, "DomainGroups": { "description": "An array of relationships to iamDomainGroup resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.DomainGroup.Relationship" }, "nullable": true, "readOnly": true }, "EndPointRoles": { "description": "An array of relationships to iamEndPointRole resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.EndPointRole.Relationship" }, "nullable": true, "readOnly": true }, "Idpreferences": { "description": "An array of relationships to iamIdpReference resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.IdpReference.Relationship" }, "nullable": true, "readOnly": true }, "Idps": { "description": "An array of relationships to iamIdp resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.Idp.Relationship" }, "nullable": true, "readOnly": true }, "Permissions": { "description": "An array of relationships to iamPermission resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.Permission.Relationship" }, "nullable": true, "readOnly": true }, "PrivilegeSets": { "description": "An array of relationships to iamPrivilegeSet resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.PrivilegeSet.Relationship" }, "nullable": true, "readOnly": true }, "Privileges": { "description": "An array of relationships to iamPrivilege resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.Privilege.Relationship" }, "nullable": true, "readOnly": true }, "ResourceLimits": { "$ref": "#/components/schemas/iam.ResourceLimits.Relationship", "description": "A reference to a iamResourceLimits resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Roles": { "description": "An array of relationships to iamRole resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.Role.Relationship" }, "nullable": true, "readOnly": true }, "SecurityHolder": { "$ref": "#/components/schemas/iam.SecurityHolder.Relationship", "description": "A reference to a iamSecurityHolder resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "SessionLimits": { "$ref": "#/components/schemas/iam.SessionLimits.Relationship", "description": "A reference to a iamSessionLimits resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "iam.Account.List": { "title": "List of 'iam.Account' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.Account' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.Account' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.Account" }, "nullable": true } } } ] }, "iam.AccountExperience.Response": { "description": "The response body of a HTTP GET request for the 'iam.AccountExperience' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.AccountExperience' resources.", "x-one-of-name": "iam.AccountExperience.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.AccountExperience.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.AccountExperience": { "title": "Iam:Account Experience", "description": "AccountExperience captures the set of beta or preview features enabled for a specific account.\n#### Purpose\nIt allows controlled enablement of new capabilities for evaluation and phased rollout.\n#### Key Concepts\n- **Feature Flags:** Represents toggles for account-specific experiences.\n- **Marketing and OPS Control:** Managed by authorized internal roles.\n- **Shared Scope:** Visible across organizations where applicable.\n- **Rollout Safety:** Enables granular, account-level previews.", "x-allOf-name": "iam.AccountExperience", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.AccountExperience', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.AccountExperience" ], "default": "iam.AccountExperience", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.AccountExperience" ], "default": "iam.AccountExperience", "x-enum-as-string": true }, "Features": { "type": "array", "items": { "description": "The list of enabled beta features for the account.", "$ref": "#/components/schemas/iam.FeatureDefinition", "x-omitempty": true }, "nullable": true }, "Account": { "$ref": "#/components/schemas/iam.Account.Relationship", "description": "A reference to a iamAccount resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." } } } ] }, "iam.AccountExperience.List": { "title": "List of 'iam.AccountExperience' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.AccountExperience' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.AccountExperience' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.AccountExperience" }, "nullable": true } } } ] }, "iam.AccountPermissions": { "title": "Iam:Account Permissions", "description": "Users can log in through the base URL (https://intersight.com) or account-specific URLs. When the Intersight user logs in through the base URL, Intersight identifies the accounts and permissions within each account which the user has access to. In case multiple permissions are identified, the user and session objects are created in the onboarding-user account, and the session object is updated with account and permission information. Intersight GUI uses this information to show available accounts and permissions for the user to select.", "x-allOf-name": "iam.AccountPermissions", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.AccountPermissions', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.AccountPermissions" ], "default": "iam.AccountPermissions", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.AccountPermissions" ], "default": "iam.AccountPermissions", "x-enum-as-string": true }, "AccountIdentifier": { "description": "MOID of the account which a user can select after authentication.", "type": "string", "readOnly": true, "x-omitempty": true }, "AccountName": { "description": "Name of the account which a user can select after authentication.", "type": "string", "readOnly": true, "x-omitempty": true }, "AccountPermissionTags": { "type": "array", "items": { "description": "The array of tags on account permission object.", "$ref": "#/components/schemas/iam.AccountTags", "readOnly": true, "x-omitempty": true }, "nullable": true }, "AccountStatus": { "description": "Status of the account. Account remains inactive until a device is claimed to the account.", "type": "string", "readOnly": true, "x-omitempty": true }, "HomeRegion": { "description": "Region where account belongs.", "type": "string", "readOnly": true, "x-omitempty": true }, "Permissions": { "type": "array", "items": { "description": "Permissions within an account which a user can select after authentication.", "$ref": "#/components/schemas/iam.PermissionReference", "readOnly": true, "x-omitempty": true }, "nullable": true } } } ] }, "iam.AccountTags": { "title": "Iam:Account Tags", "description": "An arbitrary key and value pair that can be used to tag REST resources and organize managed objects by\nassigning meta-data tags to any object.", "x-allOf-name": "iam.AccountTags", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.AccountTags', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.AccountTags" ], "default": "iam.AccountTags", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.AccountTags" ], "default": "iam.AccountTags", "x-enum-as-string": true }, "Key": { "description": "The string representation of a tag key.", "type": "string", "x-omitempty": true }, "Value": { "description": "The string representation of a tag value.", "type": "string", "x-omitempty": true } } } ] }, "iam.AccountTypeBase": { "title": "Iam:Account Type Base", "description": "Base type for all user account types in the endpoint user management system. It defines the shared structure and properties that are common to all account types, such as the account type name.\nServing as the foundation for more specific account types, including Local and IPMI, AccountTypeBase enables consistent modeling, validation, and extension of user account types. This approach ensures flexibility and maintainability as new account types are introduced.", "x-allOf-name": "iam.AccountTypeBase", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.AccountTypeBase', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "iam.AccountTypeIpmi", "iam.AccountTypeLocal" ], "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "iam.AccountTypeIpmi", "iam.AccountTypeLocal" ], "x-enum-as-string": true }, "Name": { "description": "Name of the Account type such as Local or IPMI, that identifies the kind of user account.", "type": "string", "x-omitempty": true } } } ] }, "iam.AccountTypeIpmi": { "title": "IPMI", "description": "Account type for creating IPMI user on the endpoint. IPMI user enables IPMI User on the endpoint.", "x-allOf-name": "iam.AccountTypeIpmi", "allOf": [ { "$ref": "#/components/schemas/iam.AccountTypeBase" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.AccountTypeIpmi', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.AccountTypeIpmi" ], "default": "iam.AccountTypeIpmi", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.AccountTypeIpmi" ], "default": "iam.AccountTypeIpmi", "x-enum-as-string": true }, "IsPasswordSet": { "description": "Indicates whether the value of the 'password' property has been set.", "type": "boolean", "default": false, "readOnly": true, "x-omitempty": true }, "Password": { "description": "The password must have a minimum of 8 and a maximum of 127 characters. For servers with IPMI user role enabled, the maximum length is limited to 20 characters. When strong password is enabled, must satisfy below requirements: A. The password must not contain the User's Name. B. The password must contain characters from three of the following four categories. 1) English uppercase characters (A through Z). 2) English lowercase characters (a through z). 3) Base 10 digits (0 through 9). 4) Non-alphabetic characters (! , @, #, $, %, ^, &, *, -, _, +, =).", "type": "string", "pattern": "^$|^[a-zA-Z0-9!@#$%^&\\*+-_=]+$", "minLength": 8, "maxLength": 20, "writeOnly": true, "x-omitempty": true }, "UseDiffIpmiPassword": { "description": "Use Different IPMI Password. If false then same Local User Password will be used for IPMI.", "type": "boolean", "default": false, "x-omitempty": true } } } ] }, "iam.AccountTypeLocal": { "title": "Local", "description": "Account type for creating local user on the endpoint. Local user enables Redfish User on the endpoint.", "x-allOf-name": "iam.AccountTypeLocal", "allOf": [ { "$ref": "#/components/schemas/iam.AccountTypeBase" } ] }, "iam.ApiKey.Response": { "description": "The response body of a HTTP GET request for the 'iam.ApiKey' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.ApiKey' resources.", "x-one-of-name": "iam.ApiKey.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.ApiKey.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.ApiKey.Relationship": { "description": "A relationship to the 'iam.ApiKey' resource, or the expanded 'iam.ApiKey' resource, or the 'null' value.", "x-one-of-name": "iam.ApiKey.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iam.ApiKey" } ], "discriminator": { "propertyName": "ClassId" } }, "iam.ApiKey": { "title": "Iam:Api Key", "description": "The ApiKey object is a critical component for secure authentication and authorization within the system. It allows clients to make API requests programmatically using a secure HTTP signature scheme.\n#### Purpose\nAn ApiKey serves as a mechanism for authentication and authorization, enabling unattended clients, such as daemons, to interact with the API securely. This provides the means to verify the identity of a client and ensure they have the appropriate permissions to perform specific actions.\n#### Key Concepts\n- **Public Key Cryptography:** Utilizes public key cryptography to ensure secure authentication, with the server holding the public key and the client maintaining the confidentiality of the private key.\n- **Request Signing:** Involves signing HTTP requests to ensure integrity and authenticity, using cryptographic digest and signature mechanisms.\n- **Access Control:** Restricted to specific privilege sets, ensuring only authorized users can create, read, update, or delete API keys.\n- **Expiration and Rotation:** Supports expiration settings and key rotation, enhancing security by limiting the validity period of keys and facilitating the replacement of compromised or expired keys.", "x-allOf-name": "iam.ApiKey", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.ApiKey', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.ApiKey" ], "default": "iam.ApiKey", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.ApiKey" ], "default": "iam.ApiKey", "x-enum-as-string": true }, "AdminStatus": { "description": "Used to trigger the enable or disable action on the API key. These actions change the status of an API key.\n* `enable` - Used to enable a disabled API key/App Registration. If the API key/App Registration is already expired, this action has no effect.\n* `disable` - Used to disable an active API key/App Registration. If the API key/App Registration is already expired, this action has no effect.", "type": "string", "enum": [ "enable", "disable" ], "default": "enable", "x-omitempty": true }, "ExpiryDateTime": { "description": "The expiration date of the API key which is set at the time of creation of the key. Its value can only be assigned a date that falls within the range determined by the maximum expiration time configured at the account level. The expiry date can be edited to be earlier or later, provided it stays within the designated expiry period. This period is determined by adding the 'startTime' property of the API key to the maximum expiry time configured at the account level.", "type": "string", "format": "date-time", "x-omitempty": true }, "HashAlgorithm": { "description": "The cryptographic hash algorithm to calculate the message digest.\n* `SHA256` - The SHA-256 cryptographic hash, as defined by NIST in FIPS 180-4.\n* `SHA384` - The SHA-384 cryptographic hash, as defined by NIST in FIPS 180-4.\n* `SHA512` - The SHA-512 cryptographic hash, as defined by NIST in FIPS 180-4.\n* `SHA512_224` - The SHA-512/224 cryptographic hash, as defined by NIST in FIPS 180-4.\n* `SHA512_256` - The SHA-512/256 cryptographic hash, as defined by NIST in FIPS 180-4.", "type": "string", "enum": [ "SHA256", "SHA384", "SHA512", "SHA512_224", "SHA512_256" ], "default": "SHA256", "x-createOnly": true, "x-omitempty": true }, "IsNeverExpiring": { "description": "Used to mark the API key as a never-expiring API key.", "type": "boolean", "default": false, "x-omitempty": true }, "KeySpec": { "description": "The key generation specification provides the algorithm and the parameters required for this algorithm to generate a private key, public key pair. Supported key generation schemes include RSA, ECDSA and Edwards-Curve Digital Signature Algorithm (EdDSA).", "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/pkix.KeyGenerationSpec", "x-createOnly": true, "x-omitempty": true }, "LastUsedIp": { "description": "The IP address from which the API key was last used.", "type": "string", "readOnly": true, "x-omitempty": true }, "LastUsedTime": { "description": "The time at which the API key was last used. It is updated every 24 hours.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "OperStatus": { "description": "The current status of the API key that dictates the validity of the key.\n* `enabled` - An API key/App Registration having enabled status can be used for API invocation.\n* `disabled` - An API key/App Registration having disabled status cannot be used for API invocation.\n* `expired` - An API key/App Registration having expired status cannot be used for API invocation as the expiration date has passed.", "type": "string", "enum": [ "enabled", "disabled", "expired" ], "default": "enabled", "readOnly": true, "x-omitempty": true }, "PrivateKey": { "description": "Holds the private key for the API key.", "type": "string", "x-omitempty": true }, "Purpose": { "description": "The purpose of the API Key.", "type": "string", "maxLength": 1024, "x-omitempty": true }, "Scope": { "description": "Scope holds a collection of account Id, permission Id to which the current session is scoped to.", "$ref": "#/components/schemas/iam.SwitchScopePermissions", "readOnly": true, "x-omitempty": true }, "SigningAlgorithm": { "description": "The signing algorithm used by the client to authenticate API requests to Intersight.\nThe signing algorithm must be compatible with the key generation specification.\n* `RSASSA-PKCS1-v1_5` - RSASSA-PKCS1-v1_5 is a RSA signature scheme specified in [RFC 8017](https://tools.ietf.org/html/rfc8017).RSASSA-PKCS1-v1_5 is included only for compatibility with existing applications.\n* `RSASSA-PSS` - RSASSA-PSS is a RSA signature scheme specified in [RFC 8017](https://tools.ietf.org/html/rfc8017).It combines the RSASP1 and RSAVP1 primitives with the EMSA-PSS encoding method.In the interest of increased robustness, RSASSA-PSS is required in new applications.\n* `Ed25519` - The Ed25519 signature algorithm, as specified in [RFC 8032](https://tools.ietf.org/html/rfc8032).Ed25519 is a public-key signature system with several attractive features, includingfast single-signature verification, very fast signing, fast key generation and high security level.\n* `Ecdsa` - The Elliptic Curve Digital Signature Standard (ECDSA), as defined by NIST in FIPS 186-4 and ANSI X9.62.The signature is encoded as a ASN.1 DER SEQUENCE with two INTEGERs (r and s), as defined in RFC3279.When using ECDSA signatures, configure the client to use the same signature encoding as specified on the server side.\n* `EcdsaP1363Format` - The Elliptic Curve Digital Signature Standard (ECDSA), as defined by NIST in FIPS 186-4 and ANSI X9.62.The signature is the raw concatenation of r and s, as defined in the ISO/IEC 7816-8 IEEE P.1363 standard.In that format, r and s are represented as unsigned, big endian numbers.Extra padding bytes (of value 0x00) is applied so that both r and s encodings have the same size.When using ECDSA signatures, configure the client to use the same signature encoding as specified on the server side.", "type": "string", "enum": [ "RSASSA-PKCS1-v1_5", "RSASSA-PSS", "Ed25519", "Ecdsa", "EcdsaP1363Format" ], "default": "RSASSA-PKCS1-v1_5", "x-createOnly": true, "x-omitempty": true }, "StartTime": { "description": "The timestamp at which an expiry date was first set on this API key. For expiring API keys, this field is same as the create time of the API key. For never-expiring API keys, this field is set initially to zero time value. If a never-expiry API key is later changed to have an expiration, the timestamp marking the start of this transition is recorded in this field.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "Permission": { "$ref": "#/components/schemas/iam.Permission.Relationship", "description": "A reference to a iamPermission resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "User": { "$ref": "#/components/schemas/iam.User.Relationship", "description": "A reference to a iamUser resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "iam.ApiKey.List": { "title": "List of 'iam.ApiKey' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.ApiKey' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.ApiKey' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.ApiKey" }, "nullable": true } } } ] }, "iam.AppCredentials": { "title": "Iam:App Credentials", "description": "Contains credentials information for a particular client application.", "x-allOf-name": "iam.AppCredentials", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" } ] }, "iam.AppRegistration.Response": { "description": "The response body of a HTTP GET request for the 'iam.AppRegistration' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.AppRegistration' resources.", "x-one-of-name": "iam.AppRegistration.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.AppRegistration.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.AppRegistration.Relationship": { "description": "A relationship to the 'iam.AppRegistration' resource, or the expanded 'iam.AppRegistration' resource, or the 'null' value.", "x-one-of-name": "iam.AppRegistration.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iam.AppRegistration" } ], "discriminator": { "propertyName": "ClassId" } }, "iam.AppRegistration": { "title": "App Registration", "description": "The AppRegistration object facilitates the registration of OAuth2 client applications, enabling secure access to APIs using OAuth2 credentials.\n#### Purpose\nAn AppRegistration defines the metadata and configuration required for OAuth2 client applications to authenticate and obtain access tokens. The metadata defines how a client application retrieves an OAuth2 access token and uses it to invoke the Intersight API on behalf of the AppRegistration. It ensures a secure and controlled mechanism for applications to interact with the system.\n#### Key Concepts\n- **OAuth2 Compliance:** Adheres to OAuth2 standards, supporting various grant types and response types for secure API access.\n- **Client Identification:** Provides unique client IDs and secrets for registered applications, ensuring each client is identifiable and secure.\n- **Redirect URIs:** Specifies the redirection endpoints for OAuth2 flows, ensuring the safe transfer of authorization codes or tokens.\n- **Token Management:** Includes mechanisms for token expiration, revocation, and renewal, maintaining security by managing the lifecycle of access tokens.", "x-allOf-name": "iam.AppRegistration", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.AppRegistration', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.AppRegistration" ], "default": "iam.AppRegistration", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.AppRegistration" ], "default": "iam.AppRegistration", "x-enum-as-string": true }, "AdminStatus": { "description": "Used to trigger the enable or disable action on the App Registration. These actions change the status of an App Registration.\n* `enable` - Used to enable a disabled API key/App Registration. If the API key/App Registration is already expired, this action has no effect.\n* `disable` - Used to disable an active API key/App Registration. If the API key/App Registration is already expired, this action has no effect.", "type": "string", "enum": [ "enable", "disable" ], "default": "enable", "x-omitempty": true }, "ClientId": { "description": "A unique identifier for the OAuth2 client application.\nThe client ID is auto-generated when the AppRegistration object is created.", "type": "string", "readOnly": true, "x-omitempty": true }, "ClientName": { "description": "App Registration name specified by user.", "type": "string", "x-omitempty": true }, "ClientSecret": { "description": "The OAuth2 client secret.\nThe value of this property is generated when grantType includes 'client-credentials'.\nOtherwise, no client-secret is generated.", "type": "string", "x-omitempty": true }, "ClientType": { "description": "The type of the OAuth2 client (public or confidential), as specified in https://tools.ietf.org/html/rfc6749#section-2.1.\n* `public` - Clients incapable of maintaining the confidentiality of their credentials.This includes clients executing on the device used by the resource owner,such as mobile applications, installed native application or a webbrowser-based application.\n* `confidential` - Clients capable of maintaining the confidentiality of their credentials.For example, this could be a client implemented on a secure server withrestricted access to the client credentials.To maintain the confidentiality of the OAuth2 credentials, two use cases areconsidered.1) The application is running as a service within Intersight. The application automatically obtains the OAuth2 credentials when the application starts and the credentials are not exposed to the end-user. Because end-users (even account administrators) do not have access the OAuth2 credentials, they cannot take the credentials with them when they leave their organization.2) The application is under the control of a \"trusted\" end-user. For example, the end-user may create a native application running outside Intersight. The application uses OAuth2 credentials to interact with the Intersight API. In that case, the Intersight account administrator may generate OAuth2 credentials with a registered application using \"client_credentials\" grant type. In that case, the end-user is responsible for maintaining the confidentiality of the OAuth2 credentials. If the end-user leaves the organization, you should revoke the credentials and issue new Oauth2 credentials.Here is a possible workflow for handling OAuth2 tokens.1) User Alice (Intersight Account Administrator) logins to Intersight and deploys an Intersight application that requires an OAuth2 token.2) Intersight automatically deploys the application. The application is assigned a OAuth2 token, possibly linked to Alice. The application must NOT expose the OAuth2 secret to Alice, otherwise Alice would be able to use the token after she leaves the company.3) The application can make API calls to Intersight using its assigned OAuth2 token. For example, the application could make weekly scheduled API calls to Intersight.4) Separately, Alice may also get OAuth2 tokens that she can use to make API calls from the Intersight SDK through the northbound API. In that case, Alice will get the associated OAuth2 secrets, but not the one assigned in step #2.5) Alice leaves the organization. The OAuth2 tokens assigned in step #2 must retain their validity even after Alice has left the organization. Because the OAuth2 secrets were never shared with Alice, there is no risk Alice can reuse the OAuth2 secrets. On the other hand, the OAuth2 tokens assigned in step #4 must be invalidated because Alice had the OAuth2 tokens in her possession.", "type": "string", "enum": [ "public", "confidential" ], "default": "public", "x-omitempty": true }, "Description": { "description": "Description of the application.", "type": "string", "x-omitempty": true }, "EntityId": { "description": "EntityId holds the Id of the client application that is using this AppRegistration.", "type": "string", "readOnly": true, "x-omitempty": true }, "ExpiryDateTime": { "description": "The expiration date of the App Registration which is set at the time of its creation. Its value can only be assigned a date that falls within the range determined by the maximum expiration time configured at the account level. The expiry date can be edited to be earlier or later, provided it stays within the designated expiry period. This period is determined by adding the 'startTime' property of the App Registration to the maximum expiry time configured at the account level.", "type": "string", "format": "date-time", "x-omitempty": true }, "GrantTypes": { "type": "array", "items": { "description": "The set of grant types that OAuth2 clients can use for this application.\nThe grant type is used in the OAuth2 login flow to validate the grant type that has been requested by the client.\nSee https://tools.ietf.org/html/rfc7591#page-9 for more details.\n# It is set automatically when AppRegistration is created since currently we do not provide option for the user.\n* `authorization_code` - The 'authorization code' grant type as defined in the OAuth2 specification.It implies a \"response_types\" value that includes \"code\".\n* `refresh_token` - The 'refresh token' grant type defined in the OAuth2 specification.https://tools.ietf.org/html/rfc7591#section-6.\n* `client_credentials` - The 'client credentials' grant type defined in the OAuth2 specification.A client can request an access token using only its clientcredentials (or other supported means of authentication) when theclient is requesting access to the protected resources under itscontrol, or those of another resource owner that have been previouslyarranged with the authorization server.https://tools.ietf.org/html/rfc6749#section-4.4.\n* `implicit` - The implicit grant is a simplified authorization code flow optimizedfor clients implemented in a browser using a scripting language suchas JavaScript. In the implicit flow, instead of issuing the clientan authorization code, the client is issued an access token directly(as the result of the resource owner authorization). The grant typeis implicit, as no intermediate credentials (such as an authorizationcode) are issued (and later used to obtain an access token).When issuing an access token during the implicit grant flow, theauthorization server does not authenticate the client. In somecases, the client identity can be verified via the redirection URIused to deliver the access token to the client. The access token maybe exposed to the resource owner or other applications with access tothe resource owner's user-agent.\n* `password` - The resource owner password credentials (i.e., username and password)can be used directly as an authorization grant to obtain an accesstoken. The credentials should only be used when there is a highdegree of trust between the resource owner and the client (e.g., theclient is part of the device operating system or a highly privilegedapplication), and when other authorization grant types are notavailable (such as an authorization code).\n* `urn:ietf:params:oauth:grant-type:jwt-bearer` - The JWT Bearer Token Grant Type defined in OAuth JWT Bearer Token Profiles [RFC7523].\n* `urn:ietf:params:oauth:grant-type:saml2-bearer` - The SAML 2.0 Bearer Assertion Grant defined in OAuth SAML 2 Bearer Token Profiles [RFC7522].", "type": "string", "enum": [ "authorization_code", "refresh_token", "client_credentials", "implicit", "password", "urn:ietf:params:oauth:grant-type:jwt-bearer", "urn:ietf:params:oauth:grant-type:saml2-bearer" ], "default": "authorization_code", "readOnly": true, "x-omitempty": true }, "nullable": true }, "IsNeverExpiring": { "description": "Used to mark the App Registration as a never-expiring App Registration.", "type": "boolean", "default": false, "x-omitempty": true }, "LastUsedIp": { "description": "The ip address from which the App Registration was last used.", "type": "string", "readOnly": true, "x-omitempty": true }, "LastUsedTime": { "description": "The time at which the App Registration was last used. It is updated every 24 hours.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "OperStatus": { "description": "The current status of the App Registration that dictates the validity of the app.\n* `enabled` - An API key/App Registration having enabled status can be used for API invocation.\n* `disabled` - An API key/App Registration having disabled status cannot be used for API invocation.\n* `expired` - An API key/App Registration having expired status cannot be used for API invocation as the expiration date has passed.", "type": "string", "enum": [ "enabled", "disabled", "expired" ], "default": "enabled", "readOnly": true, "x-omitempty": true }, "RedirectUris": { "type": "array", "items": { "description": "After a user successfully authorizes an application, the OAuth2 authorization server will redirect the user back to the\napplication with either an authorization code or access token in the URL.\nRegistered redirect URLs may contain query string parameters, but must not contain anything in the fragment.\nThe registration server rejects the request if a user tries to register a redirect URL that contains a fragment.\nFor native and mobile apps, Intersight allows a user to register a URL scheme such as myapp:// which can then be used\nin the redirect URL. The authorization server allows arbitrary URL schemes to be registered in order to support\nregistering redirect URLs for native apps.\nRedirect URLs are a critical part of the OAuth flow. After a user successfully authorizes an application,\nthe authorization server will redirect the user back to the application with either an authorization code or access\ntoken in the URL. Because the redirect URL will contain sensitive information, it is critical that the service\ndoesn\u2019t redirect the user to arbitrary locations.\nThe best way to ensure the user will only be directed to appropriate locations is to require the developer to\nregister one or more redirect URLs when they create the application.\nThe redirection endpoint URI MUST be an absolute URI.", "type": "string", "pattern": "^$|^(?:[\\w.-]+?:\\/\\/)[\\w\\.\\-\\/\\d\\:]+$", "x-omitempty": true }, "nullable": true }, "RenewClientSecret": { "description": "Set value to true to renew the client-secret. Applicable to client_credentials grant type.", "type": "boolean", "default": false, "x-omitempty": true }, "ResponseTypes": { "type": "array", "items": { "description": "The set of response types that a OAuth2 client can use.\nThis is static list and it is set automatically when AppRegistration is created.\nAccording to RFC, it is used in OAuth2 login flow to check that this AppRegistration supports response type from the request.\nSee https://tools.ietf.org/html/rfc7591#page-9 for more details.\n* `code` - The authorization code response type defined in OAuth2, section 4.1.\n* `token` - The token response type defined in OAuth2, section 4.2.", "type": "string", "enum": [ "code", "token" ], "default": "code", "readOnly": true, "x-omitempty": true }, "nullable": true }, "RevocationTimestamp": { "description": "Used to perform revocation for tokens of AppRegistration.\nUpdated only internally is case Revoke property come from UI with value true.\nOn each request with OAuth2 access token the CreationTime of the OAuth2 token will be compared to RevokationTimestamp of the\ncorresponding App Registration.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "Revoke": { "description": "Used to trigger update the revocationTimestamp value.\nIf UI sent updating request with the Revoke value is true, then update RevocationTimestamp.", "type": "boolean", "default": false, "x-omitempty": true }, "Scope": { "description": "Scope holds a collection of account Id, permission Id to which the current session is scoped to.", "$ref": "#/components/schemas/iam.SwitchScopePermissions", "readOnly": true, "x-omitempty": true }, "ShowConsentScreen": { "description": "Set to true if consent screen needs to be shown during the OAuth login process.\nApplicable only for public AppRegistrations, means only 'authorization_code' grantType.\nNote that consent screen will be shown on each login.", "type": "boolean", "default": false, "x-omitempty": true }, "StartTime": { "description": "The timestamp at which an expiry date was first set on this app registration. \nFor expiring App Registrations, this field is same as the create time of the App Registration.\nFor never-expiring App Registrations, this field is set initially to zero time value. If a never-expiry App Registration is later changed to have an expiration, the timestamp marking the start of this transition is recorded in this field.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "TokenExpiry": { "description": "Defines the expiry time of the token generated via the AppRegistration.\n* `generic` - This sets the expiryTime to ten minutes from the token issuing time.\n* `longLived` - This sets the expiryTime to an year from the token issuing time.\n* `infinite` - This allows for a never-expiring token. Use with caution.", "type": "string", "enum": [ "generic", "longLived", "infinite" ], "default": "generic", "readOnly": true, "x-omitempty": true }, "Account": { "$ref": "#/components/schemas/iam.Account.Relationship", "description": "A reference to a iamAccount resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "ClientApplication": { "$ref": "#/components/schemas/iam.AbstractClientApplication.Relationship", "description": "A reference to a iamAbstractClientApplication resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "OauthTokens": { "description": "An array of relationships to iamOAuthToken resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.OAuthToken.Relationship" }, "nullable": true, "readOnly": true }, "Permission": { "$ref": "#/components/schemas/iam.Permission.Relationship", "description": "A reference to a iamPermission resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Roles": { "deprecated": true, "x-sunset": "2027-03-01", "description": "An array of relationships to iamRole resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.Role.Relationship" }, "nullable": true }, "SecurityHolder": { "$ref": "#/components/schemas/iam.SecurityHolder.Relationship", "description": "A reference to a iamSecurityHolder resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "User": { "$ref": "#/components/schemas/iam.User.Relationship", "description": "A reference to a iamUser resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "iam.AppRegistration.List": { "title": "List of 'iam.AppRegistration' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.AppRegistration' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.AppRegistration' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.AppRegistration" }, "nullable": true } } } ] }, "iam.BannerMessage.Response": { "description": "The response body of a HTTP GET request for the 'iam.BannerMessage' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.BannerMessage' resources.", "x-one-of-name": "iam.BannerMessage.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.BannerMessage.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.BannerMessage": { "title": "Iam:Banner Message", "description": "BannerMessage configures a global banner for an account, controlling whether it is displayed and what content it shows.\n#### Purpose\nIt provides a mechanism to communicate important notices or policies to users across the account.\n#### Key Concepts\n- **User Communication:** Surfaces messages consistently in the UI.\n- **Administrative Control:** Managed by account administrators.\n- **Non-intrusive:** Designed for clarity without operational disruption.\n- **Account-wide Scope:** Applies across the account's user base.", "x-allOf-name": "iam.BannerMessage", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.BannerMessage', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.BannerMessage" ], "default": "iam.BannerMessage", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.BannerMessage" ], "default": "iam.BannerMessage", "x-enum-as-string": true }, "BannerContents": { "description": "Contents of the banner message.", "type": "string", "x-omitempty": true }, "BannerDisplay": { "description": "Whether or not to display the banner message.", "type": "boolean", "x-omitempty": true }, "BannerTitle": { "description": "Title of the banner message.", "type": "string", "x-omitempty": true }, "Account": { "$ref": "#/components/schemas/iam.Account.Relationship", "description": "A reference to a iamAccount resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." } } } ] }, "iam.BannerMessage.List": { "title": "List of 'iam.BannerMessage' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.BannerMessage' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.BannerMessage' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.BannerMessage" }, "nullable": true } } } ] }, "iam.BasicAuthCredentials": { "title": "Iam:Basic Auth Credentials", "description": "Defines a credentials Holder for Basic authentication.", "x-allOf-name": "iam.BasicAuthCredentials", "allOf": [ { "$ref": "#/components/schemas/iam.AppCredentials" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.BasicAuthCredentials', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.BasicAuthCredentials" ], "default": "iam.BasicAuthCredentials", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.BasicAuthCredentials" ], "default": "iam.BasicAuthCredentials", "x-enum-as-string": true }, "Password": { "description": "Contains the password for the basic auth flow.", "type": "string", "x-createOnly": true, "x-omitempty": true }, "Username": { "description": "Contains the username for the basic auth flow.", "type": "string", "x-createOnly": true, "x-omitempty": true } } } ] }, "iam.Certificate.Response": { "description": "The response body of a HTTP GET request for the 'iam.Certificate' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.Certificate' resources.", "x-one-of-name": "iam.Certificate.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.Certificate.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.Certificate.Relationship": { "description": "A relationship to the 'iam.Certificate' resource, or the expanded 'iam.Certificate' resource, or the 'null' value.", "x-one-of-name": "iam.Certificate.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iam.Certificate" } ], "discriminator": { "propertyName": "ClassId" } }, "iam.Certificate": { "title": "Iam:Certificate", "description": "Certificate holds a user-provided certificate (signed by a CA) associated with a previously generated CSR, including validation status.\n#### Purpose\nIt completes the certificate lifecycle by attaching the signed artifact to the originating request.\n#### Key Concepts\n- **CSR Pairing:** Linked to a specific certificate request.\n- **Validation State:** Tracks readiness and correctness of the certificate.\n- **Account Process:** Operates within account certificate workflows.\n- **Trust Enablement:** Supports secure endpoint and service identities.", "x-allOf-name": "iam.Certificate", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.Certificate', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.Certificate" ], "default": "iam.Certificate", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.Certificate" ], "default": "iam.Certificate", "x-enum-as-string": true }, "Certificate": { "description": "User-input pem-encoded certificate, signed by a CAcert.", "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/x509.Certificate", "x-omitempty": true }, "Status": { "description": "Status of the certificate.\n* `PendingValidation` - The certificate has not been validated.\n* `Valid` - The certificate is valid.\n* `Invalid` - Ther certificate is invalid.", "type": "string", "enum": [ "PendingValidation", "Valid", "Invalid" ], "default": "PendingValidation", "readOnly": true, "x-omitempty": true }, "CertificateRequest": { "$ref": "#/components/schemas/iam.CertificateRequest.Relationship", "description": "A reference to a iamCertificateRequest resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true } } } ] }, "iam.Certificate.List": { "title": "List of 'iam.Certificate' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.Certificate' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.Certificate' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.Certificate" }, "nullable": true } } } ] }, "iam.CertificateRequest.Response": { "description": "The response body of a HTTP GET request for the 'iam.CertificateRequest' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.CertificateRequest' resources.", "x-one-of-name": "iam.CertificateRequest.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.CertificateRequest.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.CertificateRequest.Relationship": { "description": "A relationship to the 'iam.CertificateRequest' resource, or the expanded 'iam.CertificateRequest' resource, or the 'null' value.", "x-one-of-name": "iam.CertificateRequest.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iam.CertificateRequest" } ], "discriminator": { "propertyName": "ClassId" } }, "iam.CertificateRequest": { "title": "Iam:Certificate Request", "description": "The information required to generate a certificate signing request (CSR),\nwhich is a block of encoded text that is given to a Certificate Authority when applying for an SSL Certificate.", "x-allOf-name": "iam.CertificateRequest", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.CertificateRequest', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.CertificateRequest" ], "default": "iam.CertificateRequest", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.CertificateRequest" ], "default": "iam.CertificateRequest", "x-enum-as-string": true }, "EmailAddress": { "description": "User input email address, an optional part of the subject of the certificate request.", "type": "string", "x-omitempty": true }, "Name": { "description": "Name of the certificate request.", "type": "string", "pattern": "^$|^[A-Za-z0-9]([^/\\\\.]*(\\.[^/\\\\.]+)*)?$", "x-createOnly": true, "x-omitempty": true }, "Request": { "description": "Generated certificate signing request (CSR) in PEM format.", "type": "string", "readOnly": true, "x-omitempty": true }, "SelfSigned": { "description": "Whether the user wants the generated CSR to be self-signed by the appliance.", "type": "boolean", "x-omitempty": true }, "Subject": { "description": "The x.509 distinguished name of the subject of the certificate request.", "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/pkix.DistinguishedName", "x-omitempty": true }, "SubjectAlternateName": { "description": "The x.509 subject alternate name values of the certificate request.", "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/pkix.SubjectAlternateName", "x-omitempty": true }, "Account": { "$ref": "#/components/schemas/iam.Account.Relationship", "description": "A reference to a iamAccount resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Certificate": { "$ref": "#/components/schemas/iam.Certificate.Relationship", "description": "A reference to a iamCertificate resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true }, "PrivateKeySpec": { "$ref": "#/components/schemas/iam.PrivateKeySpec.Relationship", "description": "A reference to a iamPrivateKeySpec resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true } } } ] }, "iam.CertificateRequest.List": { "title": "List of 'iam.CertificateRequest' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.CertificateRequest' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.CertificateRequest' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.CertificateRequest" }, "nullable": true } } } ] }, "iam.ClientMeta": { "title": "Iam:Client Meta", "description": "Contains meta information of the client. Currently it is used only within OAuth clients.", "x-allOf-name": "iam.ClientMeta", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.ClientMeta', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.ClientMeta" ], "default": "iam.ClientMeta", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.ClientMeta" ], "default": "iam.ClientMeta", "x-enum-as-string": true }, "DeviceModel": { "description": "Parsed device model from raw User-Agent.", "type": "string", "x-omitempty": true }, "UserAgent": { "description": "The value of the \"User-Agent\" HTTP header, as sent by the HTTP client when it initiate a session to Intersight. This can be used to identify the client operating system, browser type and browser version.\nExample - Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/75.0.3770.100 Safari/537.36\nIt is set when User successfully passed OAuth login flow and receives Access Token.", "type": "string", "x-omitempty": true } } } ] }, "iam.CuiIntegration.Response": { "description": "The response body of a HTTP GET request for the 'iam.CuiIntegration' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.CuiIntegration' resources.", "x-one-of-name": "iam.CuiIntegration.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.CuiIntegration.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.CuiIntegration": { "title": "Iam:Cui Integration", "description": "Stores CUI and CCC integration details and synchronization status for an account.", "x-allOf-name": "iam.CuiIntegration", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.CuiIntegration', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.CuiIntegration" ], "default": "iam.CuiIntegration", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.CuiIntegration" ], "default": "iam.CuiIntegration", "x-enum-as-string": true }, "CiscoCloudControlInventorySync": { "description": "CCC inventory synchronization setting.\n* `enable` - Cisco Cloud Control inventory synchronization is enabled.\n* `disable` - Cisco Cloud Control inventory synchronization is disabled.", "type": "string", "enum": [ "enable", "disable" ], "default": "enable", "readOnly": true, "x-omitempty": true }, "LastFullSyncTime": { "description": "The last-modified timestamp of the tenant as returned by the remote API during the most recent workflow-based synchronization.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "LastNotificationModifiedTime": { "description": "The modified-time carried by the most recent notification applied to this CUI integration MO, used to detect and skip stale or duplicate notifications.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "LinkedTenants": { "type": "array", "items": { "description": "List of linked tenant information for various products (CUI, CCC).", "$ref": "#/components/schemas/iam.TenantLinking", "readOnly": true, "x-omitempty": true }, "nullable": true }, "OptIn": { "description": "Indicates whether the account has opted in to CUI identity synchronization.", "type": "boolean", "x-omitempty": true }, "OptInTime": { "description": "Timestamp representing when the customer opted in to CUI identity synchronization.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "OptInUserIdentity": { "description": "Identity or name of the engineer who performed the opt-in action.", "type": "string", "readOnly": true, "x-omitempty": true }, "SyncStatus": { "description": "Current synchronization status of CUI integration data.\n* `Needs-Sync` - CUI integration data needs to be synchronized.\n* `InProgress` - CUI integration synchronization is in progress.\n* `Done` - CUI integration synchronization is completed.", "type": "string", "enum": [ "Needs-Sync", "InProgress", "Done" ], "default": "Needs-Sync", "readOnly": true, "x-omitempty": true }, "TenantId": { "description": "Primary tenant ID for CUI integration.", "type": "string", "readOnly": true, "x-omitempty": true }, "Account": { "$ref": "#/components/schemas/iam.Account.Relationship", "description": "A reference to a iamAccount resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "User": { "$ref": "#/components/schemas/iam.User.Relationship", "description": "A reference to a iamUser resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "iam.CuiIntegration.List": { "title": "List of 'iam.CuiIntegration' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.CuiIntegration' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.CuiIntegration' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.CuiIntegration" }, "nullable": true } } } ] }, "iam.DefaultAuthentication.Response": { "description": "The response body of a HTTP GET request for the 'iam.DefaultAuthentication' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.DefaultAuthentication' resources.", "x-one-of-name": "iam.DefaultAuthentication.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.DefaultAuthentication.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.DefaultAuthentication": { "title": "Iam:Default Authentication", "description": "DefaultAuthentication specifies the default login method for an account in appliance contexts, optionally linking to a default LDAP domain.\n#### Purpose\nIt streamlines user sign-in by preselecting the primary authentication method.\n#### Key Concepts\n- **Method Selection:** Chooses among local, SSO, or LDAP modes for default use.\n- **LDAP Affinity:** Can associate a default LDAP IdP for convenience.\n- **Account-level Policy:** Configurable by account administrators.\n- **User Experience:** Reduces friction during authentication flows.", "x-allOf-name": "iam.DefaultAuthentication", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.DefaultAuthentication', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.DefaultAuthentication" ], "default": "iam.DefaultAuthentication", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.DefaultAuthentication" ], "default": "iam.DefaultAuthentication", "x-enum-as-string": true }, "DefaultAuthenticationMethod": { "description": "The default authentication method used to login into Intersight.\n* `Local` - Local authentication uses credentials stored within the Intersight platform for user access.\n* `SSO` - SSO authentication uses an external identity provider for user access.\n* `LDAP` - LDAP authentication uses external LDAP servers for user access.", "type": "string", "enum": [ "Local", "SSO", "LDAP" ], "default": "Local", "x-omitempty": true }, "Account": { "$ref": "#/components/schemas/iam.Account.Relationship", "description": "A reference to a iamAccount resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "LdapDomain": { "$ref": "#/components/schemas/iam.Idp.Relationship", "description": "A reference to a iamIdp resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." } } } ] }, "iam.DefaultAuthentication.List": { "title": "List of 'iam.DefaultAuthentication' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.DefaultAuthentication' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.DefaultAuthentication' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.DefaultAuthentication" }, "nullable": true } } } ] }, "iam.DefaultPermissionInfo": { "title": "Iam:Default Permission Info", "description": "Contains information about a stored default permission and its shared login interface coverage for product-facing default role selection.", "x-allOf-name": "iam.DefaultPermissionInfo", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.DefaultPermissionInfo', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.DefaultPermissionInfo" ], "default": "iam.DefaultPermissionInfo", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.DefaultPermissionInfo" ], "default": "iam.DefaultPermissionInfo", "x-enum-as-string": true }, "Interface": { "description": "The shared login interface coverage for the stored default permission.\n* `All` - The stored default permission applies to all currently supported login interfaces.", "type": "string", "enum": [ "All" ], "default": "All", "x-omitempty": true }, "Permission": { "description": "Reference to the selected default permission for the shared login interface coverage.", "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef", "x-omitempty": true } } } ] }, "iam.DomainGroup.Response": { "description": "The response body of a HTTP GET request for the 'iam.DomainGroup' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.DomainGroup' resources.", "x-one-of-name": "iam.DomainGroup.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.DomainGroup.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.DomainGroup.Relationship": { "description": "A relationship to the 'iam.DomainGroup' resource, or the expanded 'iam.DomainGroup' resource, or the 'null' value.", "x-one-of-name": "iam.DomainGroup.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iam.DomainGroup" } ], "discriminator": { "propertyName": "ClassId" } }, "iam.DomainGroup": { "title": "Iam:Domain Group", "description": "Intersight services are mapped to three different categories of services for scaling purpose.\nThree categories are defined: Partition1/Partition2/Partition3. Topics for each category are created with\na specific number of partitions. For each cloud environment these numbers will be different.", "x-allOf-name": "iam.DomainGroup", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.DomainGroup', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.DomainGroup" ], "default": "iam.DomainGroup", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.DomainGroup" ], "default": "iam.DomainGroup", "x-enum-as-string": true }, "Name": { "description": "The name of the domain-group.", "type": "string", "readOnly": true, "x-omitempty": true }, "Partition1": { "description": "The partition number domain group related messages are produced for 'Partition1' category service topics.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Partition2": { "description": "In a cloud environment this parameter will indicate to which partition number domain group related messages are produced for 'Partition2' category service topics.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Partition3": { "description": "In a cloud environment this parameter will indicate to which partition number domain group related messages are produced for 'Partition3' category service topics.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "PartitionKey": { "description": "Partition key used for producing messages to Kafka partitions. By default Domain-group id will be used as partition key. For Domain-groups belonging to Early adopters domain-group id will be prefixed with 'H' and used as partition key, such partition key will be treated differently and messages will always be produced to partition 0.", "type": "string", "readOnly": true, "x-omitempty": true }, "Usage": { "description": "The number of devices in the domain-group.\nDevice registration notifications are processed to update the usage of the domain-group. The on-boarding account will have multiple domain-groups, and during the device registration least used domain-group will be selected for the device.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Account": { "$ref": "#/components/schemas/iam.Account.Relationship", "description": "A reference to a iamAccount resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "iam.DomainGroup.List": { "title": "List of 'iam.DomainGroup' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.DomainGroup' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.DomainGroup' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.DomainGroup" }, "nullable": true } } } ] }, "iam.DomainNameInfo.Response": { "description": "The response body of a HTTP GET request for the 'iam.DomainNameInfo' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.DomainNameInfo' resources.", "x-one-of-name": "iam.DomainNameInfo.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.DomainNameInfo.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.DomainNameInfo": { "title": "Iam:Domain Name Info", "description": "The organisation's domain name such as cisco.com that has been used to log in to Intersight.", "x-allOf-name": "iam.DomainNameInfo", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.DomainNameInfo', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.DomainNameInfo" ], "default": "iam.DomainNameInfo", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.DomainNameInfo" ], "default": "iam.DomainNameInfo", "x-enum-as-string": true }, "Action": { "description": "Regenerate TXT record and validate TXT record.\n* `generate` - Generate TXT record for domain name ownership validation.\n* `verify` - Verify TXT record for domain name ownership validation.", "type": "string", "enum": [ "generate", "verify" ], "default": "generate", "x-omitempty": true }, "DomainName": { "description": "Email domain name. When a user enters an email during login in the Intersight home page, the IdP is picked by matching this domain name with the email domain name for authentication.", "type": "string", "pattern": "^$|^[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$", "x-createOnly": true, "x-omitempty": true }, "FailureDetails": { "description": "Reason for the failure during verification.", "$ref": "#/components/schemas/iam.FailureDetails", "readOnly": true, "x-omitempty": true }, "RecordExpiryTime": { "description": "Expiration time of TXT Record.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "Status": { "description": "Status of Domain Ownership Verification.\n* `Pending` - Domain verification is pending.\n* `Failed` - Domain verification failed. Re-generate token and verify.\n* `Verified` - Domain verification succeeded.\n* `Expired` - TXT Record for Domain verification expired.", "type": "string", "enum": [ "Pending", "Failed", "Verified", "Expired" ], "default": "Pending", "readOnly": true, "x-omitempty": true }, "TxtRecord": { "description": "Resource record used to verify Domain Ownership. Users need to verify the domain by adding the TXT Record in their DNS Host.", "type": "string", "readOnly": true, "x-omitempty": true }, "Account": { "$ref": "#/components/schemas/iam.Account.Relationship", "description": "A reference to a iamAccount resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "iam.DomainNameInfo.List": { "title": "List of 'iam.DomainNameInfo' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.DomainNameInfo' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.DomainNameInfo' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.DomainNameInfo" }, "nullable": true } } } ] }, "iam.EncryptedOidcAuthTokenSet": { "title": "Iam:Encrypted Oidc Auth Token Set", "description": "Holds attributes obtained after OIDC authentication in encrypted format which are required for CUI admin portal MFE \ninside Intersight for IdP settings and routing rules, session refresh and logout functionality. Used during login\nflow where the tokens obtained from CUI need to be stored securely.", "x-allOf-name": "iam.EncryptedOidcAuthTokenSet", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.EncryptedOidcAuthTokenSet', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.EncryptedOidcAuthTokenSet" ], "default": "iam.EncryptedOidcAuthTokenSet", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.EncryptedOidcAuthTokenSet" ], "default": "iam.EncryptedOidcAuthTokenSet", "x-enum-as-string": true }, "IsAccessTokenSet": { "description": "Indicates whether the value of the 'accessToken' property has been set.", "type": "boolean", "default": false, "readOnly": true, "x-omitempty": true }, "IsIdTokenSet": { "description": "Indicates whether the value of the 'idToken' property has been set.", "type": "boolean", "default": false, "readOnly": true, "x-omitempty": true }, "IsRefreshTokenSet": { "description": "Indicates whether the value of the 'refreshToken' property has been set.", "type": "boolean", "default": false, "readOnly": true, "x-omitempty": true } } } ] }, "iam.EndPointPasswordProperties": { "title": "Iam:End Point Password Properties", "description": "Password properties for endpoint users.", "x-allOf-name": "iam.EndPointPasswordProperties", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.EndPointPasswordProperties', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.EndPointPasswordProperties" ], "default": "iam.EndPointPasswordProperties", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.EndPointPasswordProperties" ], "default": "iam.EndPointPasswordProperties", "x-enum-as-string": true }, "EnablePasswordExpiry": { "description": "Enables password expiry on the endpoint.", "type": "boolean", "default": false, "x-omitempty": true }, "EnforceStrongPassword": { "description": "Enables a strong password policy. Strong password requirements: A. The password must have a minimum of 8 and a maximum of 127 characters. B. The password must not contain the User's Name. C. The password must contain characters from three of the following four categories. 1) English uppercase characters (A through Z). 2) English lowercase characters (a through z). 3) Base 10 digits (0 through 9). 4) Non-alphabetic characters (! , @, #, $, %, ^, &, *, -, _, +, =).", "type": "boolean", "default": true, "x-omitempty": true }, "ForceSendPassword": { "description": "User password will always be sent to endpoint device. If the option is not selected, then user password will be sent to endpoint device for new users and if user password is changed for existing users.", "type": "boolean", "default": false, "x-omitempty": true }, "GracePeriod": { "description": "Time period until when you can use the existing password, after it expires.", "type": "integer", "format": "int64", "default": 0, "minimum": 0, "maximum": 5, "x-omitempty": true }, "NotificationPeriod": { "description": "The duration after which the password will expire.", "type": "integer", "format": "int64", "default": 15, "minimum": 0, "maximum": 15, "x-omitempty": true }, "PasswordExpiryDuration": { "description": "Set time period for password expiration. Value should be greater than notification period and grace period.", "type": "integer", "format": "int64", "default": 90, "minimum": 1, "maximum": 3650, "x-omitempty": true }, "PasswordHistory": { "description": "Tracks password change history. Specifies in number of instances, that the new password was already used.", "type": "integer", "format": "int64", "default": 5, "minimum": 0, "maximum": 5, "x-omitempty": true } } } ] }, "iam.EndPointPrivilege.Response": { "description": "The response body of a HTTP GET request for the 'iam.EndPointPrivilege' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.EndPointPrivilege' resources.", "x-one-of-name": "iam.EndPointPrivilege.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.EndPointPrivilege.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.EndPointPrivilege.Relationship": { "description": "A relationship to the 'iam.EndPointPrivilege' resource, or the expanded 'iam.EndPointPrivilege' resource, or the 'null' value.", "x-one-of-name": "iam.EndPointPrivilege.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iam.EndPointPrivilege" } ], "discriminator": { "propertyName": "ClassId" } }, "iam.EndPointPrivilege": { "title": "Iam:End Point Privilege", "description": "EndPointPrivilege models privileges defined on managed endpoints (e.g., UCS, IMC), enabling cross-launch or delegated actions.\n#### Purpose\nIt exposes endpoint-side authorization elements that can be assigned to platform users via endpoint roles.\n#### Key Concepts\n- **Endpoint Integration:** Bridges device-level capabilities to platform users.\n- **Read-only Catalog:** Reflects endpoint-defined actions.\n- **Role Assignment:** Consumed by EndPointRole for user access.", "x-allOf-name": "iam.EndPointPrivilege", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.EndPointPrivilege', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.EndPointPrivilege" ], "default": "iam.EndPointPrivilege", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.EndPointPrivilege" ], "default": "iam.EndPointPrivilege", "x-enum-as-string": true }, "Description": { "description": "The functionality of this privilege.", "type": "string", "readOnly": true, "x-omitempty": true }, "Name": { "description": "The name of the end point privilege.", "type": "string", "readOnly": true, "x-omitempty": true }, "Type": { "description": "The type of the end point like Cisco UCS Fabric Interconnect or Cisco IMC.\n* `` - An unrecognized platform type.\n* `APIC` - A Cisco Application Policy Infrastructure Controller (APIC) cluster.\n* `CAPIC` - A Cisco Cloud Application Policy Infrastructure Controller (Cloud APIC) instance.\n* `DCNM` - A Cisco Data Center Network Manager (DCNM) instance.\n* `UCSFI` - A Cisco UCS Fabric Interconnect that is managed by Cisco UCS Manager (UCSM).\n* `UCSFIISM` - A Cisco UCS Fabric Interconnect that is managed by Cisco Intersight.\n* `IMC` - A standalone Cisco UCS rack server (Deprecated).\n* `IMCM4` - A standalone Cisco UCS C-Series or S-Series M4 server.\n* `IMCM5` - A standalone Cisco UCS C-Series or S-Series M5 server.\n* `IMCRack` - A standalone Cisco UCS C-Series or S-Series M6 or newer server.\n* `UCSIOM` - A Cisco UCS Blade Chassis I/O Module (IOM).\n* `UCSPCIeNODE` - A Cisco UCS PCIe Node in a blade form factor.\n* `UCSXFM` - A Cisco UCS Fabric Extender Module (XFM).\n* `HX` - A Cisco HyperFlex (HX) cluster.\n* `UCSD` - A Cisco UCS Director (UCSD) instance.\n* `UCSXECMC` - A Cisco UCSXE Chassis Management Controller.\n* `UCSXESecureRouter` - A secure networking router node designed to operate as part of a UCSXE chassis.\n* `IntersightAppliance` - A Cisco Intersight Connected Virtual Appliance instance.\n* `IntersightAssist` - A Cisco Intersight Assist instance.\n* `PureStorageFlashArray` - A Pure Storage FlashArray that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer and storage management features are supported on this device.\n* `PureStorageFlashBladeSystem` - A Pure Storage FlashBlade target that is managed using Cisco Intersight Assist. Storage management feature is supported on this device.\n* `NexusDevice` - A Cisco Nexus Network Switch that is managed using Cisco Intersight Assist.\n* `ACISwitch` - A Cisco Nexus Network Switch with the embedded Device Connector and is a part of the Cisco ACI fabric.\n* `NexusSwitch` - A standalone Cisco Nexus Network Switch with the embedded Device Connector.\n* `MDSSwitch` - A Cisco MDS Switch that is managed using the embedded Device Connector.\n* `MDSDevice` - A Cisco MDS Switch that is managed using Cisco Intersight Assist.\n* `UCSC885` - A standalone Cisco UCS C885 Server.\n* `CAI845A` - A standalone Cisco AI 845A Server.\n* `UCSC890` - A standalone Cisco UCS C890 server managed using Cisco Intersight Assist.\n* `RedfishServer` - A generic target type for servers that support Redfish APIs and is managed using Cisco Intersight Assist. Support is limited to HPE and Dell Servers.\n* `NetAppOntap` - A Netapp ONTAP Storage system that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this device.\n* `NetAppActiveIqUnifiedManager` - A NetApp Active IQ Unified Manager (AIQUM) that is managed using Cisco Intersight Assist.\n* `EmcScaleIo` - An EMC ScaleIO Software Defined Storage system that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this device.\n* `EmcVmax` - An EMC VMAX 2 or 3 series enterprise storage array that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this device.\n* `EmcVplex` - An EMC VPLEX virtual storage system that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this device.\n* `EmcXtremIo` - An EMC XtremIO SSD storage system that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this device.\n* `VmwareVcenter` - A VMware vCenter instance that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer and Virtualization features are supported on this hypervisor.\n* `MicrosoftHyperV` - A Microsoft Hyper-V host that is managed using Cisco Intersight Assist. Optionally, other hosts in the cluster can be discovered through this host. Cisco Intersight Workload Optimizer features are supported on this hypervisor.\n* `AppDynamics` - An AppDynamics controller running in a SaaS or on-prem datacenter. On-prem AppDynamics instance is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this controller.\n* `Dynatrace` - A Dynatrace Server instance running in a SaaS or on-prem datacenter. On-prem Dynatrace instance is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this server.\n* `NewRelic` - A NewRelic user account. The NewRelic instance monitors the application infrastructure. Cisco Intersight Workload Optimizer features are supported on this server.\n* `ServiceNow` - A cloud-based workflow automation platform that enables enterprise organizations to improve operational efficiencies by streamlining and automating routine work tasks.\n* `Umbrella` - Umbrella cloud target that discovers and monitors an organization. It discovers entities like Datacenters, Devices, Tunnels, Networks, etc.\n* `CloudFoundry` - An open source cloud platform on which developers can build, deploy, run and scale applications.\n* `MicrosoftAzureApplicationInsights` - A feature of Azure Monitor, is an extensible Application Performance Management service for developers and DevOps professionals to monitor their live applications.\n* `OpenStack` - An OpenStack target manages Virtual Machines, Physical Machines, Datacenters and Virtual Datacenters using different OpenStack services as administrative endpoints.\n* `MicrosoftSqlServer` - A Microsoft SQL database server that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this database.\n* `MySqlServer` - A MySQL database server that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this database.\n* `OracleDatabaseServer` - An Oracle database server that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this database.\n* `IBMWebSphereApplicationServer` - An IBM WebSphere Application server that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this application server.\n* `OracleWebLogicServer` - Oracle WebLogic Server is a unified and extensible platform for developing, deploying and running enterprise applications, such as Java, for on-premises and in the cloud. WebLogic Server offers a robust, mature, and scalable implementation of Java Enterprise Edition (EE) and Jakarta EE.\n* `ApacheTomcatServer` - An Apache Tomcat server that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this server.\n* `JavaVirtualMachine` - A JVM Application with JMX configured that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this application.\n* `RedHatJBossApplicationServer` - JBoss Application Server is an open-source, cross-platform Java application server developed by JBoss, a division of Red Hat Inc. It is an open-source implementation of Java 2 Enterprise Edition (J2EE) that is used for implementing Java applications and other Web-based applications and software.\n* `Kubernetes` - A Kubernetes cluster that runs containerized applications, with Kubernetes Collector installed. Cisco Intersight Workload Optimizer features are supported on Kubernetes cluster.\n* `AmazonWebService` - An Amazon Web Service cloud account. Cisco Intersight Workload Optimizer and Virtualization features are supported on this cloud.\n* `AmazonWebServiceBilling` - An Amazon Web Service cloud billing account used to retrieve billing information stored in S3 bucket. Cisco Intersight Workload Optimizer features are supported on this cloud.\n* `GoogleCloudPlatform` - A Google Cloud Platform service account with access to one or more projects. Cisco Intersight Workload Optimizer features are supported on this cloud.\n* `GoogleCloudPlatformBilling` - A Google Cloud Platform service account used to retrieve billing information from BigQuery. Cisco Intersight Workload Optimizer features are supported on this cloud.\n* `MicrosoftAzureServicePrincipal` - A Microsoft Azure Service Principal account with access to Azure subscriptions. Cisco Intersight Workload Optimizer features are supported on this cloud.\n* `MicrosoftAzureEnterpriseAgreement` - A Microsoft Azure Enterprise Agreement enrolment used to retrieve pricing and billing information. Cisco Intersight Workload Optimizer features are supported on this cloud.\n* `MicrosoftAzureBilling` - A Microsoft Azure Service Principal account with access to billing information. Cisco Intersight Workload Optimizer features are supported on this cloud.\n* `DellCompellent` - A Dell EMC SC Series (Compellent) storage system that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this device.\n* `HPE3Par` - A HPE 3PAR StoreServ system that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this device.\n* `RedHatEnterpriseVirtualization` - A Red Hat Enterprise Virtualization Hypervisor system that manages Virtual Machines.\n* `NutanixAcropolis` - A Nutanix Acropolis cluster that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this cluster.\n* `NutanixPrismCentral` - A Nutanix Prism Central cluster. Prism central is a virtual appliance for managing Nutanix clusters and services.\n* `HPEOneView` - A HPE OneView system that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this system.\n* `ServiceEngine` - Cisco Application Services Engine. Cisco Application Services Engine is a platform to deploy and manage applications.\n* `HitachiVirtualStoragePlatform` - A Hitachi Virtual Storage Platform (Hitachi VSP) that is managed using Cisco Intersight Assist.\n* `GenericTarget` - A generic third-party target supported only in Partner Integration Appliance. This target type is used for development purposes and will not be supported in production environment.\n* `IMCBlade` - A Cisco UCS blade server managed by Cisco Intersight.\n* `TerraformCloud` - A Terraform Cloud Business Tier account.\n* `TerraformAgent` - A Terraform Cloud Agent that will be deployed on Cisco Intersight Assist. The agent can be used to plan and apply Terraform runs from a Terraform Cloud workspace.\n* `CustomTarget` - CustomTarget is deprecated. Use HTTPEndpoint type to claim HTTP endpoints.\n* `AnsibleEndpoint` - An external endpoint that is added as a target which can be accessed through Ansible in Intersight Cloud Orchestrator automation workflows.\n* `HTTPEndpoint` - An HTTP endpoint that can be accessed in Intersight Orchestrator workflows directly or using Cisco Intersight Assist. Authentication Schemes supported are Basic and Bearer Token.\n* `SSHEndpoint` - An SSH endpoint that can be accessed in Intersight Orchestrator workflows using Cisco Intersight Assist.\n* `CiscoCatalyst` - A Cisco Catalyst networking switch device.\n* `PowerShellEndpoint` - A Windows operating system server on which PowerShell scripts can be executed using Cisco Intersight Assist.\n* `CiscoDNAC` - A Cisco Digital Network Architecture (DNA) Center appliance.\n* `CiscoFMC` - A Cisco Secure Firewall Management Center.\n* `ViptelaCloud` - ViptelaCloud is deprecated. Use CatalystSDWANManager type to claim Catalyst SDWAN Manager which can manage Catalyst SDWAN devices.\n* `CatalystSDWANManager` - A Cisco Catalyst SD-WAN Manager.\n* `MerakiCloud` - A Cisco Meraki Organization.\n* `CiscoISE` - A Cisco Identity Services Engine (ISE) target.", "type": "string", "enum": [ "", "APIC", "CAPIC", "DCNM", "UCSFI", "UCSFIISM", "IMC", "IMCM4", "IMCM5", "IMCRack", "UCSIOM", "UCSPCIeNODE", "UCSXFM", "HX", "UCSD", "UCSXECMC", "UCSXESecureRouter", "IntersightAppliance", "IntersightAssist", "PureStorageFlashArray", "PureStorageFlashBladeSystem", "NexusDevice", "ACISwitch", "NexusSwitch", "MDSSwitch", "MDSDevice", "UCSC885", "CAI845A", "UCSC890", "RedfishServer", "NetAppOntap", "NetAppActiveIqUnifiedManager", "EmcScaleIo", "EmcVmax", "EmcVplex", "EmcXtremIo", "VmwareVcenter", "MicrosoftHyperV", "AppDynamics", "Dynatrace", "NewRelic", "ServiceNow", "Umbrella", "CloudFoundry", "MicrosoftAzureApplicationInsights", "OpenStack", "MicrosoftSqlServer", "MySqlServer", "OracleDatabaseServer", "IBMWebSphereApplicationServer", "OracleWebLogicServer", "ApacheTomcatServer", "JavaVirtualMachine", "RedHatJBossApplicationServer", "Kubernetes", "AmazonWebService", "AmazonWebServiceBilling", "GoogleCloudPlatform", "GoogleCloudPlatformBilling", "MicrosoftAzureServicePrincipal", "MicrosoftAzureEnterpriseAgreement", "MicrosoftAzureBilling", "DellCompellent", "HPE3Par", "RedHatEnterpriseVirtualization", "NutanixAcropolis", "NutanixPrismCentral", "HPEOneView", "ServiceEngine", "HitachiVirtualStoragePlatform", "GenericTarget", "IMCBlade", "TerraformCloud", "TerraformAgent", "CustomTarget", "AnsibleEndpoint", "HTTPEndpoint", "SSHEndpoint", "CiscoCatalyst", "PowerShellEndpoint", "CiscoDNAC", "CiscoFMC", "ViptelaCloud", "CatalystSDWANManager", "MerakiCloud", "CiscoISE" ], "default": "", "readOnly": true, "x-omitempty": true }, "System": { "$ref": "#/components/schemas/iam.System.Relationship", "description": "A reference to a iamSystem resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "iam.EndPointPrivilege.List": { "title": "List of 'iam.EndPointPrivilege' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.EndPointPrivilege' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.EndPointPrivilege' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.EndPointPrivilege" }, "nullable": true } } } ] }, "iam.EndPointRole.Response": { "description": "The response body of a HTTP GET request for the 'iam.EndPointRole' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.EndPointRole' resources.", "x-one-of-name": "iam.EndPointRole.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.EndPointRole.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.EndPointRole.Relationship": { "description": "A relationship to the 'iam.EndPointRole' resource, or the expanded 'iam.EndPointRole' resource, or the 'null' value.", "x-one-of-name": "iam.EndPointRole.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iam.EndPointRole" } ], "discriminator": { "propertyName": "ClassId" } }, "iam.EndPointRole": { "title": "Iam:End Point Role", "description": "EndPointRole represents roles defined on managed endpoints that encapsulate one or more endpoint privileges.\n#### Purpose\nIt allows administrators to assign endpoint-specific capabilities to platform users in a structured way.\n#### Key Concepts\n- **Role Abstraction:** Groups endpoint privileges for ease of assignment.\n- **Device-type Aware:** Specific to endpoint platform types.\n- **User Linkage:** Assignable to users for GUI/CLI cross-launch and more.\n- **Discoverable:** Tied to endpoint-reported security models.", "x-allOf-name": "iam.EndPointRole", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.EndPointRole', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.EndPointRole" ], "default": "iam.EndPointRole", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.EndPointRole" ], "default": "iam.EndPointRole", "x-enum-as-string": true }, "Name": { "description": "The name of the end point role.", "type": "string", "readOnly": true, "x-omitempty": true }, "RoleType": { "description": "User specified tags to roles like as ep-admin or ep-readonly.", "type": "string", "readOnly": true, "x-omitempty": true }, "Type": { "description": "The type of the end point like Cisco UCS Fabric Interconnect or Cisco IMC.\n* `` - An unrecognized platform type.\n* `APIC` - A Cisco Application Policy Infrastructure Controller (APIC) cluster.\n* `CAPIC` - A Cisco Cloud Application Policy Infrastructure Controller (Cloud APIC) instance.\n* `DCNM` - A Cisco Data Center Network Manager (DCNM) instance.\n* `UCSFI` - A Cisco UCS Fabric Interconnect that is managed by Cisco UCS Manager (UCSM).\n* `UCSFIISM` - A Cisco UCS Fabric Interconnect that is managed by Cisco Intersight.\n* `IMC` - A standalone Cisco UCS rack server (Deprecated).\n* `IMCM4` - A standalone Cisco UCS C-Series or S-Series M4 server.\n* `IMCM5` - A standalone Cisco UCS C-Series or S-Series M5 server.\n* `IMCRack` - A standalone Cisco UCS C-Series or S-Series M6 or newer server.\n* `UCSIOM` - A Cisco UCS Blade Chassis I/O Module (IOM).\n* `UCSPCIeNODE` - A Cisco UCS PCIe Node in a blade form factor.\n* `UCSXFM` - A Cisco UCS Fabric Extender Module (XFM).\n* `HX` - A Cisco HyperFlex (HX) cluster.\n* `UCSD` - A Cisco UCS Director (UCSD) instance.\n* `UCSXECMC` - A Cisco UCSXE Chassis Management Controller.\n* `UCSXESecureRouter` - A secure networking router node designed to operate as part of a UCSXE chassis.\n* `IntersightAppliance` - A Cisco Intersight Connected Virtual Appliance instance.\n* `IntersightAssist` - A Cisco Intersight Assist instance.\n* `PureStorageFlashArray` - A Pure Storage FlashArray that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer and storage management features are supported on this device.\n* `PureStorageFlashBladeSystem` - A Pure Storage FlashBlade target that is managed using Cisco Intersight Assist. Storage management feature is supported on this device.\n* `NexusDevice` - A Cisco Nexus Network Switch that is managed using Cisco Intersight Assist.\n* `ACISwitch` - A Cisco Nexus Network Switch with the embedded Device Connector and is a part of the Cisco ACI fabric.\n* `NexusSwitch` - A standalone Cisco Nexus Network Switch with the embedded Device Connector.\n* `MDSSwitch` - A Cisco MDS Switch that is managed using the embedded Device Connector.\n* `MDSDevice` - A Cisco MDS Switch that is managed using Cisco Intersight Assist.\n* `UCSC885` - A standalone Cisco UCS C885 Server.\n* `CAI845A` - A standalone Cisco AI 845A Server.\n* `UCSC890` - A standalone Cisco UCS C890 server managed using Cisco Intersight Assist.\n* `RedfishServer` - A generic target type for servers that support Redfish APIs and is managed using Cisco Intersight Assist. Support is limited to HPE and Dell Servers.\n* `NetAppOntap` - A Netapp ONTAP Storage system that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this device.\n* `NetAppActiveIqUnifiedManager` - A NetApp Active IQ Unified Manager (AIQUM) that is managed using Cisco Intersight Assist.\n* `EmcScaleIo` - An EMC ScaleIO Software Defined Storage system that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this device.\n* `EmcVmax` - An EMC VMAX 2 or 3 series enterprise storage array that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this device.\n* `EmcVplex` - An EMC VPLEX virtual storage system that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this device.\n* `EmcXtremIo` - An EMC XtremIO SSD storage system that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this device.\n* `VmwareVcenter` - A VMware vCenter instance that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer and Virtualization features are supported on this hypervisor.\n* `MicrosoftHyperV` - A Microsoft Hyper-V host that is managed using Cisco Intersight Assist. Optionally, other hosts in the cluster can be discovered through this host. Cisco Intersight Workload Optimizer features are supported on this hypervisor.\n* `AppDynamics` - An AppDynamics controller running in a SaaS or on-prem datacenter. On-prem AppDynamics instance is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this controller.\n* `Dynatrace` - A Dynatrace Server instance running in a SaaS or on-prem datacenter. On-prem Dynatrace instance is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this server.\n* `NewRelic` - A NewRelic user account. The NewRelic instance monitors the application infrastructure. Cisco Intersight Workload Optimizer features are supported on this server.\n* `ServiceNow` - A cloud-based workflow automation platform that enables enterprise organizations to improve operational efficiencies by streamlining and automating routine work tasks.\n* `Umbrella` - Umbrella cloud target that discovers and monitors an organization. It discovers entities like Datacenters, Devices, Tunnels, Networks, etc.\n* `CloudFoundry` - An open source cloud platform on which developers can build, deploy, run and scale applications.\n* `MicrosoftAzureApplicationInsights` - A feature of Azure Monitor, is an extensible Application Performance Management service for developers and DevOps professionals to monitor their live applications.\n* `OpenStack` - An OpenStack target manages Virtual Machines, Physical Machines, Datacenters and Virtual Datacenters using different OpenStack services as administrative endpoints.\n* `MicrosoftSqlServer` - A Microsoft SQL database server that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this database.\n* `MySqlServer` - A MySQL database server that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this database.\n* `OracleDatabaseServer` - An Oracle database server that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this database.\n* `IBMWebSphereApplicationServer` - An IBM WebSphere Application server that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this application server.\n* `OracleWebLogicServer` - Oracle WebLogic Server is a unified and extensible platform for developing, deploying and running enterprise applications, such as Java, for on-premises and in the cloud. WebLogic Server offers a robust, mature, and scalable implementation of Java Enterprise Edition (EE) and Jakarta EE.\n* `ApacheTomcatServer` - An Apache Tomcat server that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this server.\n* `JavaVirtualMachine` - A JVM Application with JMX configured that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this application.\n* `RedHatJBossApplicationServer` - JBoss Application Server is an open-source, cross-platform Java application server developed by JBoss, a division of Red Hat Inc. It is an open-source implementation of Java 2 Enterprise Edition (J2EE) that is used for implementing Java applications and other Web-based applications and software.\n* `Kubernetes` - A Kubernetes cluster that runs containerized applications, with Kubernetes Collector installed. Cisco Intersight Workload Optimizer features are supported on Kubernetes cluster.\n* `AmazonWebService` - An Amazon Web Service cloud account. Cisco Intersight Workload Optimizer and Virtualization features are supported on this cloud.\n* `AmazonWebServiceBilling` - An Amazon Web Service cloud billing account used to retrieve billing information stored in S3 bucket. Cisco Intersight Workload Optimizer features are supported on this cloud.\n* `GoogleCloudPlatform` - A Google Cloud Platform service account with access to one or more projects. Cisco Intersight Workload Optimizer features are supported on this cloud.\n* `GoogleCloudPlatformBilling` - A Google Cloud Platform service account used to retrieve billing information from BigQuery. Cisco Intersight Workload Optimizer features are supported on this cloud.\n* `MicrosoftAzureServicePrincipal` - A Microsoft Azure Service Principal account with access to Azure subscriptions. Cisco Intersight Workload Optimizer features are supported on this cloud.\n* `MicrosoftAzureEnterpriseAgreement` - A Microsoft Azure Enterprise Agreement enrolment used to retrieve pricing and billing information. Cisco Intersight Workload Optimizer features are supported on this cloud.\n* `MicrosoftAzureBilling` - A Microsoft Azure Service Principal account with access to billing information. Cisco Intersight Workload Optimizer features are supported on this cloud.\n* `DellCompellent` - A Dell EMC SC Series (Compellent) storage system that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this device.\n* `HPE3Par` - A HPE 3PAR StoreServ system that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this device.\n* `RedHatEnterpriseVirtualization` - A Red Hat Enterprise Virtualization Hypervisor system that manages Virtual Machines.\n* `NutanixAcropolis` - A Nutanix Acropolis cluster that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this cluster.\n* `NutanixPrismCentral` - A Nutanix Prism Central cluster. Prism central is a virtual appliance for managing Nutanix clusters and services.\n* `HPEOneView` - A HPE OneView system that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this system.\n* `ServiceEngine` - Cisco Application Services Engine. Cisco Application Services Engine is a platform to deploy and manage applications.\n* `HitachiVirtualStoragePlatform` - A Hitachi Virtual Storage Platform (Hitachi VSP) that is managed using Cisco Intersight Assist.\n* `GenericTarget` - A generic third-party target supported only in Partner Integration Appliance. This target type is used for development purposes and will not be supported in production environment.\n* `IMCBlade` - A Cisco UCS blade server managed by Cisco Intersight.\n* `TerraformCloud` - A Terraform Cloud Business Tier account.\n* `TerraformAgent` - A Terraform Cloud Agent that will be deployed on Cisco Intersight Assist. The agent can be used to plan and apply Terraform runs from a Terraform Cloud workspace.\n* `CustomTarget` - CustomTarget is deprecated. Use HTTPEndpoint type to claim HTTP endpoints.\n* `AnsibleEndpoint` - An external endpoint that is added as a target which can be accessed through Ansible in Intersight Cloud Orchestrator automation workflows.\n* `HTTPEndpoint` - An HTTP endpoint that can be accessed in Intersight Orchestrator workflows directly or using Cisco Intersight Assist. Authentication Schemes supported are Basic and Bearer Token.\n* `SSHEndpoint` - An SSH endpoint that can be accessed in Intersight Orchestrator workflows using Cisco Intersight Assist.\n* `CiscoCatalyst` - A Cisco Catalyst networking switch device.\n* `PowerShellEndpoint` - A Windows operating system server on which PowerShell scripts can be executed using Cisco Intersight Assist.\n* `CiscoDNAC` - A Cisco Digital Network Architecture (DNA) Center appliance.\n* `CiscoFMC` - A Cisco Secure Firewall Management Center.\n* `ViptelaCloud` - ViptelaCloud is deprecated. Use CatalystSDWANManager type to claim Catalyst SDWAN Manager which can manage Catalyst SDWAN devices.\n* `CatalystSDWANManager` - A Cisco Catalyst SD-WAN Manager.\n* `MerakiCloud` - A Cisco Meraki Organization.\n* `CiscoISE` - A Cisco Identity Services Engine (ISE) target.", "type": "string", "enum": [ "", "APIC", "CAPIC", "DCNM", "UCSFI", "UCSFIISM", "IMC", "IMCM4", "IMCM5", "IMCRack", "UCSIOM", "UCSPCIeNODE", "UCSXFM", "HX", "UCSD", "UCSXECMC", "UCSXESecureRouter", "IntersightAppliance", "IntersightAssist", "PureStorageFlashArray", "PureStorageFlashBladeSystem", "NexusDevice", "ACISwitch", "NexusSwitch", "MDSSwitch", "MDSDevice", "UCSC885", "CAI845A", "UCSC890", "RedfishServer", "NetAppOntap", "NetAppActiveIqUnifiedManager", "EmcScaleIo", "EmcVmax", "EmcVplex", "EmcXtremIo", "VmwareVcenter", "MicrosoftHyperV", "AppDynamics", "Dynatrace", "NewRelic", "ServiceNow", "Umbrella", "CloudFoundry", "MicrosoftAzureApplicationInsights", "OpenStack", "MicrosoftSqlServer", "MySqlServer", "OracleDatabaseServer", "IBMWebSphereApplicationServer", "OracleWebLogicServer", "ApacheTomcatServer", "JavaVirtualMachine", "RedHatJBossApplicationServer", "Kubernetes", "AmazonWebService", "AmazonWebServiceBilling", "GoogleCloudPlatform", "GoogleCloudPlatformBilling", "MicrosoftAzureServicePrincipal", "MicrosoftAzureEnterpriseAgreement", "MicrosoftAzureBilling", "DellCompellent", "HPE3Par", "RedHatEnterpriseVirtualization", "NutanixAcropolis", "NutanixPrismCentral", "HPEOneView", "ServiceEngine", "HitachiVirtualStoragePlatform", "GenericTarget", "IMCBlade", "TerraformCloud", "TerraformAgent", "CustomTarget", "AnsibleEndpoint", "HTTPEndpoint", "SSHEndpoint", "CiscoCatalyst", "PowerShellEndpoint", "CiscoDNAC", "CiscoFMC", "ViptelaCloud", "CatalystSDWANManager", "MerakiCloud", "CiscoISE" ], "default": "", "readOnly": true, "x-omitempty": true }, "Account": { "$ref": "#/components/schemas/iam.Account.Relationship", "description": "A reference to a iamAccount resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "EndPointPrivileges": { "description": "An array of relationships to iamEndPointPrivilege resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.EndPointPrivilege.Relationship" }, "nullable": true, "readOnly": true }, "System": { "$ref": "#/components/schemas/iam.System.Relationship", "description": "A reference to a iamSystem resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "iam.EndPointRole.List": { "title": "List of 'iam.EndPointRole' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.EndPointRole' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.EndPointRole' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.EndPointRole" }, "nullable": true } } } ] }, "iam.EndPointUser.Response": { "description": "The response body of a HTTP GET request for the 'iam.EndPointUser' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.EndPointUser' resources.", "x-one-of-name": "iam.EndPointUser.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.EndPointUser.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.EndPointUser.Relationship": { "description": "A relationship to the 'iam.EndPointUser' resource, or the expanded 'iam.EndPointUser' resource, or the 'null' value.", "x-one-of-name": "iam.EndPointUser.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iam.EndPointUser" } ], "discriminator": { "propertyName": "ClassId" } }, "iam.EndPointUser": { "title": "User", "description": "The IAM EndPointUser object represents a single local user account. It is a building block used within the EndPointUserPolicy to define the users that should be created on an endpoint.\n#### Purpose\nThe purpose is to define the identity of a local user, primarily their username. It acts as a referenceable entity that can be associated with roles and a password within the broader EndPointUserPolicy.\n#### Key Concepts\n- **User Identity:** The core function of this is to specify the name (username) of the local user.\n- **Component of a Policy:** It does not function on its own but is created as part of an EndPointUserPolicy.\n- **Reusable within an Organization:** As an organization-owned object, a single EndPointUser can be referenced in multiple EndPointUserRole mappings across different policies, though it typically represents a unique user identity.", "x-allOf-name": "iam.EndPointUser", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.EndPointUser', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.EndPointUser" ], "default": "iam.EndPointUser", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.EndPointUser" ], "default": "iam.EndPointUser", "x-enum-as-string": true }, "Name": { "description": "Name of the user to be created on the endpoint. It can be any string that adheres to the following constraints. It can have alphanumeric characters, dots, underscores and hyphen. It cannot be more than 16 characters.", "type": "string", "pattern": "^[a-zA-Z0-9\\._\\-]+$", "maxLength": 16, "x-omitempty": true }, "EndPointUserRole": { "description": "An array of relationships to iamEndPointUserRole resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.EndPointUserRole.Relationship" }, "nullable": true }, "Organization": { "$ref": "#/components/schemas/organization.Organization.Relationship", "description": "A reference to a organizationOrganization resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true } } } ] }, "iam.EndPointUser.List": { "title": "List of 'iam.EndPointUser' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.EndPointUser' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.EndPointUser' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.EndPointUser" }, "nullable": true } } } ] }, "iam.EndPointUserInventory.Response": { "description": "The response body of a HTTP GET request for the 'iam.EndPointUserInventory' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.EndPointUserInventory' resources.", "x-one-of-name": "iam.EndPointUserInventory.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.EndPointUserInventory.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.EndPointUserInventory.Relationship": { "description": "A relationship to the 'iam.EndPointUserInventory' resource, or the expanded 'iam.EndPointUserInventory' resource, or the 'null' value.", "x-one-of-name": "iam.EndPointUserInventory.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iam.EndPointUserInventory" } ], "discriminator": { "propertyName": "ClassId" } }, "iam.EndPointUserInventory": { "title": "User", "description": "The IAM EndPointUser object represents a single local user account. It is a building block used within the EndPointUserPolicy to define the users that should be created on an endpoint.\n#### Purpose\nThe purpose is to define the identity of a local user, primarily their username. It acts as a referenceable entity that can be associated with roles and a password within the broader EndPointUserPolicy.\n#### Key Concepts\n- **User Identity:** The core function of this is to specify the name (username) of the local user.\n- **Component of a Policy:** It does not function on its own but is created as part of an EndPointUserPolicy.\n- **Reusable within an Organization:** As an organization-owned object, a single EndPointUser can be referenced in multiple EndPointUserRole mappings across different policies, though it typically represents a unique user identity.", "x-allOf-name": "iam.EndPointUserInventory", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractInventory" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.EndPointUserInventory', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.EndPointUserInventory" ], "default": "iam.EndPointUserInventory", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.EndPointUserInventory" ], "default": "iam.EndPointUserInventory", "x-enum-as-string": true }, "Name": { "description": "Name of the user to be created on the endpoint. It can be any string that adheres to the following constraints. It can have alphanumeric characters, dots, underscores and hyphen. It cannot be more than 16 characters.", "type": "string", "pattern": "^[a-zA-Z0-9\\._\\-]+$", "maxLength": 16, "readOnly": true, "x-omitempty": true }, "UserId": { "description": "UserId for the end point user.", "type": "string", "readOnly": true, "x-omitempty": true }, "EndPointUserRole": { "description": "An array of relationships to iamEndPointUserRoleInventory resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.EndPointUserRoleInventory.Relationship" }, "nullable": true, "readOnly": true }, "TargetMo": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo.Relationship", "description": "A reference to a moBaseMo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "iam.EndPointUserInventory.List": { "title": "List of 'iam.EndPointUserInventory' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.EndPointUserInventory' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.EndPointUserInventory' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.EndPointUserInventory" }, "nullable": true } } } ] }, "iam.EndPointUserPolicy.Response": { "description": "The response body of a HTTP GET request for the 'iam.EndPointUserPolicy' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.EndPointUserPolicy' resources.", "x-one-of-name": "iam.EndPointUserPolicy.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.EndPointUserPolicy.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.EndPointUserPolicy.Relationship": { "description": "A relationship to the 'iam.EndPointUserPolicy' resource, or the expanded 'iam.EndPointUserPolicy' resource, or the 'null' value.", "x-one-of-name": "iam.EndPointUserPolicy.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iam.EndPointUserPolicy" } ], "discriminator": { "propertyName": "ClassId" } }, "iam.EndPointUserPolicy": { "title": "Local User", "description": "The IAM EndPointUserPolicy object is a reusable policy that enables the creation and management of local user accounts on endpoints, such as server management controllers.\n#### Purpose\nThe purpose of this policy is to standardize local user account configurations across multiple servers. It allows administrators to define password complexity rules, password expiration settings, and associate specific roles and permissions with local users, ensuring consistent and secure access control.\n#### Key Concepts\n- **Centralized User Management:** Provides a single policy to define local user accounts, their roles, and password settings that can be applied to many servers.\n- **Password Properties:** The policy includes a comprehensive set of password controls, such as enforcing strong passwords, setting expiration durations, and maintaining a password history.\n- **Role-Based Access Control:** It works in conjunction with EndPointUser and EndPointUserRole objects to map users to specific roles (e.g., admin, read-only) on the endpoint.\n- **Profile-Based Application:** The policy is attached to a Server Profile to apply the user configurations to the assigned physical server.", "x-allOf-name": "iam.EndPointUserPolicy", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractPolicy" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.EndPointUserPolicy', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.EndPointUserPolicy" ], "default": "iam.EndPointUserPolicy", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.EndPointUserPolicy" ], "default": "iam.EndPointUserPolicy", "x-enum-as-string": true }, "AccountLockoutDuration": { "description": "Timeout duration specifies the duration (in seconds) after which a locked account is automatically unlocked. - Set to 0 when accountUnlockMode is Manual. - Set a value between 1 and 604800 when accountUnlockMode is Automatic.", "type": "integer", "format": "int64", "default": 300, "minimum": 0, "maximum": 604800, "x-omitempty": true }, "AccountLockoutThreshold": { "description": "Set Account Lockout Threshold for endpoint users.", "type": "integer", "format": "int64", "default": 5, "minimum": 0, "maximum": 65535, "x-omitempty": true }, "AccountUnlockMode": { "description": "Account unlock method specifies how the account is unlocked after it is locked: - Manual: Account must be manually unlocked by an administrator. - Automatic: Account unlocks automatically after a timeout duration.\n* `Automatic` - Set Automatic on the selected end point.\n* `Manual` - Set Manual on the selected end point.", "type": "string", "enum": [ "Automatic", "Manual" ], "default": "Automatic", "x-omitempty": true }, "PasswordProperties": { "description": "Set password properties for endpoint users.", "$ref": "#/components/schemas/iam.EndPointPasswordProperties", "x-omitempty": true }, "EndPointUserRoles": { "description": "An array of relationships to iamEndPointUserRole resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.EndPointUserRole.Relationship" }, "nullable": true }, "Organization": { "$ref": "#/components/schemas/organization.Organization.Relationship", "description": "A reference to a organizationOrganization resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true }, "Profiles": { "deprecated": true, "x-sunset": "2028-03-01", "description": "An array of relationships to policyAbstractConfigProfile resources.", "type": "array", "items": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractConfigProfile.Relationship" }, "nullable": true } } } ] }, "iam.EndPointUserPolicy.List": { "title": "List of 'iam.EndPointUserPolicy' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.EndPointUserPolicy' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.EndPointUserPolicy' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.EndPointUserPolicy" }, "nullable": true } } } ] }, "iam.EndPointUserPolicyInventory.Response": { "description": "The response body of a HTTP GET request for the 'iam.EndPointUserPolicyInventory' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.EndPointUserPolicyInventory' resources.", "x-one-of-name": "iam.EndPointUserPolicyInventory.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.EndPointUserPolicyInventory.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.EndPointUserPolicyInventory.Relationship": { "description": "A relationship to the 'iam.EndPointUserPolicyInventory' resource, or the expanded 'iam.EndPointUserPolicyInventory' resource, or the 'null' value.", "x-one-of-name": "iam.EndPointUserPolicyInventory.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iam.EndPointUserPolicyInventory" } ], "discriminator": { "propertyName": "ClassId" } }, "iam.EndPointUserPolicyInventory": { "title": "Local User", "description": "The IAM EndPointUserPolicy object is a reusable policy that enables the creation and management of local user accounts on endpoints, such as server management controllers.\n#### Purpose\nThe purpose of this policy is to standardize local user account configurations across multiple servers. It allows administrators to define password complexity rules, password expiration settings, and associate specific roles and permissions with local users, ensuring consistent and secure access control.\n#### Key Concepts\n- **Centralized User Management:** Provides a single policy to define local user accounts, their roles, and password settings that can be applied to many servers.\n- **Password Properties:** The policy includes a comprehensive set of password controls, such as enforcing strong passwords, setting expiration durations, and maintaining a password history.\n- **Role-Based Access Control:** It works in conjunction with EndPointUser and EndPointUserRole objects to map users to specific roles (e.g., admin, read-only) on the endpoint.\n- **Profile-Based Application:** The policy is attached to a Server Profile to apply the user configurations to the assigned physical server.", "x-allOf-name": "iam.EndPointUserPolicyInventory", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractPolicyInventory" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.EndPointUserPolicyInventory', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.EndPointUserPolicyInventory" ], "default": "iam.EndPointUserPolicyInventory", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.EndPointUserPolicyInventory" ], "default": "iam.EndPointUserPolicyInventory", "x-enum-as-string": true }, "AccountLockoutDuration": { "description": "Timeout duration specifies the duration (in seconds) after which a locked account is automatically unlocked. - Set to 0 when accountUnlockMode is Manual. - Set a value between 1 and 604800 when accountUnlockMode is Automatic.", "type": "integer", "format": "int64", "default": 300, "minimum": 0, "maximum": 604800, "readOnly": true, "x-omitempty": true }, "AccountLockoutThreshold": { "description": "Set Account Lockout Threshold for endpoint users.", "type": "integer", "format": "int64", "default": 5, "minimum": 0, "maximum": 65535, "readOnly": true, "x-omitempty": true }, "AccountUnlockMode": { "description": "Account unlock method specifies how the account is unlocked after it is locked: - Manual: Account must be manually unlocked by an administrator. - Automatic: Account unlocks automatically after a timeout duration.\n* `Automatic` - Set Automatic on the selected end point.\n* `Manual` - Set Manual on the selected end point.", "type": "string", "enum": [ "Automatic", "Manual" ], "default": "Automatic", "readOnly": true, "x-omitempty": true }, "PasswordProperties": { "description": "Set password properties for endpoint users.", "$ref": "#/components/schemas/iam.EndPointPasswordProperties", "readOnly": true, "x-omitempty": true }, "EndPointUserRoles": { "description": "An array of relationships to iamEndPointUserRoleInventory resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.EndPointUserRoleInventory.Relationship" }, "nullable": true, "readOnly": true }, "TargetMo": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo.Relationship", "description": "A reference to a moBaseMo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "iam.EndPointUserPolicyInventory.List": { "title": "List of 'iam.EndPointUserPolicyInventory' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.EndPointUserPolicyInventory' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.EndPointUserPolicyInventory' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.EndPointUserPolicyInventory" }, "nullable": true } } } ] }, "iam.EndPointUserRole.Response": { "description": "The response body of a HTTP GET request for the 'iam.EndPointUserRole' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.EndPointUserRole' resources.", "x-one-of-name": "iam.EndPointUserRole.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.EndPointUserRole.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.EndPointUserRole.Relationship": { "description": "A relationship to the 'iam.EndPointUserRole' resource, or the expanded 'iam.EndPointUserRole' resource, or the 'null' value.", "x-one-of-name": "iam.EndPointUserRole.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iam.EndPointUserRole" } ], "discriminator": { "propertyName": "ClassId" } }, "iam.EndPointUserRole": { "title": "Iam:End Point User Role", "description": "The IAM EndPointUserRole object is a mapping object that links a local user to their assigned roles and password within the context of an EndPointUserPolicy.\n#### Purpose\nThe IAM EndPointUserRole objects purpose is to bind together three key pieces of information: the user, their password, and their permissions. It serves as the mechanism for granting specific roles (like admin or read-only) to an EndPointUser and securely storing the encrypted password for that user's account on the endpoint.\n#### Key Concepts\n- **User-Role-Password Mapping:** It connects an EndPointUser object with a collection of EndPointRole objects and contains the password for that user.\n- **Secure Password Handling:** The password property is write-only and encrypted, ensuring credentials are not exposed after being set.\n- **Component of a Policy:** It exists as part of the endPointUserRoles collection within an EndPointUserPolicy and is essential for defining a complete user account.\n- **Account Status:** Includes an enabled flag to control whether the user account is active on the endpoint.", "x-allOf-name": "iam.EndPointUserRole", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.EndPointUserRole', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.EndPointUserRole" ], "default": "iam.EndPointUserRole", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.EndPointUserRole" ], "default": "iam.EndPointUserRole", "x-enum-as-string": true }, "AccountTypeUserDefined": { "description": "Allows to choose custom account types for the endpoint user.", "type": "boolean", "default": false, "x-omitempty": true }, "AccountTypes": { "type": "array", "items": { "description": "Type of account to be created on the endpoint. localUser - Creates a local user on the endpoint. IPMIUser - Creates an IPMI user on the endpoint.", "$ref": "#/components/schemas/iam.AccountTypeBase", "x-omitempty": true }, "nullable": true }, "ChangePassword": { "description": "Denotes whether password has changed.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "Enabled": { "description": "Enables the user account on the endpoint.", "type": "boolean", "x-omitempty": true }, "IsPasswordSet": { "description": "Indicates whether the value of the 'password' property has been set.", "type": "boolean", "default": false, "readOnly": true, "x-omitempty": true }, "Password": { "description": "The password must have a minimum of 8 and a maximum of 127 characters. For servers with IPMI user role enabled, the maximum length is limited to 20 characters. When strong password is enabled, must satisfy below requirements: A. The password must not contain the User's Name. B. The password must contain characters from three of the following four categories. 1) English uppercase characters (A through Z). 2) English lowercase characters (a through z). 3) Base 10 digits (0 through 9). 4) Non-alphabetic characters (! , @, #, $, %, ^, &, *, -, _, +, =).", "type": "string", "pattern": "^$|^[a-zA-Z0-9!@#$%^&\\*+-_=]+$", "minLength": 8, "maxLength": 127, "writeOnly": true, "x-omitempty": true }, "EndPointRole": { "description": "An array of relationships to iamEndPointRole resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.EndPointRole.Relationship" }, "nullable": true }, "EndPointUser": { "$ref": "#/components/schemas/iam.EndPointUser.Relationship", "description": "A reference to a iamEndPointUser resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "EndPointUserPolicy": { "$ref": "#/components/schemas/iam.EndPointUserPolicy.Relationship", "description": "A reference to a iamEndPointUserPolicy resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." } } } ] }, "iam.EndPointUserRole.List": { "title": "List of 'iam.EndPointUserRole' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.EndPointUserRole' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.EndPointUserRole' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.EndPointUserRole" }, "nullable": true } } } ] }, "iam.EndPointUserRoleInventory.Response": { "description": "The response body of a HTTP GET request for the 'iam.EndPointUserRoleInventory' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.EndPointUserRoleInventory' resources.", "x-one-of-name": "iam.EndPointUserRoleInventory.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.EndPointUserRoleInventory.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.EndPointUserRoleInventory.Relationship": { "description": "A relationship to the 'iam.EndPointUserRoleInventory' resource, or the expanded 'iam.EndPointUserRoleInventory' resource, or the 'null' value.", "x-one-of-name": "iam.EndPointUserRoleInventory.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iam.EndPointUserRoleInventory" } ], "discriminator": { "propertyName": "ClassId" } }, "iam.EndPointUserRoleInventory": { "title": "Iam:End Point User Role Inventory", "description": "The IAM EndPointUserRole object is a mapping object that links a local user to their assigned roles and password within the context of an EndPointUserPolicy.\n#### Purpose\nThe IAM EndPointUserRole objects purpose is to bind together three key pieces of information: the user, their password, and their permissions. It serves as the mechanism for granting specific roles (like admin or read-only) to an EndPointUser and securely storing the encrypted password for that user's account on the endpoint.\n#### Key Concepts\n- **User-Role-Password Mapping:** It connects an EndPointUser object with a collection of EndPointRole objects and contains the password for that user.\n- **Secure Password Handling:** The password property is write-only and encrypted, ensuring credentials are not exposed after being set.\n- **Component of a Policy:** It exists as part of the endPointUserRoles collection within an EndPointUserPolicy and is essential for defining a complete user account.\n- **Account Status:** Includes an enabled flag to control whether the user account is active on the endpoint.", "x-allOf-name": "iam.EndPointUserRoleInventory", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractInventory" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.EndPointUserRoleInventory', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.EndPointUserRoleInventory" ], "default": "iam.EndPointUserRoleInventory", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.EndPointUserRoleInventory" ], "default": "iam.EndPointUserRoleInventory", "x-enum-as-string": true }, "AccountTypeUserDefined": { "description": "Allows to choose custom account types for the endpoint user.", "type": "boolean", "default": false, "readOnly": true, "x-omitempty": true }, "AccountTypes": { "type": "array", "items": { "description": "Type of account to be created on the endpoint. localUser - Creates a local user on the endpoint. IPMIUser - Creates an IPMI user on the endpoint.", "$ref": "#/components/schemas/iam.AccountTypeBase", "readOnly": true, "x-omitempty": true }, "nullable": true }, "ChangePassword": { "description": "Denotes whether password has changed.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "Enabled": { "description": "Enables the user account on the endpoint.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "IsPasswordSet": { "description": "Indicates whether the value of the 'password' property has been set.", "type": "boolean", "default": false, "readOnly": true, "x-omitempty": true }, "Password": { "description": "The password must have a minimum of 8 and a maximum of 127 characters. For servers with IPMI user role enabled, the maximum length is limited to 20 characters. When strong password is enabled, must satisfy below requirements: A. The password must not contain the User's Name. B. The password must contain characters from three of the following four categories. 1) English uppercase characters (A through Z). 2) English lowercase characters (a through z). 3) Base 10 digits (0 through 9). 4) Non-alphabetic characters (! , @, #, $, %, ^, &, *, -, _, +, =).", "type": "string", "pattern": "^$|^[a-zA-Z0-9!@#$%^&\\*+-_=]+$", "minLength": 8, "maxLength": 127, "writeOnly": true, "x-omitempty": true }, "EndPointRole": { "description": "An array of relationships to iamEndPointRole resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.EndPointRole.Relationship" }, "nullable": true, "readOnly": true }, "EndPointUser": { "$ref": "#/components/schemas/iam.EndPointUserInventory.Relationship", "description": "A reference to a iamEndPointUserInventory resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "EndPointUserPolicy": { "$ref": "#/components/schemas/iam.EndPointUserPolicyInventory.Relationship", "description": "A reference to a iamEndPointUserPolicyInventory resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "iam.EndPointUserRoleInventory.List": { "title": "List of 'iam.EndPointUserRoleInventory' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.EndPointUserRoleInventory' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.EndPointUserRoleInventory' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.EndPointUserRoleInventory" }, "nullable": true } } } ] }, "iam.FailureDetails": { "title": "Iam:Failure Details", "description": "This has information including reason annd timestamp of failure event.", "x-allOf-name": "iam.FailureDetails", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.FailureDetails', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.FailureDetails" ], "default": "iam.FailureDetails", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.FailureDetails" ], "default": "iam.FailureDetails", "x-enum-as-string": true }, "FailureReason": { "description": "Reason for the failure during verification.", "type": "string", "readOnly": true, "x-omitempty": true }, "FailureTime": { "description": "Timestamp of the failure during verification.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true } } } ] }, "iam.FeatureDefinition": { "title": "Iam:Feature Definition", "description": "Feature parameters specified for the account.", "x-allOf-name": "iam.FeatureDefinition", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.FeatureDefinition', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.FeatureDefinition" ], "default": "iam.FeatureDefinition", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.FeatureDefinition" ], "default": "iam.FeatureDefinition", "x-enum-as-string": true }, "Feature": { "description": "The beta feature that will be enabled for specific account.\n* `IWO` - Intersight Workflow Optimizer.\n* `Hitachi` - Support to claim Hitachi Storage arrays using the Intersight Orchestrator framework.\n* `KubernetesExtension` - Extension to the IKS and Adopted Clusters.\n* `NetAppIO` - Support to claim NetApp Storage arrays as IO targets.\n* `IvsPublicCloud` - Enables virtualization service for public clouds.\n* `TerraformCloud` - Enables an ability to create Terraform Cloud.\n* `WashingtonEFT` - Support for EFT customers to use Washington firmware images for upgrades.\n* `Solutions` - Support for managing solutions.\n* `IksBm` - Enables Intersight Kubernetes Service on Baremetal server.\n* `NexusCloud` - Enables Nexus Cloud services functionality.\n* `NexusCloudTrial` - Enables Nexus Cloud trial period.\n* `NexusCloudUpgradeAssist` - Enables Nexus Cloud upgrade assist.\n* `NexusCloudSustainability` - Enables Nexus Cloud sustainability.\n* `PlatformUIRefresh` - Enables platform refreshed UI with new service launcher.\n* `IksGpu` - Enables GPU support for Intersight Kubernetes Service.\n* `IwoAppServiceVerticalScaling` - Enables vertical Scaling of App Service Plans.\n* `IwoDataExporter` - Enables IWO Data Exporter component.\n* `IwoMigrate` - Enables IWO data Migration.\n* `NexusCloudTechPreviewGold` - Enable Nexus Cloud Preview of stable features, available for public consumption.\n* `NexusCloudTechPreviewSilver` - Enable Nexus Cloud Preview of beta features. This feature set is intended for consumption by internal audiences.\n* `NexusCloudTechPreviewBronze` - Enable Nexus Cloud Preview of features still in development. This feature set is intended for consumption by internal audiences.\n* `DisconnectedTargetAlarm` - Raise an alarm when a Target is disconnected from Intersight. Intersight is unable to manage disconnected Targets.\n* `AsAService` - Enable AsAService Preview of beta features. This feature set is intended for consumption by selective audiences.\n* `EMEA` - Enable all avaialble features on Intersight EMEA region.\n* `CrossPlatformNavigation` - Enable Cross-Platform Navigation on UI.\n* `WorkflowsPreview` - Enable Workflows preview for this account.\n* `WorkflowsIntersightAssets` - Enable workflow Intersight assets for this account.\n* `ManualKEKSupport` - Enable support for Manual key to enhance storage controller security for this account.\n* `FirmwareConsolidationEFT` - Enable usage of firmware images transitioned from CCO to Intersight. This feature set is intended for consumption by internal audiences.\n* `FunctionAsAService` - Enable the usage of the function as a service (faas) for Workflows. This feature set is intended for consumption by selective audiences.\n* `FI6664EFT` - Support for EFT customers to use FI-6664 in Port Policy.\n* `GranularPrivilegeSets` - Enable granular privilege sets for this account.\n* `UnifiedEdge` - Enable Unified Edge related features for Avatar Platform.\n* `Goldeneye` - Enable Goldeneye related features.\n* `FI6652EFT` - Support for EFT customers to use FI-6652 in Port Policy.\n* `BackupAndRestore` - Enable Backup and Restore functionality for this account.\n* `CUIIntegration` - Enables Cisco Unified Identity (CUI) integration for Intersight accounts. With this flag, customers access their accounts using the intersight.com/cui URI and CUI IdP. Standard CCI or SSO login flows remain available during the transition period. Cisco Cloud Control customers must use /cui to create new accounts or contact Product Management to enable this feature to existing accounts, to use Cisco Cloud Control and Cisco Unified Identity.\n* `UnifiedEdgeSRN` - Enable Unified Edge Secure Router Node related features for Avatar Platform.", "type": "string", "enum": [ "IWO", "Hitachi", "KubernetesExtension", "NetAppIO", "IvsPublicCloud", "TerraformCloud", "WashingtonEFT", "Solutions", "IksBm", "NexusCloud", "NexusCloudTrial", "NexusCloudUpgradeAssist", "NexusCloudSustainability", "PlatformUIRefresh", "IksGpu", "IwoAppServiceVerticalScaling", "IwoDataExporter", "IwoMigrate", "NexusCloudTechPreviewGold", "NexusCloudTechPreviewSilver", "NexusCloudTechPreviewBronze", "DisconnectedTargetAlarm", "AsAService", "EMEA", "CrossPlatformNavigation", "WorkflowsPreview", "WorkflowsIntersightAssets", "ManualKEKSupport", "FirmwareConsolidationEFT", "FunctionAsAService", "FI6664EFT", "GranularPrivilegeSets", "UnifiedEdge", "Goldeneye", "FI6652EFT", "BackupAndRestore", "CUIIntegration", "UnifiedEdgeSRN" ], "default": "IWO", "x-omitempty": true } } } ] }, "iam.GroupPermissionToRoles": { "title": "Iam:Group Permission To Roles", "description": "Complex type representing the associated resource groups, organizations and the permission to roles mapping.", "x-allOf-name": "iam.GroupPermissionToRoles", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.GroupPermissionToRoles', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.GroupPermissionToRoles" ], "default": "iam.GroupPermissionToRoles", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.GroupPermissionToRoles" ], "default": "iam.GroupPermissionToRoles", "x-enum-as-string": true }, "Group": { "description": "Moid of the resource group.", "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef", "readOnly": true, "x-omitempty": true }, "Orgs": { "type": "array", "items": { "description": "Moids of the associated organizations.", "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef", "readOnly": true, "x-omitempty": true }, "nullable": true } } } ] }, "iam.GuestAccessSettings.Response": { "description": "The response body of a HTTP GET request for the 'iam.GuestAccessSettings' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.GuestAccessSettings' resources.", "x-one-of-name": "iam.GuestAccessSettings.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.GuestAccessSettings.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.GuestAccessSettings": { "title": "Iam:Guest Access Settings", "description": "Stores account level settings for guest user access.", "x-allOf-name": "iam.GuestAccessSettings", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.GuestAccessSettings', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.GuestAccessSettings" ], "default": "iam.GuestAccessSettings", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.GuestAccessSettings" ], "default": "iam.GuestAccessSettings", "x-enum-as-string": true }, "AllowedDomainNames": { "type": "array", "items": { "description": "Stores list of email domain names that are allowed for accessing an account. It is typically managed by an Account Admin who seeks to control and limit guest user logins based on their email domains. By specifying these domains, the administrator can ensure that users with email addresses from certain domains are allowed log in or registering as guests.", "type": "string", "pattern": "^[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$", "x-omitempty": true }, "nullable": true }, "MaxGuestAccessLinkShelfLife": { "description": "Stores the maximum duration (in seconds) during which guest access link remains valid and accessible. It is the maximum value that is set at the account level which account admin can configure. Any guest access link that is set with expiration time beyond this property will be disallowed. The default value is set to 604800 seconds (7 days).", "type": "integer", "format": "int64", "default": 604800, "minimum": 86400, "maximum": 31104000, "x-omitempty": true }, "OverrideIpAccessRestriction": { "description": "Stores an option for Account Admin to override IP Access Restriction if it is enabled in the Account. This option is used to disable IP Access restrictions for guest users logging in to the account, while restriction is enforced for other normal users (who are authenticated via SAML or LDAP).", "type": "boolean", "x-omitempty": true }, "ResourceLimits": { "$ref": "#/components/schemas/iam.ResourceLimits.Relationship", "description": "A reference to a iamResourceLimits resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "iam.GuestAccessSettings.List": { "title": "List of 'iam.GuestAccessSettings' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.GuestAccessSettings' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.GuestAccessSettings' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.GuestAccessSettings" }, "nullable": true } } } ] }, "iam.Idp.Response": { "description": "The response body of a HTTP GET request for the 'iam.Idp' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.Idp' resources.", "x-one-of-name": "iam.Idp.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.Idp.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.Idp.Relationship": { "description": "A relationship to the 'iam.Idp' resource, or the expanded 'iam.Idp' resource, or the 'null' value.", "x-one-of-name": "iam.Idp.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iam.Idp" } ], "discriminator": { "propertyName": "ClassId" } }, "iam.Idp": { "title": "Iam:Idp", "description": "The SAML identity provider such as Cisco, that has been used to log in to Intersight.", "x-allOf-name": "iam.Idp", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.Idp', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.Idp" ], "default": "iam.Idp", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.Idp" ], "default": "iam.Idp", "x-enum-as-string": true }, "DomainName": { "description": "Email domain name of the user for this IdP. When a user enters an email during login in the Intersight home page, the IdP is picked by matching this domain name with the email domain name for authentication.", "deprecated": true, "x-sunset": "2027-03-01", "type": "string", "pattern": "^$|^[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$", "x-omitempty": true }, "DomainNames": { "type": "array", "items": { "description": "Collection of domain names that the end user wants to tie to particular IdP.", "type": "string", "pattern": "^$|^[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$", "x-omitempty": true }, "minItems": 0, "maxItems": 20, "nullable": true }, "EnableSingleLogout": { "description": "Setting that indicates whether 'Single Logout (SLO)' has been enabled for this IdP.", "type": "boolean", "x-omitempty": true }, "IdpEntityId": { "description": "The Entity ID of the IdP. In SAML, the entity ID uniquely identifies the IdP or Service Provider.", "type": "string", "readOnly": true, "x-omitempty": true }, "Metadata": { "description": "SAML metadata of the IdP.", "type": "string", "x-omitempty": true }, "Name": { "description": "The name of the Identity Provider, for example Cisco, Okta, or OneID.", "type": "string", "x-omitempty": true }, "SkipWarning": { "description": "When users attempt the Account URL login with an unverified Domain Name, they get a warning stating that they are logging in using an unverified Domain Name. Enable the slider if you do not wish to see the warning message.", "type": "boolean", "x-omitempty": true }, "Type": { "description": "Authentication protocol used by the IdP.\n* `saml` - Use SAML as the authentication protocol for sign-on.\n* `oidc` - Open ID connect to be used as an authentication protocol for sign-on.\n* `local` - The local authentication method to be used for sign-on. Local type is set to default for the Intersight Appliance IdP.\n* `guest` - Guest users accessing Intersight are assigned to a guest Identity Provider (IdP). They do not have single sign-on options available and must log in using their email address and a one-time password (OTP). Upon successful authentication, all guest users associated with the account are grouped under the guest IdP. Guest IdP is primarily used in cloud environment.", "type": "string", "enum": [ "saml", "oidc", "local", "guest" ], "default": "saml", "x-omitempty": true }, "Account": { "$ref": "#/components/schemas/iam.Account.Relationship", "description": "A reference to a iamAccount resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "LdapMeta": { "$ref": "#/components/schemas/iam.LdapMeta.Relationship", "description": "A reference to a iamLdapMeta resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "LdapPolicy": { "$ref": "#/components/schemas/iam.LdapPolicy.Relationship", "description": "A reference to a iamLdapPolicy resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "System": { "$ref": "#/components/schemas/iam.System.Relationship", "description": "A reference to a iamSystem resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "TestIdp": { "$ref": "#/components/schemas/iam.TestIdpConfiguration.Relationship", "description": "A reference to a iamTestIdpConfiguration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "UserPreferences": { "description": "An array of relationships to iamUserPreference resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.UserPreference.Relationship" }, "nullable": true, "readOnly": true }, "UserSettings": { "description": "An array of relationships to iamUserSetting resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.UserSetting.Relationship" }, "nullable": true, "readOnly": true }, "Usergroups": { "description": "An array of relationships to iamUserGroup resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.UserGroup.Relationship" }, "nullable": true }, "Users": { "description": "An array of relationships to iamUser resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.User.Relationship" }, "nullable": true } } } ] }, "iam.Idp.List": { "title": "List of 'iam.Idp' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.Idp' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.Idp' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.Idp" }, "nullable": true } } } ] }, "iam.IdpReference.Response": { "description": "The response body of a HTTP GET request for the 'iam.IdpReference' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.IdpReference' resources.", "x-one-of-name": "iam.IdpReference.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.IdpReference.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.IdpReference.Relationship": { "description": "A relationship to the 'iam.IdpReference' resource, or the expanded 'iam.IdpReference' resource, or the 'null' value.", "x-one-of-name": "iam.IdpReference.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iam.IdpReference" } ], "discriminator": { "propertyName": "ClassId" } }, "iam.IdpReference": { "title": "Iam:Idp Reference", "description": "The IdpReference object represents the system-provided Cisco IdP association within an account, acting as the default reference for user and group assignments.\n#### Purpose\nIdpReference simplifies managing the default IdP relationship for user onboarding, preferences, and access.\n#### Key Concepts\n- **Default IdP linkage:** Provides a stable, system-backed IdP reference.\n- **User/group Association:** Central to managing users and groups tied to the Cisco IdP.\n- **Preference Anchor:** Links user UI preferences and settings to the IdP context.\n- **Account Scope:** Managed within the owning account's boundaries.", "x-allOf-name": "iam.IdpReference", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.IdpReference', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.IdpReference" ], "default": "iam.IdpReference", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.IdpReference" ], "default": "iam.IdpReference", "x-enum-as-string": true }, "DomainName": { "description": "The DomainNameInfo object represents an organization\u2019s email domain used during login mapping and ownership verification. It supports verifying domain control via DNS to enhance trust.\n#### Purpose\nDomainNameInfo ensures that only verified domains are used to route users to the correct identity provider, improving login integrity.\n#### Key Concepts\n- **Domain Routing:** Associates email domains with IdPs for seamless login.\n- **Ownership Verification:** Supports DNS-based verification for trust establishment.\n- **Status Tracking:** Maintains domain verification lifecycle state.\n- **Account Scoped:** Managed within the context of the owning account.", "type": "string", "readOnly": true, "x-omitempty": true }, "IdpEntityId": { "description": "Entity ID of the IdP. In SAML, the entity ID uniquely identifies the IdP/Service Provider.", "type": "string", "readOnly": true, "x-omitempty": true }, "MultiFactorAuthentication": { "description": "The flag represents if the second factor of authentication is required for Cisco IdP users.", "type": "boolean", "default": false, "x-omitempty": true }, "Name": { "description": "Cisco IdP reference in an account.", "type": "string", "readOnly": true, "x-omitempty": true }, "Account": { "$ref": "#/components/schemas/iam.Account.Relationship", "description": "A reference to a iamAccount resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Idp": { "$ref": "#/components/schemas/iam.Idp.Relationship", "description": "A reference to a iamIdp resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "UserPreferences": { "description": "An array of relationships to iamUserPreference resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.UserPreference.Relationship" }, "nullable": true, "readOnly": true }, "UserSettings": { "description": "An array of relationships to iamUserSetting resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.UserSetting.Relationship" }, "nullable": true, "readOnly": true }, "Usergroups": { "description": "An array of relationships to iamUserGroup resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.UserGroup.Relationship" }, "nullable": true }, "Users": { "description": "An array of relationships to iamUser resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.User.Relationship" }, "nullable": true } } } ] }, "iam.IdpReference.List": { "title": "List of 'iam.IdpReference' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.IdpReference' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.IdpReference' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.IdpReference" }, "nullable": true } } } ] }, "iam.IpAccessManagement.Response": { "description": "The response body of a HTTP GET request for the 'iam.IpAccessManagement' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.IpAccessManagement' resources.", "x-one-of-name": "iam.IpAccessManagement.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.IpAccessManagement.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.IpAccessManagement.Relationship": { "description": "A relationship to the 'iam.IpAccessManagement' resource, or the expanded 'iam.IpAccessManagement' resource, or the 'null' value.", "x-one-of-name": "iam.IpAccessManagement.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iam.IpAccessManagement" } ], "discriminator": { "propertyName": "ClassId" } }, "iam.IpAccessManagement": { "title": "IP Access Management", "description": "IpAccessManagement governs IP-based access restrictions for an account, enabling administrators to allowlist trusted ranges and recover from misconfiguration.\n#### Purpose\nIt provides an additional security control layer that restricts access to the account based on client IP addresses.\n#### Key Concepts\n- **Allowlisting:** Enforces access based on configured addresses and ranges.\n- **Recovery Controls:** Supports account recovery from restrictive misconfigurations.\n- **Policy Toggle:** Enables or disables IP restriction enforcement.\n- **Centralized Management:** Hosted under the account\u2019s security holder.", "x-allOf-name": "iam.IpAccessManagement", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.IpAccessManagement', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.IpAccessManagement" ], "default": "iam.IpAccessManagement", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.IpAccessManagement" ], "default": "iam.IpAccessManagement", "x-enum-as-string": true }, "Enable": { "description": "Flag stores the state of IP address based access management. Access management is enabled when it's true.", "type": "boolean", "x-omitempty": true }, "LastRecoveryTime": { "description": "The access to account gets locked out if wrong IP addresses are configured. Account Administrators have privilege to unblock the account. It stores the time when the account was last recovered from lock out.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "Holder": { "$ref": "#/components/schemas/iam.SecurityHolder.Relationship", "description": "A reference to a iamSecurityHolder resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "IpAddresses": { "description": "An array of relationships to iamIpAddress resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.IpAddress.Relationship" }, "nullable": true, "readOnly": true } } } ] }, "iam.IpAccessManagement.List": { "title": "List of 'iam.IpAccessManagement' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.IpAccessManagement' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.IpAccessManagement' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.IpAccessManagement" }, "nullable": true } } } ] }, "iam.IpAddress.Response": { "description": "The response body of a HTTP GET request for the 'iam.IpAddress' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.IpAddress' resources.", "x-one-of-name": "iam.IpAddress.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.IpAddress.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.IpAddress.Relationship": { "description": "A relationship to the 'iam.IpAddress' resource, or the expanded 'iam.IpAddress' resource, or the 'null' value.", "x-one-of-name": "iam.IpAddress.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iam.IpAddress" } ], "discriminator": { "propertyName": "ClassId" } }, "iam.IpAddress": { "title": "IP Address", "description": "IpAddress represents a single allowlisted IP, CIDR block, or range used by IpAccessManagement.\n#### Purpose\nIt models an individual entry in the IP access policy to refine allowed sources.\n#### Key Concepts\n- **Entry Granularity:** Supports point IPs, CIDR, and address ranges.\n- **Descriptive Policy:** Accommodates human-readable rationale for entries.\n- **Policy Membership:** Always associated with an IpAccessManagement policy.\n- **Enforcement-ready:** Used directly in access control evaluations.", "x-allOf-name": "iam.IpAddress", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.IpAddress', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.IpAddress" ], "default": "iam.IpAddress", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.IpAddress" ], "default": "iam.IpAddress", "x-enum-as-string": true }, "Address": { "description": "The Trusted IP range's address. IP address, CIDR range, and IP address range formats are supported. For example '12.13.14.15', '12.13.14.0/24', and '12.13.14.15-12.13.14.200'. Reserved IP ranges '127.0.0.1', '10.0.0.0/8', '172.16.0.0/12', and '192.168.0.0/16' are not allowed.", "type": "string", "x-omitempty": true }, "Description": { "description": "Description of Trusted IP address range.", "type": "string", "x-omitempty": true }, "IpAccessManagement": { "$ref": "#/components/schemas/iam.IpAccessManagement.Relationship", "description": "A reference to a iamIpAccessManagement resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "iam.IpAddress.List": { "title": "List of 'iam.IpAddress' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.IpAddress' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.IpAddress' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.IpAddress" }, "nullable": true } } } ] }, "iam.LdapBaseProperties": { "title": "Iam:Ldap Base Properties", "description": "Base settings of LDAP required while configuring LDAP policy.", "x-allOf-name": "iam.LdapBaseProperties", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.LdapBaseProperties', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.LdapBaseProperties" ], "default": "iam.LdapBaseProperties", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.LdapBaseProperties" ], "default": "iam.LdapBaseProperties", "x-enum-as-string": true }, "Attribute": { "description": "Role and locale information of the user.", "type": "string", "pattern": "^$|^[a-zA-Z0-9][a-zA-Z0-9\\-\\.]*[a-zA-Z0-9\\-]$", "x-omitempty": true }, "BaseDn": { "description": "Base Distinguished Name (DN), the starting point for searching users and groups.", "type": "string", "maxLength": 254, "x-omitempty": true }, "BindDn": { "description": "Distinguished Name (DN) used to authenticate against LDAP servers.", "type": "string", "minLength": 0, "maxLength": 254, "x-omitempty": true }, "BindMethod": { "description": "Authentication method to access LDAP servers.\n* `LoginCredentials` - Requires the user credentials. If the bind process fails, then user is denied access.\n* `Anonymous` - Requires no username and password. If this option is selected and the LDAP server is configured for Anonymous logins, then the user gains access.\n* `ConfiguredCredentials` - Requires a known set of credentials to be specified for the initial bind process. If the initial bind process succeeds, then the distinguished name (DN) of the user name is queried and re-used for the re-binding process. If the re-binding process fails, then the user is denied access.", "type": "string", "enum": [ "LoginCredentials", "Anonymous", "ConfiguredCredentials" ], "default": "LoginCredentials", "x-omitempty": true }, "Domain": { "description": "The IPv4 domain that all users must be in.", "type": "string", "pattern": "^$|^(([a-zA-Z0-9])|([a-zA-Z0-9][a-zA-Z0-9\\.\\-]*[a-zA-Z0-9]))$", "maxLength": 255, "x-omitempty": true }, "EnableEncryption": { "description": "If enabled, the endpoint encrypts all information sent to the LDAP server.", "type": "boolean", "x-omitempty": true }, "EnableGroupAuthorization": { "description": "If enabled, user authorization is also done at the group level for LDAP users not in the local user database.", "type": "boolean", "x-omitempty": true }, "EnableNestedGroupSearch": { "description": "If enabled, an extended search walks the ancestry chain to the root and returns all groups and subgroups recursively.", "type": "boolean", "default": false, "x-omitempty": true }, "Filter": { "description": "Criteria to identify entries in search requests.", "type": "string", "pattern": "^$|^[a-zA-Z0-9(][a-zA-Z0-9_#@$%&\\-\\^|()*=:!,.]*[a-zA-Z0-9\\-)]$", "x-omitempty": true }, "GroupAttribute": { "description": "Groups to which an LDAP entry belongs.", "type": "string", "pattern": "^$|^[a-zA-Z0-9][a-zA-Z0-9_#@$%&\\-\\^]*[a-zA-Z0-9\\-]$", "x-omitempty": true }, "IsPasswordSet": { "description": "Indicates whether the value of the 'password' property has been set.", "type": "boolean", "default": false, "readOnly": true, "x-omitempty": true }, "NestedGroupSearchDepth": { "description": "Search depth to look for a nested LDAP group in an LDAP group map.", "type": "integer", "format": "int64", "default": 128, "minimum": 1, "maximum": 128, "x-omitempty": true }, "Password": { "description": "The password for the initial bind process. Must not contain spaces, tabs, or line breaks, and cannot exceed 254 characters.", "type": "string", "pattern": "^[\\S+]{0,254}$", "writeOnly": true, "x-omitempty": true }, "Timeout": { "description": "LDAP authentication timeout duration, in seconds.", "type": "integer", "format": "int64", "default": 0, "minimum": 0, "maximum": 180, "x-omitempty": true }, "UserSearchAttribute": { "type": "array", "items": { "description": "LDAP attributes used for username matching during authentication.\nMultiple attributes create an OR condition in the search filter.\nExamples: \"mail\", \"sAMAccountName\", \"uid\".\nLeave blank to use default attributes: \"mail\", \"sAMAccountName\".", "type": "string", "x-omitempty": true }, "nullable": true } } } ] }, "iam.LdapConfigParams.Response": { "description": "The response body of a HTTP GET request for the 'iam.LdapConfigParams' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.LdapConfigParams' resources.", "x-one-of-name": "iam.LdapConfigParams.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.LdapConfigParams.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.LdapConfigParams": { "title": "Iam:Ldap Config Params", "description": "LdapConfigParams stores additional configuration metadata used internally to support LDAP integration in appliance contexts.\n#### Purpose\nIt centralizes internal parameters that influence LDAP issuer and connector behaviors.\n#### Key Concepts\n- **Internal Config:** Not end-user facing; supports system connectors.\n- **Issuer Derivation:** Assists in building correct LDAP issuer URLs.\n- **Account Binding:** Parameters are scoped to the owning account.\n- **Lifecycle Managed:** Maintained by system services for stability.", "x-allOf-name": "iam.LdapConfigParams", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.LdapConfigParams', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.LdapConfigParams" ], "default": "iam.LdapConfigParams", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.LdapConfigParams" ], "default": "iam.LdapConfigParams", "x-enum-as-string": true }, "ConfigHost": { "description": "Stores the hostname based on which the issuer URL should be generated.", "type": "string", "x-omitempty": true }, "Account": { "$ref": "#/components/schemas/iam.Account.Relationship", "description": "A reference to a iamAccount resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "iam.LdapConfigParams.List": { "title": "List of 'iam.LdapConfigParams' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.LdapConfigParams' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.LdapConfigParams' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.LdapConfigParams" }, "nullable": true } } } ] }, "iam.LdapDnsParameters": { "title": "Iam:Ldap Dns Parameters", "description": "DNS settings used to access LDAP Providers.", "x-allOf-name": "iam.LdapDnsParameters", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.LdapDnsParameters', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.LdapDnsParameters" ], "default": "iam.LdapDnsParameters", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.LdapDnsParameters" ], "default": "iam.LdapDnsParameters", "x-enum-as-string": true }, "SearchDomain": { "description": "Domain name that acts as a source for a DNS query.", "type": "string", "pattern": "^$|^(([a-zA-Z0-9])|([a-zA-Z0-9][a-zA-Z0-9\\.\\-]*[a-zA-Z0-9]))$", "maxLength": 64, "x-omitempty": true }, "SearchForest": { "description": "Forest name that acts as a source for a DNS query.", "type": "string", "pattern": "^$|^(([a-zA-Z0-9])|([a-zA-Z0-9][a-zA-Z0-9\\.\\-]*[a-zA-Z0-9]))$", "maxLength": 64, "x-omitempty": true }, "Source": { "description": "Source of the domain name used for the DNS SRV request.\n* `Extracted` - The domain name extracted-domain from the login ID.\n* `Configured` - The configured-search domain.\n* `ConfiguredExtracted` - The domain name extracted from the login ID than the configured-search domain.", "type": "string", "enum": [ "Extracted", "Configured", "ConfiguredExtracted" ], "default": "Extracted", "x-omitempty": true } } } ] }, "iam.LdapGroup.Response": { "description": "The response body of a HTTP GET request for the 'iam.LdapGroup' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.LdapGroup' resources.", "x-one-of-name": "iam.LdapGroup.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.LdapGroup.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.LdapGroup.Relationship": { "description": "A relationship to the 'iam.LdapGroup' resource, or the expanded 'iam.LdapGroup' resource, or the 'null' value.", "x-one-of-name": "iam.LdapGroup.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iam.LdapGroup" } ], "discriminator": { "propertyName": "ClassId" } }, "iam.LdapGroup": { "title": "Iam:Ldap Group", "description": "The LDAP Group object creates a mapping between a group in a remote LDAP directory and a set of local roles on an endpoint.\n#### Purpose\nThe purpose is to grant permissions to remote users. When a user authenticates via LDAP and is found to be a member of a specified LDAP group, they are granted the permissions of the EndPointRoles associated with this LdapGroup object. This enables role-based access control for remote directory users.\n#### Key Concepts\n- **Group-to-Role Mapping:** Its core function is to link an LDAP group name (or DN) to one or more local endpoint roles (e.g., admin, read-only).\n- **Component of a Policy:** It is always defined within the context of an LdapPolicy.\n- **Authorization Mechanism:** Serves as the primary mechanism for authorizing remote users by assigning them appropriate privileges based on their directory group membership.", "x-allOf-name": "iam.LdapGroup", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.LdapGroup', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.LdapGroup" ], "default": "iam.LdapGroup", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.LdapGroup" ], "default": "iam.LdapGroup", "x-enum-as-string": true }, "Domain": { "description": "LDAP server domain the Group resides in.", "type": "string", "pattern": "^$|^[a-zA-Z0-9-]+(.[a-zA-Z0-9-]+)*$", "maxLength": 255, "x-omitempty": true }, "GroupDn": { "description": "LDAP Group DN in the LDAP server database.", "type": "string", "pattern": "^$|^([^+\\-][a-zA-Z0-9=!#$%()*+,-.:;@ _{|}~?&]*)$", "maxLength": 300, "x-omitempty": true }, "Name": { "description": "LDAP Group name in the LDAP server database.", "type": "string", "pattern": "^([^+\\-][a-zA-Z0-9=!#$%()*+,-.:;@ _{|}~?&]*)$", "maxLength": 127, "x-omitempty": true }, "EndPointRole": { "description": "An array of relationships to iamEndPointRole resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.EndPointRole.Relationship" }, "nullable": true }, "LdapPolicy": { "$ref": "#/components/schemas/iam.LdapPolicy.Relationship", "description": "A reference to a iamLdapPolicy resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." } } } ] }, "iam.LdapGroup.List": { "title": "List of 'iam.LdapGroup' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.LdapGroup' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.LdapGroup' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.LdapGroup" }, "nullable": true } } } ] }, "iam.LdapGroupInventory.Response": { "description": "The response body of a HTTP GET request for the 'iam.LdapGroupInventory' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.LdapGroupInventory' resources.", "x-one-of-name": "iam.LdapGroupInventory.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.LdapGroupInventory.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.LdapGroupInventory.Relationship": { "description": "A relationship to the 'iam.LdapGroupInventory' resource, or the expanded 'iam.LdapGroupInventory' resource, or the 'null' value.", "x-one-of-name": "iam.LdapGroupInventory.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iam.LdapGroupInventory" } ], "discriminator": { "propertyName": "ClassId" } }, "iam.LdapGroupInventory": { "title": "Iam:Ldap Group Inventory", "description": "The LDAP Group object creates a mapping between a group in a remote LDAP directory and a set of local roles on an endpoint.\n#### Purpose\nThe purpose is to grant permissions to remote users. When a user authenticates via LDAP and is found to be a member of a specified LDAP group, they are granted the permissions of the EndPointRoles associated with this LdapGroup object. This enables role-based access control for remote directory users.\n#### Key Concepts\n- **Group-to-Role Mapping:** Its core function is to link an LDAP group name (or DN) to one or more local endpoint roles (e.g., admin, read-only).\n- **Component of a Policy:** It is always defined within the context of an LdapPolicy.\n- **Authorization Mechanism:** Serves as the primary mechanism for authorizing remote users by assigning them appropriate privileges based on their directory group membership.", "x-allOf-name": "iam.LdapGroupInventory", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractInventory" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.LdapGroupInventory', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.LdapGroupInventory" ], "default": "iam.LdapGroupInventory", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.LdapGroupInventory" ], "default": "iam.LdapGroupInventory", "x-enum-as-string": true }, "Domain": { "description": "LDAP server domain the Group resides in.", "type": "string", "pattern": "^$|^[a-zA-Z0-9-]+(.[a-zA-Z0-9-]+)*$", "maxLength": 255, "readOnly": true, "x-omitempty": true }, "GroupDn": { "description": "LDAP Group DN in the LDAP server database.", "type": "string", "pattern": "^$|^([^+\\-][a-zA-Z0-9=!#$%()*+,-.:;@ _{|}~?&]*)$", "maxLength": 300, "readOnly": true, "x-omitempty": true }, "Name": { "description": "LDAP Group name in the LDAP server database.", "type": "string", "pattern": "^([^+\\-][a-zA-Z0-9=!#$%()*+,-.:;@ _{|}~?&]*)$", "maxLength": 127, "readOnly": true, "x-omitempty": true }, "EndPointRole": { "description": "An array of relationships to iamEndPointRole resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.EndPointRole.Relationship" }, "nullable": true, "readOnly": true }, "LdapPolicy": { "$ref": "#/components/schemas/iam.LdapPolicyInventory.Relationship", "description": "A reference to a iamLdapPolicyInventory resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "iam.LdapGroupInventory.List": { "title": "List of 'iam.LdapGroupInventory' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.LdapGroupInventory' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.LdapGroupInventory' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.LdapGroupInventory" }, "nullable": true } } } ] }, "iam.LdapMeta.Response": { "description": "The response body of a HTTP GET request for the 'iam.LdapMeta' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.LdapMeta' resources.", "x-one-of-name": "iam.LdapMeta.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.LdapMeta.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.LdapMeta.Relationship": { "description": "A relationship to the 'iam.LdapMeta' resource, or the expanded 'iam.LdapMeta' resource, or the 'null' value.", "x-one-of-name": "iam.LdapMeta.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iam.LdapMeta" } ], "discriminator": { "propertyName": "ClassId" } }, "iam.LdapMeta": { "title": "Iam:Ldap Meta", "description": "LdapMeta stores metadata for internal LDAP connectors created to support an appliance LDAP cluster configuration.\n#### Purpose\nIt provides system-managed insight into the LDAP integration topology associated with an IdP.\n#### Key Concepts\n- **Connector Inventory:** Lists internal connector names for an LDAP cluster.\n- **IdP Linkage:** Tied to the corresponding LDAP IdP domain.\n- **System-managed:** Created and maintained by internal services.\n- **Operational Visibility:** Aids diagnostics and lifecycle management.", "x-allOf-name": "iam.LdapMeta", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.LdapMeta', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.LdapMeta" ], "default": "iam.LdapMeta", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.LdapMeta" ], "default": "iam.LdapMeta", "x-enum-as-string": true }, "Connectors": { "type": "array", "items": { "description": "The list of internal ldap dex connectors created by the system for an Ldap server cluster.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Domain": { "description": "The domain of the Ldap IdP corresponding to the appliance Ldap configuration.", "type": "string", "readOnly": true, "x-omitempty": true }, "Idp": { "$ref": "#/components/schemas/iam.Idp.Relationship", "description": "A reference to a iamIdp resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." } } } ] }, "iam.LdapMeta.List": { "title": "List of 'iam.LdapMeta' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.LdapMeta' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.LdapMeta' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.LdapMeta" }, "nullable": true } } } ] }, "iam.LdapPolicy.Response": { "description": "The response body of a HTTP GET request for the 'iam.LdapPolicy' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.LdapPolicy' resources.", "x-one-of-name": "iam.LdapPolicy.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.LdapPolicy.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.LdapPolicy.Relationship": { "description": "A relationship to the 'iam.LdapPolicy' resource, or the expanded 'iam.LdapPolicy' resource, or the 'null' value.", "x-one-of-name": "iam.LdapPolicy.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iam.LdapPolicy" } ], "discriminator": { "propertyName": "ClassId" } }, "iam.LdapPolicy": { "title": "LDAP", "description": "### Overview\nThe LDAP Policy object is a reusable policy for configuring Lightweight Directory Access Protocol (LDAP) settings, enabling remote user authentication for endpoints like servers and chassis.\n#### Purpose\nThe primary purpose of an LDAP Policy is to integrate endpoints with a central directory service (like Microsoft Active Directory or OpenLDAP) for user authentication. This centralizes user management and allows administrators to grant access to Intersight-managed devices based on existing corporate directory groups and users, rather than creating separate local accounts on each device.\n#### Key Concepts\n- **Centralized Authentication:** - Enables endpoints to authenticate users against one or more external LDAP servers.\n- **Reusable and Profile-Based:** - As a policy object, this provides a standardized LDAP configuration that can be applied to multiple server or chassis profiles.\n- **Flexible Configuration:** - Supports various settings including the Base DN for searches, bind methods (Anonymous, Configured Credentials, Login Credentials), and connection settings like encryption and timeout.\n- **Group-to-Role Mapping:** - Works with LdapGroup objects to map directory groups to local endpoint roles, enabling granular, role-based access control for remote users.\n- **Provider and DNS Settings:** - Manages a list of LDAP servers (LdapProvider objects) and can be configured to use DNS for server discovery.", "x-allOf-name": "iam.LdapPolicy", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractPolicy" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.LdapPolicy', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.LdapPolicy" ], "default": "iam.LdapPolicy", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.LdapPolicy" ], "default": "iam.LdapPolicy", "x-enum-as-string": true }, "BaseProperties": { "description": "Base settings of LDAP required while configuring LDAP policy.", "$ref": "#/components/schemas/iam.LdapBaseProperties", "x-omitempty": true }, "DnsParameters": { "description": "Configuration settings to resolve LDAP servers, when DNS is enabled.", "$ref": "#/components/schemas/iam.LdapDnsParameters", "x-omitempty": true }, "EnableDns": { "description": "Enables DNS to access LDAP servers.", "type": "boolean", "x-omitempty": true }, "Enabled": { "description": "LDAP server performs authentication.", "type": "boolean", "default": true, "x-omitempty": true }, "UserSearchPrecedence": { "description": "Search precedence between local user database and LDAP user database.\n* `LocalUserDb` - Precedence is given to local user database while searching.\n* `LDAPUserDb` - Precedence is given to LADP user database while searching.", "type": "string", "enum": [ "LocalUserDb", "LDAPUserDb" ], "default": "LocalUserDb", "x-omitempty": true }, "ApplianceAccount": { "$ref": "#/components/schemas/iam.Account.Relationship", "description": "A reference to a iamAccount resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "Groups": { "description": "An array of relationships to iamLdapGroup resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.LdapGroup.Relationship" }, "nullable": true }, "Organization": { "$ref": "#/components/schemas/organization.Organization.Relationship", "description": "A reference to a organizationOrganization resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true }, "Profiles": { "deprecated": true, "x-sunset": "2028-03-01", "description": "An array of relationships to policyAbstractConfigProfile resources.", "type": "array", "items": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractConfigProfile.Relationship" }, "nullable": true }, "Providers": { "description": "An array of relationships to iamLdapProvider resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.LdapProvider.Relationship" }, "nullable": true, "x-createOnly": true } } } ] }, "iam.LdapPolicy.List": { "title": "List of 'iam.LdapPolicy' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.LdapPolicy' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.LdapPolicy' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.LdapPolicy" }, "nullable": true } } } ] }, "iam.LdapPolicyInventory.Response": { "description": "The response body of a HTTP GET request for the 'iam.LdapPolicyInventory' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.LdapPolicyInventory' resources.", "x-one-of-name": "iam.LdapPolicyInventory.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.LdapPolicyInventory.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.LdapPolicyInventory.Relationship": { "description": "A relationship to the 'iam.LdapPolicyInventory' resource, or the expanded 'iam.LdapPolicyInventory' resource, or the 'null' value.", "x-one-of-name": "iam.LdapPolicyInventory.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iam.LdapPolicyInventory" } ], "discriminator": { "propertyName": "ClassId" } }, "iam.LdapPolicyInventory": { "title": "LDAP", "description": "### Overview\nThe LDAP Policy object is a reusable policy for configuring Lightweight Directory Access Protocol (LDAP) settings, enabling remote user authentication for endpoints like servers and chassis.\n#### Purpose\nThe primary purpose of an LDAP Policy is to integrate endpoints with a central directory service (like Microsoft Active Directory or OpenLDAP) for user authentication. This centralizes user management and allows administrators to grant access to Intersight-managed devices based on existing corporate directory groups and users, rather than creating separate local accounts on each device.\n#### Key Concepts\n- **Centralized Authentication:** - Enables endpoints to authenticate users against one or more external LDAP servers.\n- **Reusable and Profile-Based:** - As a policy object, this provides a standardized LDAP configuration that can be applied to multiple server or chassis profiles.\n- **Flexible Configuration:** - Supports various settings including the Base DN for searches, bind methods (Anonymous, Configured Credentials, Login Credentials), and connection settings like encryption and timeout.\n- **Group-to-Role Mapping:** - Works with LdapGroup objects to map directory groups to local endpoint roles, enabling granular, role-based access control for remote users.\n- **Provider and DNS Settings:** - Manages a list of LDAP servers (LdapProvider objects) and can be configured to use DNS for server discovery.", "x-allOf-name": "iam.LdapPolicyInventory", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractPolicyInventory" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.LdapPolicyInventory', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.LdapPolicyInventory" ], "default": "iam.LdapPolicyInventory", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.LdapPolicyInventory" ], "default": "iam.LdapPolicyInventory", "x-enum-as-string": true }, "BaseProperties": { "description": "Base settings of LDAP required while configuring LDAP policy.", "$ref": "#/components/schemas/iam.LdapBaseProperties", "readOnly": true, "x-omitempty": true }, "DnsParameters": { "description": "Configuration settings to resolve LDAP servers, when DNS is enabled.", "$ref": "#/components/schemas/iam.LdapDnsParameters", "readOnly": true, "x-omitempty": true }, "EnableDns": { "description": "Enables DNS to access LDAP servers.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "Enabled": { "description": "LDAP server performs authentication.", "type": "boolean", "default": true, "readOnly": true, "x-omitempty": true }, "UserSearchPrecedence": { "description": "Search precedence between local user database and LDAP user database.\n* `LocalUserDb` - Precedence is given to local user database while searching.\n* `LDAPUserDb` - Precedence is given to LADP user database while searching.", "type": "string", "enum": [ "LocalUserDb", "LDAPUserDb" ], "default": "LocalUserDb", "readOnly": true, "x-omitempty": true }, "Groups": { "description": "An array of relationships to iamLdapGroupInventory resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.LdapGroupInventory.Relationship" }, "nullable": true, "readOnly": true }, "Providers": { "description": "An array of relationships to iamLdapProviderInventory resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.LdapProviderInventory.Relationship" }, "nullable": true, "readOnly": true }, "TargetMo": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo.Relationship", "description": "A reference to a moBaseMo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "iam.LdapPolicyInventory.List": { "title": "List of 'iam.LdapPolicyInventory' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.LdapPolicyInventory' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.LdapPolicyInventory' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.LdapPolicyInventory" }, "nullable": true } } } ] }, "iam.LdapProvider.Response": { "description": "The response body of a HTTP GET request for the 'iam.LdapProvider' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.LdapProvider' resources.", "x-one-of-name": "iam.LdapProvider.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.LdapProvider.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.LdapProvider.Relationship": { "description": "A relationship to the 'iam.LdapProvider' resource, or the expanded 'iam.LdapProvider' resource, or the 'null' value.", "x-one-of-name": "iam.LdapProvider.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iam.LdapProvider" } ], "discriminator": { "propertyName": "ClassId" } }, "iam.LdapProvider": { "title": "Iam:Ldap Provider", "description": "### Overview\nThe LDAP Provider object represents a single LDAP server that an endpoint will use for authentication. It is a component of an LdapPolicy.\n#### Purpose\nThe purpose is to define the connection details for one LDAP server. An LdapPolicy can contain a list of LdapProvider objects, creating an ordered list of servers that the endpoint will attempt to contact for authentication.\n#### Key Concepts\n- **Server Endpoint:** - Specifies the IP address or hostname and the port of the LDAP server.\n- **Component of a Policy:** - It does not function independently but is always part of an LdapPolicy.\n- **Ordered List:** - The order of LdapProvider objects within the policy determines the failover sequence for authentication attempts.", "x-allOf-name": "iam.LdapProvider", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.LdapProvider', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.LdapProvider" ], "default": "iam.LdapProvider", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.LdapProvider" ], "default": "iam.LdapProvider", "x-enum-as-string": true }, "Port": { "description": "LDAP Server Port for connection establishment.", "type": "integer", "format": "int64", "default": 389, "minimum": 1, "maximum": 65535, "x-omitempty": true }, "Server": { "description": "LDAP Server Address, such as an IP address or hostname.", "type": "string", "x-omitempty": true }, "Vendor": { "description": "LDAP server vendor type used for authentication.\n* `OpenLDAP` - Open source LDAP server for remote authentication.\n* `MSAD` - Microsoft active directory for remote authentication.", "type": "string", "enum": [ "OpenLDAP", "MSAD" ], "default": "OpenLDAP", "x-omitempty": true }, "LdapPolicy": { "$ref": "#/components/schemas/iam.LdapPolicy.Relationship", "description": "A reference to a iamLdapPolicy resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true } } } ] }, "iam.LdapProvider.List": { "title": "List of 'iam.LdapProvider' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.LdapProvider' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.LdapProvider' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.LdapProvider" }, "nullable": true } } } ] }, "iam.LdapProviderInventory.Response": { "description": "The response body of a HTTP GET request for the 'iam.LdapProviderInventory' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.LdapProviderInventory' resources.", "x-one-of-name": "iam.LdapProviderInventory.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.LdapProviderInventory.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.LdapProviderInventory.Relationship": { "description": "A relationship to the 'iam.LdapProviderInventory' resource, or the expanded 'iam.LdapProviderInventory' resource, or the 'null' value.", "x-one-of-name": "iam.LdapProviderInventory.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iam.LdapProviderInventory" } ], "discriminator": { "propertyName": "ClassId" } }, "iam.LdapProviderInventory": { "title": "Iam:Ldap Provider Inventory", "description": "### Overview\nThe LDAP Provider object represents a single LDAP server that an endpoint will use for authentication. It is a component of an LdapPolicy.\n#### Purpose\nThe purpose is to define the connection details for one LDAP server. An LdapPolicy can contain a list of LdapProvider objects, creating an ordered list of servers that the endpoint will attempt to contact for authentication.\n#### Key Concepts\n- **Server Endpoint:** - Specifies the IP address or hostname and the port of the LDAP server.\n- **Component of a Policy:** - It does not function independently but is always part of an LdapPolicy.\n- **Ordered List:** - The order of LdapProvider objects within the policy determines the failover sequence for authentication attempts.", "x-allOf-name": "iam.LdapProviderInventory", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractInventory" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.LdapProviderInventory', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.LdapProviderInventory" ], "default": "iam.LdapProviderInventory", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.LdapProviderInventory" ], "default": "iam.LdapProviderInventory", "x-enum-as-string": true }, "Port": { "description": "LDAP Server Port for connection establishment.", "type": "integer", "format": "int64", "default": 389, "minimum": 1, "maximum": 65535, "readOnly": true, "x-omitempty": true }, "Server": { "description": "LDAP Server Address, such as an IP address or hostname.", "type": "string", "readOnly": true, "x-omitempty": true }, "Vendor": { "description": "LDAP server vendor type used for authentication.\n* `OpenLDAP` - Open source LDAP server for remote authentication.\n* `MSAD` - Microsoft active directory for remote authentication.", "type": "string", "enum": [ "OpenLDAP", "MSAD" ], "default": "OpenLDAP", "readOnly": true, "x-omitempty": true }, "LdapPolicy": { "$ref": "#/components/schemas/iam.LdapPolicyInventory.Relationship", "description": "A reference to a iamLdapPolicyInventory resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "iam.LdapProviderInventory.List": { "title": "List of 'iam.LdapProviderInventory' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.LdapProviderInventory' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.LdapProviderInventory' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.LdapProviderInventory" }, "nullable": true } } } ] }, "iam.LocalUserPassword.Response": { "description": "The response body of a HTTP GET request for the 'iam.LocalUserPassword' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.LocalUserPassword' resources.", "x-one-of-name": "iam.LocalUserPassword.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.LocalUserPassword.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.LocalUserPassword.Relationship": { "description": "A relationship to the 'iam.LocalUserPassword' resource, or the expanded 'iam.LocalUserPassword' resource, or the 'null' value.", "x-one-of-name": "iam.LocalUserPassword.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iam.LocalUserPassword" } ], "discriminator": { "propertyName": "ClassId" } }, "iam.LocalUserPassword": { "title": "Iam:Local User Password", "description": "LocalUserPassword provides the mechanism for a local user to change their own password within the platform appliance context. This model is applicable only to Intersight Appliance deployments.\n#### Purpose\nIt enforces secure password-change operations for local users while keeping reset flows separate.\n#### Key Concepts\n- **Self-service Change:** Allows users to update their own password.\n- **Policy-aware:** Works alongside password policy configurations.\n- **Scoped to User:** Inherits permissions from the associated user.\n- **Appliance Focus:** Applicable to local authentication scenarios.", "x-allOf-name": "iam.LocalUserPassword", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.LocalUserPassword', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.LocalUserPassword" ], "default": "iam.LocalUserPassword", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.LocalUserPassword" ], "default": "iam.LocalUserPassword", "x-enum-as-string": true }, "CurrentPassword": { "description": "User-entered password to be compared to password for change password function.", "type": "string", "writeOnly": true, "x-omitempty": true }, "InitialPassword": { "description": "Initial password set for the local user for the first time when the local user gets created or when the password gets reset by the Account Administrator.", "type": "string", "writeOnly": true, "x-omitempty": true }, "IsCurrentPasswordSet": { "description": "Indicates whether the value of the 'currentPassword' property has been set.", "type": "boolean", "default": false, "readOnly": true, "x-omitempty": true }, "IsInitialPasswordSet": { "description": "Indicates whether the value of the 'initialPassword' property has been set.", "type": "boolean", "default": false, "readOnly": true, "x-omitempty": true }, "IsNewPasswordSet": { "description": "Indicates whether the value of the 'newPassword' property has been set.", "type": "boolean", "default": false, "readOnly": true, "x-omitempty": true }, "NeedPasswordReset": { "description": "Indicates whether the user should be prompted to reset their password.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "NewPassword": { "description": "New password that the user's password should be changed to.", "type": "string", "writeOnly": true, "x-omitempty": true }, "PasswordExpiresInDays": { "description": "The passwordExpiresInDays attribute indicates the number of days remaining until a user's password expires,\nwith negative values meaning the password has already expired and zero indicating expiration today.\nThis value is dynamically calculated based on the time since the last password change and the maximum\nallowed password age defined by the password policy. No migration code or default value is required\nduring system upgrades because the value is computed in real-time, and initially, the password age\nproperty defaults to zero, ensuring no passwords are mistakenly marked as expired.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "User": { "$ref": "#/components/schemas/iam.User.Relationship", "description": "A reference to a iamUser resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "iam.LocalUserPassword.List": { "title": "List of 'iam.LocalUserPassword' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.LocalUserPassword' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.LocalUserPassword' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.LocalUserPassword" }, "nullable": true } } } ] }, "iam.LocalUserPasswordPolicy.Response": { "description": "The response body of a HTTP GET request for the 'iam.LocalUserPasswordPolicy' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.LocalUserPasswordPolicy' resources.", "x-one-of-name": "iam.LocalUserPasswordPolicy.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.LocalUserPasswordPolicy.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.LocalUserPasswordPolicy": { "title": "Iam:Local User Password Policy", "description": "LocalUserPasswordPolicy defines the password complexity and lockout policy for local users within an account.\n#### Purpose\nIt establishes compliance and security requirements for local user credentials.\n#### Key Concepts\n- **Complexity Rules:** Configures length, character requirements, and reuse constraints.\n- **Lockout Behavior:** Sets thresholds and lock durations for failed logins.\n- **Admin-governed:** Managed by authorized roles in the account.\n- **Consistent Enforcement:** Applies to all local user password operations.", "x-allOf-name": "iam.LocalUserPasswordPolicy", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.LocalUserPasswordPolicy', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.LocalUserPasswordPolicy" ], "default": "iam.LocalUserPasswordPolicy", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.LocalUserPasswordPolicy" ], "default": "iam.LocalUserPasswordPolicy", "x-enum-as-string": true }, "EnableLockOutForAdminUser": { "description": "Determines if the user lock out feature must be enabled for the local admin user.", "type": "boolean", "default": false, "x-omitempty": true }, "FailedLoginTrackerWindow": { "description": "The duration, in seconds, within which consecutive incorrect login attempts are counted. The system locks out the account if the number of incorrect attempts exceeds the maximum allowed value during this window.", "type": "integer", "format": "int64", "default": 1800, "minimum": 300, "maximum": 3600, "x-omitempty": true }, "LockOutTimePeriod": { "description": "The time period, in seconds, during which a user account will remain locked.", "type": "integer", "format": "int64", "default": 900, "minimum": 60, "maximum": 3600, "x-omitempty": true }, "MaxDaysAllowedWithSamePassword": { "description": "Maximum number of days a password can be used before it must be changed. Set to 0 to disable password expiration.", "type": "integer", "format": "int64", "default": 0, "minimum": 0, "maximum": 3650, "x-omitempty": true }, "MaxFailedLoginsAllowed": { "description": "Users will be locked out after exceeding the max consecutive incorrect login attempts allowed within the configured time duration.", "type": "integer", "format": "int64", "default": 5, "minimum": 3, "maximum": 10, "x-omitempty": true }, "MinCharDifference": { "description": "Minimum number of characters different from previous password.", "type": "integer", "format": "int64", "default": 0, "minimum": 0, "maximum": 15, "x-omitempty": true }, "MinDaysBetweenPasswordChange": { "description": "Minimum Days allowed between password change.", "type": "integer", "format": "int64", "default": 0, "minimum": 0, "maximum": 7, "x-omitempty": true }, "MinLengthPassword": { "description": "Minimum length of password.", "type": "integer", "format": "int64", "default": 8, "minimum": 8, "maximum": 127, "x-omitempty": true }, "MinLowerCase": { "description": "Minimum number of required lower case characters.", "type": "integer", "format": "int64", "default": 1, "minimum": 1, "maximum": 64, "x-omitempty": true }, "MinNumeric": { "description": "Minimum number of required numeric characters.", "type": "integer", "format": "int64", "default": 1, "minimum": 1, "maximum": 64, "x-omitempty": true }, "MinSpecialChar": { "description": "Minimum number of required special characters.", "type": "integer", "format": "int64", "default": 0, "minimum": 0, "maximum": 64, "x-omitempty": true }, "MinUpperCase": { "description": "Minimum number of required upper case characters.", "type": "integer", "format": "int64", "default": 1, "minimum": 1, "maximum": 64, "x-omitempty": true }, "NumPreviousPasswordsDisallowed": { "description": "Number of previous passwords disallowed.", "type": "integer", "format": "int64", "default": 0, "minimum": 0, "maximum": 10, "x-omitempty": true }, "Account": { "$ref": "#/components/schemas/iam.Account.Relationship", "description": "A reference to a iamAccount resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "iam.LocalUserPasswordPolicy.List": { "title": "List of 'iam.LocalUserPasswordPolicy' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.LocalUserPasswordPolicy' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.LocalUserPasswordPolicy' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.LocalUserPasswordPolicy" }, "nullable": true } } } ] }, "iam.OAuthToken.Response": { "description": "The response body of a HTTP GET request for the 'iam.OAuthToken' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.OAuthToken' resources.", "x-one-of-name": "iam.OAuthToken.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.OAuthToken.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.OAuthToken.Relationship": { "description": "A relationship to the 'iam.OAuthToken' resource, or the expanded 'iam.OAuthToken' resource, or the 'null' value.", "x-one-of-name": "iam.OAuthToken.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iam.OAuthToken" } ], "discriminator": { "propertyName": "ClassId" } }, "iam.OAuthToken": { "title": "OAuth2 Token", "description": "The meta data for generating OAuth2 token of a user.\nIt is created when user logged in via OAuth2 using Authorization Code grant\nand deleted upon logout, expiration timeout or manual deletion.", "x-allOf-name": "iam.OAuthToken", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.OAuthToken', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.OAuthToken" ], "default": "iam.OAuthToken", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.OAuthToken" ], "default": "iam.OAuthToken", "x-enum-as-string": true }, "AccessExpirationTime": { "description": "Expiration time for the JWT token to which it can be used for api calls.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "ClientId": { "description": "The identifier of the registered application to which the token belongs.", "type": "string", "x-omitempty": true }, "ClientIpAddress": { "description": "The user agent IP address from which the auth token is launched.", "type": "string", "readOnly": true, "x-omitempty": true }, "ClientName": { "description": "The name of the registered application to which the token belongs.", "type": "string", "x-omitempty": true }, "ExpirationTime": { "description": "Expiration time for the JWT token to which it can be refreshed.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "LastLoginClient": { "description": "The client address from which last login is initiated.", "type": "string", "readOnly": true, "x-omitempty": true }, "LastLoginTime": { "description": "The last login time for user.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "TokenId": { "description": "Token identifier. Not the Access Token itself.", "type": "string", "readOnly": true, "x-omitempty": true }, "UserMeta": { "description": "User Device meta information.", "$ref": "#/components/schemas/iam.ClientMeta", "x-omitempty": true }, "AppRegistration": { "$ref": "#/components/schemas/iam.AppRegistration.Relationship", "description": "A reference to a iamAppRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Permission": { "$ref": "#/components/schemas/iam.Permission.Relationship", "description": "A reference to a iamPermission resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "User": { "$ref": "#/components/schemas/iam.User.Relationship", "description": "A reference to a iamUser resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "iam.OAuthToken.List": { "title": "List of 'iam.OAuthToken' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.OAuthToken' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.OAuthToken' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.OAuthToken" }, "nullable": true } } } ] }, "iam.OidcAuthTokenSet": { "title": "Iam:Oidc Auth Token Set", "description": "Holds attributes obtained after OIDC authentication in plain text which are required for CUI admin portal MFE \ninside Intersight for IdP settings and routing rules, session refresh and logout functionality. Used during \naccount creation when encryption is not yet possible, as the encryption token is only available after account \ncreation. These tokens are stored in clear text only for the login session in which the account is being created.", "x-allOf-name": "iam.OidcAuthTokenSet", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" } ] }, "iam.PasswordHistorySetting": { "title": "Iam:Password History Setting", "description": "Password history settings for endpoint users.", "x-allOf-name": "iam.PasswordHistorySetting", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.PasswordHistorySetting', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.PasswordHistorySetting" ], "default": "iam.PasswordHistorySetting", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.PasswordHistorySetting" ], "default": "iam.PasswordHistorySetting", "x-enum-as-string": true }, "HistoryIndex": { "description": "Index of the next passwordHistory collection.", "type": "integer", "format": "int64", "default": 0, "readOnly": true, "x-omitempty": true }, "LastModificationTime": { "description": "Time when the password was last modified.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "PasswordHistory": { "type": "array", "items": { "description": "Password history for the user.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Username": { "description": "User for which this password history is applicable.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "iam.PasswordHistorySettingCollection.Response": { "description": "The response body of a HTTP GET request for the 'iam.PasswordHistorySettingCollection' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.PasswordHistorySettingCollection' resources.", "x-one-of-name": "iam.PasswordHistorySettingCollection.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.PasswordHistorySettingCollection.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.PasswordHistorySettingCollection": { "title": "Iam:Password History Setting Collection", "description": "The PasswordHistorySettingCollection object is a centralized management entity designed to track and enforce password history across the system. It addresses the challenges of maintaining consistent password policies in distributed server environments.\n#### Purpose\nThe primary purpose of this object is to eliminate inconsistencies that occur when password history is managed at the individual server level. By centralizing this data, the system can reliably prevent the reuse of previous passwords, regardless of which policy or server the user is interacting with.\n#### Key Concepts\n- **Centralized Enforcement:** Moves password history logic from individual endpoints to a central collection, ensuring uniform enforcement across the account.\n- **Scalability:** Avoids the performance and storage issues associated with local history tracking on hardware endpoints.\n- **Lifecycle Awareness:** Includes mechanisms to identify \"orphaned\" history records when associated policies or servers are deleted, ensuring data hygiene.\n- **Cross-Object Relationships:** Links password history to accounts, profiles, policies, and physical servers to provide a holistic view of user security.", "x-allOf-name": "iam.PasswordHistorySettingCollection", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.PasswordHistorySettingCollection', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.PasswordHistorySettingCollection" ], "default": "iam.PasswordHistorySettingCollection", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.PasswordHistorySettingCollection" ], "default": "iam.PasswordHistorySettingCollection", "x-enum-as-string": true }, "Orphaned": { "description": "Orphaned indicates whether policy, server or profile changed or deleted related to this object. Such objects would be marked as orphaned for deletion.", "type": "boolean", "default": false, "readOnly": true, "x-omitempty": true }, "PasswordHistoryObjects": { "type": "array", "items": { "description": "Collection of PasswordHistorySetting objects.", "$ref": "#/components/schemas/iam.PasswordHistorySetting", "readOnly": true, "x-omitempty": true }, "nullable": true }, "PasswordHistoryWindow": { "description": "The password history window size (number of previous passwords to remember) that is currently in effect. Used to detect policy changes at deploy time so the stored history can be renormalized if the window has changed.", "type": "integer", "format": "int64", "default": 0, "readOnly": true, "x-omitempty": true }, "Account": { "$ref": "#/components/schemas/iam.Account.Relationship", "description": "A reference to a iamAccount resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Policy": { "$ref": "#/components/schemas/iam.EndPointUserPolicy.Relationship", "description": "A reference to a iamEndPointUserPolicy resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Profile": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractConfigProfile.Relationship", "description": "A reference to a policyAbstractConfigProfile resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Server": { "$ref": "intersight-server-v3-1.0.11-20260807064027971.json#/components/schemas/compute.Physical.Relationship", "description": "A reference to a computePhysical resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "iam.PasswordHistorySettingCollection.List": { "title": "List of 'iam.PasswordHistorySettingCollection' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.PasswordHistorySettingCollection' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.PasswordHistorySettingCollection' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.PasswordHistorySettingCollection" }, "nullable": true } } } ] }, "iam.Permission.Response": { "description": "The response body of a HTTP GET request for the 'iam.Permission' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.Permission' resources.", "x-one-of-name": "iam.Permission.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.Permission.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.Permission.Relationship": { "description": "A relationship to the 'iam.Permission' resource, or the expanded 'iam.Permission' resource, or the 'null' value.", "x-one-of-name": "iam.Permission.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iam.Permission" } ], "discriminator": { "propertyName": "ClassId" } }, "iam.Permission": { "title": "Role", "description": "Permission provides a way to assign roles to a user or user group to perform operations on object hierarchy.", "x-allOf-name": "iam.Permission", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.Permission', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.Permission" ], "default": "iam.Permission", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.Permission" ], "default": "iam.Permission", "x-enum-as-string": true }, "Description": { "description": "The informative description about each permission.", "type": "string", "minLength": 0, "maxLength": 1024, "x-omitempty": true }, "Name": { "description": "The name of the permission which has to be granted to user.", "type": "string", "pattern": "^[a-zA-Z0-9_ .:-]{1,128}$", "minLength": 1, "maxLength": 128, "x-omitempty": true }, "Account": { "$ref": "#/components/schemas/iam.Account.Relationship", "description": "A reference to a iamAccount resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "EndPointRoles": { "description": "An array of relationships to iamEndPointRole resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.EndPointRole.Relationship" }, "nullable": true, "readOnly": true }, "PrivilegeSets": { "description": "An array of relationships to iamPrivilegeSet resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.PrivilegeSet.Relationship" }, "nullable": true }, "ResourceRoles": { "description": "An array of relationships to iamResourceRoles resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.ResourceRoles.Relationship" }, "nullable": true, "x-createOnly": true }, "Roles": { "deprecated": true, "x-sunset": "2027-03-01", "description": "An array of relationships to iamRole resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.Role.Relationship" }, "nullable": true }, "SessionLimits": { "$ref": "#/components/schemas/iam.SessionLimits.Relationship", "description": "A reference to a iamSessionLimits resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "UserGroups": { "description": "An array of relationships to iamUserGroup resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.UserGroup.Relationship" }, "nullable": true }, "Users": { "description": "An array of relationships to iamUser resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.User.Relationship" }, "nullable": true } } } ] }, "iam.Permission.List": { "title": "List of 'iam.Permission' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.Permission' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.Permission' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.Permission" }, "nullable": true } } } ] }, "iam.PermissionReference": { "title": "Iam:Permission Reference", "description": "Users can log in through the base URL (https://intersight.com) or account-specific URLs. When the Intersight user logs in through the base URL, Intersight identifies the accounts and permissions within each account which the user has access to. In case multiple permissions are identified, the user and session objects are created in the onboarding-user account, and the session object is updated with account and permission information. Intersight GUI uses this information to show available accounts and permissions for the user to select. PermissionReference type is used to store permission information of an account.", "x-allOf-name": "iam.PermissionReference", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.PermissionReference', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.PermissionReference" ], "default": "iam.PermissionReference", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.PermissionReference" ], "default": "iam.PermissionReference", "x-enum-as-string": true }, "PermissionIdentifier": { "description": "MOID of the permission which user has access to.", "type": "string", "readOnly": true, "x-omitempty": true }, "PermissionName": { "description": "Name of the permission which user has access to.", "type": "string", "readOnly": true, "x-omitempty": true }, "UserGroupMappings": { "type": "array", "items": { "description": "Moids of the user groups which grant this permission to the user.", "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef", "readOnly": true, "x-omitempty": true }, "nullable": true } } } ] }, "iam.PermissionToRoles": { "title": "Iam:Permission To Roles", "description": "Complex type representing a permission and its associated roles.", "x-allOf-name": "iam.PermissionToRoles", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.PermissionToRoles', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.PermissionToRoles" ], "default": "iam.PermissionToRoles", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.PermissionToRoles" ], "default": "iam.PermissionToRoles", "x-enum-as-string": true }, "Permission": { "description": "Permission Id of the object.", "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef", "readOnly": true, "x-omitempty": true }, "PrivilegeSets": { "type": "array", "items": { "description": "Collection of PrivilegeSets for the Permission.", "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Roles": { "type": "array", "items": { "description": "Collection of Roles for the Permission.", "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef", "readOnly": true, "x-omitempty": true }, "nullable": true } } } ] }, "iam.PrivateKeySpec.Response": { "description": "The response body of a HTTP GET request for the 'iam.PrivateKeySpec' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.PrivateKeySpec' resources.", "x-one-of-name": "iam.PrivateKeySpec.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.PrivateKeySpec.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.PrivateKeySpec.Relationship": { "description": "A relationship to the 'iam.PrivateKeySpec' resource, or the expanded 'iam.PrivateKeySpec' resource, or the 'null' value.", "x-one-of-name": "iam.PrivateKeySpec.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iam.PrivateKeySpec" } ], "discriminator": { "propertyName": "ClassId" } }, "iam.PrivateKeySpec": { "title": "Iam:Private Key Spec", "description": "PrivateKeySpec defines parameters for generating a private key that will be used to sign a certificate signing request (CSR).\n#### Purpose\nIt standardizes the key generation process for certificate workflows.\n#### Key Concepts\n- **CSR Workflow:** Couples key generation with a certificate request.\n- **Algorithm Selection:** Encapsulates key algorithm and parameters.\n- **Scoped Inheritance:** Governed by the associated certificate request.\n- **Security Posture:** Ensures consistent, policy-aligned key creation.", "x-allOf-name": "iam.PrivateKeySpec", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.PrivateKeySpec', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.PrivateKeySpec" ], "default": "iam.PrivateKeySpec", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.PrivateKeySpec" ], "default": "iam.PrivateKeySpec", "x-enum-as-string": true }, "Algorithm": { "description": "Algorithm used to generate the key pair and algorithm-speicifc parameters, such as RSA modulus size.", "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/pkix.KeyGenerationSpec", "x-createOnly": true, "x-omitempty": true }, "CertificateRequest": { "$ref": "#/components/schemas/iam.CertificateRequest.Relationship", "description": "A reference to a iamCertificateRequest resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true } } } ] }, "iam.PrivateKeySpec.List": { "title": "List of 'iam.PrivateKeySpec' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.PrivateKeySpec' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.PrivateKeySpec' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.PrivateKeySpec" }, "nullable": true } } } ] }, "iam.Privilege.Response": { "description": "The response body of a HTTP GET request for the 'iam.Privilege' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.Privilege' resources.", "x-one-of-name": "iam.Privilege.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.Privilege.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.Privilege.Relationship": { "description": "A relationship to the 'iam.Privilege' resource, or the expanded 'iam.Privilege' resource, or the 'null' value.", "x-one-of-name": "iam.Privilege.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iam.Privilege" } ], "discriminator": { "propertyName": "ClassId" } }, "iam.Privilege": { "title": "Iam:Privilege", "description": "Privilege represents an action which can be performed in Intersight such as creating server profile, deleting a user etc.", "x-allOf-name": "iam.Privilege", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.Privilege', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.Privilege" ], "default": "iam.Privilege", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.Privilege" ], "default": "iam.Privilege", "x-enum-as-string": true }, "AttributeNames": { "type": "array", "items": { "description": "The list of attribute names associated with a conditional privilege. When the condition is met, access is granted to update these specific attributes.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Condition": { "description": "The condition expression or criteria that determines when this conditional privilege can grant access to update the specified attribute names.", "type": "string", "readOnly": true, "x-omitempty": true }, "Description": { "description": "Informative description about each privilege.", "type": "string", "readOnly": true, "x-omitempty": true }, "HostnamePrefix": { "description": "The hostname prefix of the resource corresponding to this privilege. For example \\'sentry\\' in https://sentry.intersight.com .", "type": "string", "readOnly": true, "x-omitempty": true }, "IsConditionalPrivilege": { "description": "Flag that indicates whether this privilege is conditional.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "Method": { "description": "The API method on the rest resource corresponding to privilege. For example READ, CREATE, UPDATE etc.", "type": "string", "readOnly": true, "x-omitempty": true }, "Name": { "description": "The name of the privilege reported by microservice.", "type": "string", "readOnly": true, "x-omitempty": true }, "RestPath": { "description": "The REST API path of the resource corresponding to this privilege. For example /v1/iam/Accounts, /v1/iam/Sessions.", "type": "string", "readOnly": true, "x-omitempty": true }, "UrlPrefix": { "description": "The URL path prefix of the resource corresponding to this privilege. For example /devops/kibana, /devops/grafana etc.", "type": "string", "readOnly": true, "x-omitempty": true }, "Account": { "$ref": "#/components/schemas/iam.Account.Relationship", "description": "A reference to a iamAccount resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "System": { "$ref": "#/components/schemas/iam.System.Relationship", "description": "A reference to a iamSystem resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "iam.Privilege.List": { "title": "List of 'iam.Privilege' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.Privilege' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.Privilege' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.Privilege" }, "nullable": true } } } ] }, "iam.PrivilegeSet.Response": { "description": "The response body of a HTTP GET request for the 'iam.PrivilegeSet' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.PrivilegeSet' resources.", "x-one-of-name": "iam.PrivilegeSet.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.PrivilegeSet.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.PrivilegeSet.Relationship": { "description": "A relationship to the 'iam.PrivilegeSet' resource, or the expanded 'iam.PrivilegeSet' resource, or the 'null' value.", "x-one-of-name": "iam.PrivilegeSet.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iam.PrivilegeSet" } ], "discriminator": { "propertyName": "ClassId" } }, "iam.PrivilegeSet": { "title": "Iam:Privilege Set", "description": "A collection of privileges.", "x-allOf-name": "iam.PrivilegeSet", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.PrivilegeSet', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.PrivilegeSet" ], "default": "iam.PrivilegeSet", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.PrivilegeSet" ], "default": "iam.PrivilegeSet", "x-enum-as-string": true }, "AllowFutureUpdates": { "description": "Flag used by UI to keep track of the user selection option for future updates of privilege sets.", "type": "boolean", "default": true, "x-omitempty": true }, "Description": { "description": "Description of the privilege set.", "type": "string", "x-omitempty": true }, "IsPrivilegeNamesUpdated": { "description": "Flag to indicate if the privilege names are updated.", "type": "boolean", "default": false, "x-omitempty": true }, "Name": { "description": "Name of the privilege set.", "type": "string", "pattern": "^[a-zA-Z0-9_ .:,()&/-]{1,128}$", "minLength": 1, "maxLength": 128, "x-omitempty": true }, "PrivilegeNames": { "type": "array", "items": { "description": "Names of the privileges in the privilege set.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "PrivilegeSetType": { "description": "Type of the privilege set.\n* `Internal` - Privilege set is internal to the system.\n* `SystemPackaged` - Privilege set is packaged by the system and user can use it as a reference for custom privilege set creation.\n* `SystemDefined` - Privilege set is defined by the system.\n* `TreeNode` - Privilege set is a tree node in the custom privilege set creation hierarchy.\n* `TreeRoot` - Privilege set is a tree root in the custom privilege set creation hierarchy.\n* `TreeLeaf` - Privilege set is a tree leaf in the custom privilege set creation hierarchy.\n* `UserCreated` - Privilege set is created by the user.", "type": "string", "enum": [ "Internal", "SystemPackaged", "SystemDefined", "TreeNode", "TreeRoot", "TreeLeaf", "UserCreated" ], "default": "Internal", "readOnly": true, "x-omitempty": true }, "Scope": { "description": "The scope of the privilege set.\n* `Generic` - Privilege set can be added to account wide permission or organization permissions.\n* `Account` - Privilege set can be added to account wide permission only.", "type": "string", "enum": [ "Generic", "Account" ], "default": "Generic", "readOnly": true, "x-omitempty": true }, "Uuid": { "description": "UUID of the privilege set.", "type": "string", "pattern": "^[a-zA-Z0-9_ .:,-]{0,128}$", "minLength": 0, "maxLength": 128, "readOnly": true, "x-omitempty": true }, "Account": { "$ref": "#/components/schemas/iam.Account.Relationship", "description": "A reference to a iamAccount resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "AssociatedPrivilegeSets": { "description": "An array of relationships to iamPrivilegeSet resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.PrivilegeSet.Relationship" }, "nullable": true }, "Privileges": { "description": "An array of relationships to iamPrivilege resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.Privilege.Relationship" }, "nullable": true, "readOnly": true }, "System": { "$ref": "#/components/schemas/iam.System.Relationship", "description": "A reference to a iamSystem resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "iam.PrivilegeSet.List": { "title": "List of 'iam.PrivilegeSet' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.PrivilegeSet' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.PrivilegeSet' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.PrivilegeSet" }, "nullable": true } } } ] }, "iam.PrivilegeSetMetaInfo.Response": { "description": "The response body of a HTTP GET request for the 'iam.PrivilegeSetMetaInfo' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.PrivilegeSetMetaInfo' resources.", "x-one-of-name": "iam.PrivilegeSetMetaInfo.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.PrivilegeSetMetaInfo.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.PrivilegeSetMetaInfo": { "title": "Iam:Privilege Set Meta Info", "description": "PrivilegeSetMetaInfo centralizes metadata to validate, relate, and maintain privilege sets. It captures the context needed to evaluate dependencies and associations, ensuring consistency with access policies.\n#### Purpose\nPrivilegeSetMetaInfo validates privilege sets before persistence by tracking upstream and downstream relationships. It identifies missing dependencies and surfaces insights to ensure secure, confident design.\n#### Key Concepts\n- **Dependency Intelligence:** Continuously analyzes privilege-set relationships to reveal required, computed, and missing dependencies, helping teams remediate gaps before deployment.\n- **Association Awareness:** Maintains links between related privilege sets, providing a holistic view of how access models interact within broader governance frameworks.\n- **Validation-First Workflow:** Operates as a non-persistent validation layer, allowing privilege configurations to be assessed, iterated, and approved before becoming part of the active system.\n- **Access Governance Alignment:** Integrates with defined privilege sets and management roles to ensure only authorized stakeholders can inspect or adjust metadata, supporting least-privilege best practices.", "x-allOf-name": "iam.PrivilegeSetMetaInfo", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.PrivilegeSetMetaInfo', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.PrivilegeSetMetaInfo" ], "default": "iam.PrivilegeSetMetaInfo", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.PrivilegeSetMetaInfo" ], "default": "iam.PrivilegeSetMetaInfo", "x-enum-as-string": true }, "AllDependencyInfo": { "description": "All dependency information of the privilege set.", "nullable": true, "readOnly": true, "x-omitempty": true }, "AssociatedPrivilegeSetNames": { "type": "array", "items": { "description": "The names of the privilege sets associated with this metadata.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "DownstreamDependencies": { "type": "array", "items": { "description": "Downstream dependencies of the privilege set.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "MissingDependencyInfo": { "description": "Missing dependency information of the privilege set.", "nullable": true, "readOnly": true, "x-omitempty": true }, "Name": { "description": "Name of the privilege set.", "type": "string", "readOnly": true, "x-omitempty": true }, "UpstreamDependencies": { "type": "array", "items": { "description": "Upstream dependencies of the privilege set.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Uuid": { "description": "UUID of the privilege set.", "type": "string", "readOnly": true, "x-omitempty": true }, "AssociatedPrivilegeSets": { "description": "An array of relationships to iamPrivilegeSet resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.PrivilegeSet.Relationship" }, "nullable": true }, "MissingPrivilegeSets": { "description": "An array of relationships to iamPrivilegeSet resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.PrivilegeSet.Relationship" }, "nullable": true, "readOnly": true } } } ] }, "iam.PrivilegeSetMetaInfo.List": { "title": "List of 'iam.PrivilegeSetMetaInfo' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.PrivilegeSetMetaInfo' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.PrivilegeSetMetaInfo' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.PrivilegeSetMetaInfo" }, "nullable": true } } } ] }, "iam.Qualifier.Response": { "description": "The response body of a HTTP GET request for the 'iam.Qualifier' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.Qualifier' resources.", "x-one-of-name": "iam.Qualifier.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.Qualifier.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.Qualifier": { "title": "Iam:Qualifier", "description": "The qualifier defines how a user qualifies to be part of a user group.", "x-allOf-name": "iam.Qualifier", "allOf": [ { "$ref": "#/components/schemas/iam.AbstractQualifier" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.Qualifier', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.Qualifier" ], "default": "iam.Qualifier", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.Qualifier" ], "default": "iam.Qualifier", "x-enum-as-string": true }, "Name": { "description": "The name of the SAML attribute used to qualify a user to user group. By default this is memberOf attribute in SAML assertion.", "type": "string", "readOnly": true, "x-omitempty": true }, "Value": { "type": "array", "items": { "description": "The value of the SAML attribute.", "type": "string", "x-omitempty": true }, "nullable": true } } } ] }, "iam.Qualifier.List": { "title": "List of 'iam.Qualifier' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.Qualifier' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.Qualifier' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.Qualifier" }, "nullable": true } } } ] }, "iam.ResourceLimits.Response": { "description": "The response body of a HTTP GET request for the 'iam.ResourceLimits' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.ResourceLimits' resources.", "x-one-of-name": "iam.ResourceLimits.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.ResourceLimits.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.ResourceLimits.Relationship": { "description": "A relationship to the 'iam.ResourceLimits' resource, or the expanded 'iam.ResourceLimits' resource, or the 'null' value.", "x-one-of-name": "iam.ResourceLimits.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iam.ResourceLimits" } ], "discriminator": { "propertyName": "ClassId" } }, "iam.ResourceLimits": { "title": "Iam:Resource Limits", "description": "ResourceLimits establishes account-level limits and policies for identity-related resources and credentials.\n#### Purpose\nIt ensures controlled growth and predictable operational parameters for users and machine credentials.\n#### Key Concepts\n- **User Caps:** Governs the maximum number of users per account.\n- **Credential Lifecycles:** Defines expiration policies for API keys and app registrations.\n- **Exceptions Policy:** Controls whether non-expiring credentials are allowed.\n- **Broad Readability:** Exposed to multiple roles for visibility and governance.", "x-allOf-name": "iam.ResourceLimits", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.ResourceLimits', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.ResourceLimits" ], "default": "iam.ResourceLimits", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.ResourceLimits" ], "default": "iam.ResourceLimits", "x-enum-as-string": true }, "AllowApiKeysWithoutExpiry": { "description": "Boolean value used to decide whether API keys that never expire are allowed for the account. This allows creation of API keys which are perpetual which can used for specific applications where rotation of API keys are not feasible.", "type": "boolean", "default": false, "x-omitempty": true }, "AllowAppRegistrationsWithoutExpiry": { "description": "Boolean value used to decide whether App Registration that never expire are allowed for the account.", "type": "boolean", "default": false, "x-omitempty": true }, "MaxApiKeyExpiry": { "description": "The maximum expiration period (in seconds) allowed for API keys. The default value is 180 days or 15552000 seconds. It is shown to user in days for readability.", "type": "integer", "format": "int64", "default": 15552000, "minimum": 0, "maximum": 31104000, "x-omitempty": true }, "MaxAppRegistrationExpiry": { "description": "The maximum expiration period (in seconds) allowed for App Registration. The default value is 180 days or 15552000 seconds. It is shown to user in days for readability.", "type": "integer", "format": "int64", "default": 15552000, "minimum": 0, "maximum": 31104000, "x-omitempty": true }, "PerAccountUserLimit": { "description": "The maximum number of users allowed in an account. The default value is 200.", "type": "integer", "format": "int64", "minimum": 1, "maximum": 200, "readOnly": true, "x-omitempty": true }, "Account": { "$ref": "#/components/schemas/iam.Account.Relationship", "description": "A reference to a iamAccount resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "iam.ResourceLimits.List": { "title": "List of 'iam.ResourceLimits' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.ResourceLimits' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.ResourceLimits' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.ResourceLimits" }, "nullable": true } } } ] }, "iam.ResourcePermission.Response": { "description": "The response body of a HTTP GET request for the 'iam.ResourcePermission' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.ResourcePermission' resources.", "x-one-of-name": "iam.ResourcePermission.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.ResourcePermission.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.ResourcePermission.Relationship": { "description": "A relationship to the 'iam.ResourcePermission' resource, or the expanded 'iam.ResourcePermission' resource, or the 'null' value.", "x-one-of-name": "iam.ResourcePermission.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iam.ResourcePermission" } ], "discriminator": { "propertyName": "ClassId" } }, "iam.ResourcePermission": { "title": "Iam:Resource Permission", "description": "ResourcePermission represents the permissions defined on a resource like organization.", "x-allOf-name": "iam.ResourcePermission", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.ResourcePermission', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.ResourcePermission" ], "default": "iam.ResourcePermission", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.ResourcePermission" ], "default": "iam.ResourcePermission", "x-enum-as-string": true }, "PermissionRoles": { "type": "array", "items": { "description": "Permissions which are associated with the organization and their role mapping.", "$ref": "#/components/schemas/iam.PermissionToRoles", "readOnly": true, "x-omitempty": true }, "nullable": true }, "TargetApp": { "description": "Name of the service owning the resource.", "type": "string", "readOnly": true, "x-omitempty": true }, "Holder": { "$ref": "#/components/schemas/iam.SecurityHolder.Relationship", "description": "A reference to a iamSecurityHolder resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Resource": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo.Relationship", "description": "A reference to a moBaseMo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "iam.ResourcePermission.List": { "title": "List of 'iam.ResourcePermission' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.ResourcePermission' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.ResourcePermission' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.ResourcePermission" }, "nullable": true } } } ] }, "iam.ResourceRole": { "title": "Iam:Resource Role", "description": "ResourceRoles provides a way to specify the roles associated with a resource like organization.", "x-allOf-name": "iam.ResourceRole", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" } ] }, "iam.ResourceRoles.Response": { "description": "The response body of a HTTP GET request for the 'iam.ResourceRoles' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.ResourceRoles' resources.", "x-one-of-name": "iam.ResourceRoles.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.ResourceRoles.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.ResourceRoles.Relationship": { "description": "A relationship to the 'iam.ResourceRoles' resource, or the expanded 'iam.ResourceRoles' resource, or the 'null' value.", "x-one-of-name": "iam.ResourceRoles.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iam.ResourceRoles" } ], "discriminator": { "propertyName": "ClassId" } }, "iam.ResourceRoles": { "title": "Iam:Resource Roles", "description": "ResourceRoles maps roles to a specific resource (e.g., an organization) within a permission, shaping the effective access model.\n#### Purpose\nIt provides fine-grained control over which roles apply to which resources for a given permission.\n#### Key Concepts\n- **Resource-scoped Roles:** Tailors access at the resource boundary.\n- **Role Composition:** Works with roles, privilege sets, and endpoint roles.\n- **Permission-centric:** Operates within a permission\u2019s assignment context.\n- **Flexible Governance:** Enables nuanced, resource-level authorization design.", "x-allOf-name": "iam.ResourceRoles", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.ResourceRoles', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.ResourceRoles" ], "default": "iam.ResourceRoles", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.ResourceRoles" ], "default": "iam.ResourceRoles", "x-enum-as-string": true }, "EndPointRoles": { "description": "An array of relationships to iamEndPointRole resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.EndPointRole.Relationship" }, "nullable": true, "readOnly": true }, "Permission": { "$ref": "#/components/schemas/iam.Permission.Relationship", "description": "A reference to a iamPermission resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true }, "PrivilegeSets": { "description": "An array of relationships to iamPrivilegeSet resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.PrivilegeSet.Relationship" }, "nullable": true }, "Resource": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo.Relationship", "description": "A reference to a moBaseMo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true }, "Roles": { "deprecated": true, "x-sunset": "2027-03-01", "description": "An array of relationships to iamRole resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.Role.Relationship" }, "nullable": true } } } ] }, "iam.ResourceRoles.List": { "title": "List of 'iam.ResourceRoles' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.ResourceRoles' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.ResourceRoles' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.ResourceRoles" }, "nullable": true } } } ] }, "iam.Role.Response": { "description": "The response body of a HTTP GET request for the 'iam.Role' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.Role' resources.", "x-one-of-name": "iam.Role.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.Role.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.Role.Relationship": { "description": "A relationship to the 'iam.Role' resource, or the expanded 'iam.Role' resource, or the 'null' value.", "x-one-of-name": "iam.Role.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iam.Role" } ], "discriminator": { "propertyName": "ClassId" } }, "iam.Role": { "title": "Iam:Role", "description": "A role is a collection of privilege sets that are assigned to a user using a permission object.", "x-allOf-name": "iam.Role", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.Role', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.Role" ], "default": "iam.Role", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.Role" ], "default": "iam.Role", "x-enum-as-string": true }, "Description": { "description": "Informative description about each role.", "type": "string", "readOnly": true, "x-omitempty": true }, "Name": { "description": "The name of the role which has to be granted to user.", "type": "string", "pattern": "^[a-zA-Z0-9_ .:-]{1,64}$", "minLength": 1, "maxLength": 64, "x-createOnly": true, "x-omitempty": true }, "PrivilegeNames": { "type": "array", "items": { "description": "Names of the privileges in the role.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Account": { "$ref": "#/components/schemas/iam.Account.Relationship", "description": "A reference to a iamAccount resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "PrivilegeSets": { "description": "An array of relationships to iamPrivilegeSet resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.PrivilegeSet.Relationship" }, "nullable": true, "readOnly": true }, "System": { "$ref": "#/components/schemas/iam.System.Relationship", "description": "A reference to a iamSystem resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "iam.Role.List": { "title": "List of 'iam.Role' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.Role' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.Role' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.Role" }, "nullable": true } } } ] }, "iam.Rule": { "title": "Iam:Rule", "description": "Rule stores the information about the IP address. This information is used during the IP address\nvalidation of the incoming request.", "x-allOf-name": "iam.Rule", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.Rule', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.Rule" ], "default": "iam.Rule", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.Rule" ], "default": "iam.Rule", "x-enum-as-string": true }, "IpV6": { "description": "The flag represents if IP addresses in the rule is IPv4 or IPv6.", "type": "boolean", "x-omitempty": true }, "RuleType": { "description": "The type of the IP address. Currently three types are supported, ie IP, CIDR range and IP range.\n* `Ip` - The IP address rule type is IP.\n* `Cidr` - The IP address rule type is CIDR range.\n* `IpRange` - The IP address rule type is IP range.", "type": "string", "enum": [ "Ip", "Cidr", "IpRange" ], "default": "Ip", "x-omitempty": true }, "RuleValue": { "type": "array", "items": { "description": "The rule value stores the IP address/es.", "type": "string", "x-omitempty": true }, "nullable": true } } } ] }, "iam.SamlSpConnection": { "title": "Iam:Saml Sp Connection", "description": "SamlSpConnection stores the metadata elements.", "x-allOf-name": "iam.SamlSpConnection", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.SamlSpConnection', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.SamlSpConnection" ], "default": "iam.SamlSpConnection", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.SamlSpConnection" ], "default": "iam.SamlSpConnection", "x-enum-as-string": true }, "IdentityProviderSloBinding": { "description": "SingleLogout Services binding in IdP Metadata.", "type": "string", "x-omitempty": true }, "IdentityProviderSloUrl": { "description": "SingleLogOut Services location in IdP Metadata.", "type": "string", "x-omitempty": true }, "IdentityProviderSsoBinding": { "description": "SingleSignOn Services binding in IdP Metadata.", "type": "string", "x-omitempty": true }, "IdentityProviderSsoUrl": { "description": "SingleSignOn Services location in IdP Metadata.", "type": "string", "x-omitempty": true }, "IdpCertificateStore": { "description": "Decoded Certificate from IdP Metatdata.", "nullable": true, "x-omitempty": true }, "SignAuthnRequests": { "description": "WantAuthnRequestsSigned from IdP Metadata.", "type": "boolean", "x-omitempty": true } } } ] }, "iam.SecurityContext": { "title": "Iam:Security Context", "description": "Complex type representing the access related properties of the requesting entity, required for authorization. Entity can be NB API user, a device, another micro service or a 3rd party client requesting access to Intersight's APIs.", "x-allOf-name": "iam.SecurityContext", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" } ] }, "iam.SecurityHolder.Response": { "description": "The response body of a HTTP GET request for the 'iam.SecurityHolder' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.SecurityHolder' resources.", "x-one-of-name": "iam.SecurityHolder.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.SecurityHolder.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.SecurityHolder.Relationship": { "description": "A relationship to the 'iam.SecurityHolder' resource, or the expanded 'iam.SecurityHolder' resource, or the 'null' value.", "x-one-of-name": "iam.SecurityHolder.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iam.SecurityHolder" } ], "discriminator": { "propertyName": "ClassId" } }, "iam.SecurityHolder": { "title": "Iam:Security Holder", "description": "SecurityHolder aggregates account-wide and organization-scoped permissions, serving as the nexus for effective authorization state across the accounts resource hierarchy.\n#### Purpose\nSecurityHolder centralizes derived permissions and related controls like IP access management for consistent policy enforcement.\n#### Key Concepts\n- **Aggregated Permissions:** Collects effective permissions per resource (organization).\n- **Policy Container:** Anchors resource-permission mappings for authorization checks.\n- **Access Governance:** Hosts IP-based access management settings for the account.\n- **Account Integration:** Bound to the accounts overall security structure.", "x-allOf-name": "iam.SecurityHolder", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.SecurityHolder', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.SecurityHolder" ], "default": "iam.SecurityHolder", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.SecurityHolder" ], "default": "iam.SecurityHolder", "x-enum-as-string": true }, "Account": { "$ref": "#/components/schemas/iam.Account.Relationship", "description": "A reference to a iamAccount resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "IpRulesConfiguration": { "$ref": "#/components/schemas/iam.IpAccessManagement.Relationship", "description": "A reference to a iamIpAccessManagement resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "ResourcePermissions": { "description": "An array of relationships to iamResourcePermission resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.ResourcePermission.Relationship" }, "nullable": true, "readOnly": true } } } ] }, "iam.SecurityHolder.List": { "title": "List of 'iam.SecurityHolder' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.SecurityHolder' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.SecurityHolder' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.SecurityHolder" }, "nullable": true } } } ] }, "iam.ServiceProvider.Response": { "description": "The response body of a HTTP GET request for the 'iam.ServiceProvider' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.ServiceProvider' resources.", "x-one-of-name": "iam.ServiceProvider.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.ServiceProvider.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.ServiceProvider.Relationship": { "description": "A relationship to the 'iam.ServiceProvider' resource, or the expanded 'iam.ServiceProvider' resource, or the 'null' value.", "x-one-of-name": "iam.ServiceProvider.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iam.ServiceProvider" } ], "discriminator": { "propertyName": "ClassId" } }, "iam.ServiceProvider": { "title": "Iam:Service Provider", "description": "ServiceProvider encapsulates the platforms SAML Service Provider (SP) identity and metadata, used to integrate with external IdPs.\n#### Purpose\nIt provides SP metadata for administrators to configure their IdPs to trust and federate with the platform.\n#### Key Concepts\n- **SP Identity:** Exposes canonical entity identifiers and metadata.\n- **Integrator-facing:** Consumed by admins setting up external SSO.\n- **Read-only:** Ensures the consistency of official SP materials.\n- **Trust Foundation:** Essential for secure federation with IdPs.", "x-allOf-name": "iam.ServiceProvider", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.ServiceProvider', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.ServiceProvider" ], "default": "iam.ServiceProvider", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.ServiceProvider" ], "default": "iam.ServiceProvider", "x-enum-as-string": true }, "EntityId": { "description": "Entity ID of the Intersight Service Provider. In SAML, the entity ID uniquely identifies the IdP/Service Provider.", "type": "string", "readOnly": true, "x-omitempty": true }, "Metadata": { "description": "Metadata of the Intersight Service Provider. User downloads the Intersight Service Provider metadata and integrates it with their IdP for authentication.", "type": "string", "readOnly": true, "x-omitempty": true }, "Name": { "description": "Name of the Intersight Service Provider.", "type": "string", "readOnly": true, "x-omitempty": true }, "System": { "$ref": "#/components/schemas/iam.System.Relationship", "description": "A reference to a iamSystem resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." } } } ] }, "iam.ServiceProvider.List": { "title": "List of 'iam.ServiceProvider' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.ServiceProvider' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.ServiceProvider' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.ServiceProvider" }, "nullable": true } } } ] }, "iam.Session.Response": { "description": "The response body of a HTTP GET request for the 'iam.Session' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.Session' resources.", "x-one-of-name": "iam.Session.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.Session.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.Session.Relationship": { "description": "A relationship to the 'iam.Session' resource, or the expanded 'iam.Session' resource, or the 'null' value.", "x-one-of-name": "iam.Session.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iam.Session" } ], "discriminator": { "propertyName": "ClassId" } }, "iam.Session": { "title": "Iam:Session", "description": "The web session of a user. After a user logs into Intersight, a session object is created. Session object is deleted upon logout, idle timeout, expiry timeout, or manual deletion.", "x-allOf-name": "iam.Session", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/session.AbstractSession" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.Session', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.Session" ], "default": "iam.Session", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.Session" ], "default": "iam.Session", "x-enum-as-string": true }, "AccountPermissions": { "type": "array", "items": { "description": "The accounts and the permissions within each account which a user can select after authentication. After authentication if user has access to multiple permissions, then user and session object are created in onboarding user account and asked to select one of these permissions.", "$ref": "#/components/schemas/iam.AccountPermissions", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Expiration": { "description": "Expiration time for the session.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "FailedLogins": { "description": "Failed logins since last login for admin user.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "IdleTimeExpiration": { "description": "Idle time expiration for the session.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "LastLoginClient": { "description": "The client address from which last login is initiated.", "type": "string", "readOnly": true, "x-omitempty": true }, "LastLoginTime": { "description": "The last login time for user.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "LoginType": { "description": "The type of login that created this session. Indicates whether the session was created through standard web login or JWT token exchange.\n* `weblogin` - Session created through standard web login process.\n* `tokenexchange` - Session created through JWT token exchange process.", "type": "string", "enum": [ "weblogin", "tokenexchange" ], "default": "weblogin", "readOnly": true, "x-omitempty": true }, "Scope": { "description": "Scope holds a collection of account Id, permission Id to which the current session is scoped to.", "$ref": "#/components/schemas/iam.SwitchScopePermissions", "readOnly": true, "x-omitempty": true }, "SessionId": { "description": "Session token shared with the user agent which is used to identify the user session when API requests are received to perform authorization.", "type": "string", "x-omitempty": true }, "Permission": { "$ref": "#/components/schemas/iam.Permission.Relationship", "description": "A reference to a iamPermission resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "User": { "$ref": "#/components/schemas/iam.User.Relationship", "description": "A reference to a iamUser resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "iam.Session.List": { "title": "List of 'iam.Session' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.Session' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.Session' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.Session" }, "nullable": true } } } ] }, "iam.SessionLimits.Response": { "description": "The response body of a HTTP GET request for the 'iam.SessionLimits' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.SessionLimits' resources.", "x-one-of-name": "iam.SessionLimits.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.SessionLimits.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.SessionLimits.Relationship": { "description": "A relationship to the 'iam.SessionLimits' resource, or the expanded 'iam.SessionLimits' resource, or the 'null' value.", "x-one-of-name": "iam.SessionLimits.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iam.SessionLimits" } ], "discriminator": { "propertyName": "ClassId" } }, "iam.SessionLimits": { "title": "Iam:Session Limits", "description": "The session related configuration limits.", "x-allOf-name": "iam.SessionLimits", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.SessionLimits', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.SessionLimits" ], "default": "iam.SessionLimits", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.SessionLimits" ], "default": "iam.SessionLimits", "x-enum-as-string": true }, "IdleTimeOut": { "description": "The idle timeout interval for the web session in seconds. When a session is not refreshed for this duration, the session is marked as idle and removed. The minimum value is 300 seconds and the maximum value is 18000 seconds (5 hours). The system default value is 1800 seconds.", "type": "integer", "format": "int64", "default": 1800, "minimum": 300, "maximum": 18000, "x-omitempty": true }, "MaximumLimit": { "description": "The maximum number of sessions allowed in an account or permission. The default value is 128.", "type": "integer", "format": "int64", "default": 128, "minimum": 1, "maximum": 128, "x-omitempty": true }, "PerUserLimit": { "description": "The maximum number of sessions allowed per user. Default value is 32.", "type": "integer", "format": "int64", "default": 32, "minimum": 2, "maximum": 32, "x-omitempty": true }, "SessionTimeOut": { "description": "The session expiry duration in seconds. The minimum value is 350 seconds and the maximum value is 31536000 seconds (1 year). The system default value is 57600 seconds.", "type": "integer", "format": "int64", "default": 57600, "minimum": 300, "maximum": 31536000, "x-omitempty": true }, "Account": { "$ref": "#/components/schemas/iam.Account.Relationship", "description": "A reference to a iamAccount resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Permission": { "$ref": "#/components/schemas/iam.Permission.Relationship", "description": "A reference to a iamPermission resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." } } } ] }, "iam.SessionLimits.List": { "title": "List of 'iam.SessionLimits' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.SessionLimits' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.SessionLimits' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.SessionLimits" }, "nullable": true } } } ] }, "iam.SharingRule.Response": { "description": "The response body of a HTTP GET request for the 'iam.SharingRule' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.SharingRule' resources.", "x-one-of-name": "iam.SharingRule.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.SharingRule.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.SharingRule.Relationship": { "description": "A relationship to the 'iam.SharingRule' resource, or the expanded 'iam.SharingRule' resource, or the 'null' value.", "x-one-of-name": "iam.SharingRule.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iam.SharingRule" } ], "discriminator": { "propertyName": "ClassId" } }, "iam.SharingRule": { "title": "Iam:Sharing Rule", "description": "SharingRule is a rule which signifies a Source Resource is shared with a Destination Resource. Source, Destination can be resources like Organization which are supported in role configuration. The objects created in Source can be referenced by the objects of Destination.", "x-allOf-name": "iam.SharingRule", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.SharingRule', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.SharingRule" ], "default": "iam.SharingRule", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.SharingRule" ], "default": "iam.SharingRule", "x-enum-as-string": true }, "Account": { "$ref": "#/components/schemas/iam.Account.Relationship", "description": "A reference to a iamAccount resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "SharedResource": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo.Relationship", "description": "A reference to a moBaseMo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true }, "SharedWithResource": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo.Relationship", "description": "A reference to a moBaseMo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true } } } ] }, "iam.SharingRule.List": { "title": "List of 'iam.SharingRule' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.SharingRule' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.SharingRule' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.SharingRule" }, "nullable": true } } } ] }, "iam.SsoSessionAttributes": { "title": "Iam:Sso Session Attributes", "description": "Session attributes required to maintain states of SP and IdP.", "x-allOf-name": "iam.SsoSessionAttributes", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.SsoSessionAttributes', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.SsoSessionAttributes" ], "default": "iam.SsoSessionAttributes", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.SsoSessionAttributes" ], "default": "iam.SsoSessionAttributes", "x-enum-as-string": true }, "AllowSwitchRoleOrAccount": { "description": "Captures if the user is allowed to switch roles or accounts after login and is used by UI to show/hide Switch Role Or Account option. It is set to true when Intersight identifies that the user has multiple roles or accounts during login based on user attributes and Intersight account IAM configuration. For IdP initiated SSO logins, this field is always set to false. Any changes to user roles or accounts after a session is created will not change this field. If switch role/account option is selected, user is re-authenticated with IdP and user roles and accounts are identified and AllowSwitchRoleOrAccount property is updated accordingly.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "IdpSessionExpiration": { "description": "SAML SessionNotOnOrAfter attribute sent by IdP in the assertion. IdP uses this to control for how long SP session maybe. SP does not issue SLO if the session is not valid.", "type": "string", "readOnly": true, "x-omitempty": true }, "IdpSessionIndex": { "description": "SAML SessionIndex attribute sent by IdP in the assertion. This has to be sent back to IdP in LogoutRequest.", "type": "string", "readOnly": true, "x-omitempty": true }, "IsIdpInitiatedSso": { "description": "Sign-in is SP-Intitiated or IdP-Intitiated.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "IsPartialAccountsListed": { "description": "Select Account Page shows partial list of accounts when processing data from some regions fails.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "SubjectName": { "description": "SAML Subject NameID attribute sent by IdP in the assertion. This has to be sent back to IdP in LogoutRequest.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "iam.SwitchAccountPermission": { "title": "Iam:Switch Account Permission", "description": "SwitchScope parameters related to the Account to/from which user switched.", "x-allOf-name": "iam.SwitchAccountPermission", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.SwitchAccountPermission', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.SwitchAccountPermission" ], "default": "iam.SwitchAccountPermission", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.SwitchAccountPermission" ], "default": "iam.SwitchAccountPermission", "x-enum-as-string": true }, "AccountId": { "description": "Moid of the Account to/from which user switched the scope.", "type": "string", "readOnly": true, "x-omitempty": true }, "PermissionId": { "description": "Moid of the Permission for the Account to/from which user switched the scope.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "iam.SwitchScopePermissions": { "title": "Iam:Switch Scope Permissions", "description": "SwitchScope parameters related to the Account to which user switched to.", "x-allOf-name": "iam.SwitchScopePermissions", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.SwitchScopePermissions', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.SwitchScopePermissions" ], "default": "iam.SwitchScopePermissions", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.SwitchScopePermissions" ], "default": "iam.SwitchScopePermissions", "x-enum-as-string": true }, "AccountAccessControlId": { "description": "Moid of the AccountAccessControl through which the access is given to switch scope.", "type": "string", "readOnly": true, "x-omitempty": true }, "RequestIdentifier": { "description": "Stores the identifier of the issue for which user is trying to switch scope to another account.", "type": "string", "readOnly": true, "x-omitempty": true }, "SwitchedFromAccount": { "description": "Permission for the Account from which user switched the scope.", "$ref": "#/components/schemas/iam.SwitchAccountPermission", "readOnly": true, "x-omitempty": true }, "SwitchedToAccounts": { "type": "array", "items": { "description": "Collection of Accounts to which user switched the scope.", "$ref": "#/components/schemas/iam.SwitchAccountPermission", "readOnly": true, "x-omitempty": true }, "nullable": true } } } ] }, "iam.System.Response": { "description": "The response body of a HTTP GET request for the 'iam.System' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.System' resources.", "x-one-of-name": "iam.System.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.System.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.System.Relationship": { "description": "A relationship to the 'iam.System' resource, or the expanded 'iam.System' resource, or the 'null' value.", "x-one-of-name": "iam.System.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iam.System" } ], "discriminator": { "propertyName": "ClassId" } }, "iam.System": { "title": "Iam:System", "description": "The System object is the global root within the platform, serving as a container for objects that are shared across all accounts. It centralizes platform-wide security constructs, such as privileges, privilege sets, and roles, as well as the default identity provider and service provider configuration.\n#### Purpose\nSystem provides a consistent, read-only global context from which account-scoped security and access models are derived and referenced.\n#### Key Concepts\n- **Global Scope:** Hosts objects that are common and reusable across all accounts.\n- **Security Model Anchor:** Aggregates privilege sets, privileges, and roles available platform-wide.\n- **Identity Foundation:** Holds the default identity provider and service provider definitions.\n- **Read-only Access:** Ensures integrity of shared security constructs.", "x-allOf-name": "iam.System", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.System', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.System" ], "default": "iam.System", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.System" ], "default": "iam.System", "x-enum-as-string": true }, "EndPointPrivileges": { "description": "An array of relationships to iamEndPointPrivilege resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.EndPointPrivilege.Relationship" }, "nullable": true, "readOnly": true }, "EndPointRoles": { "description": "An array of relationships to iamEndPointRole resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.EndPointRole.Relationship" }, "nullable": true, "readOnly": true }, "Idp": { "$ref": "#/components/schemas/iam.Idp.Relationship", "description": "A reference to a iamIdp resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "PrivilegeSets": { "description": "An array of relationships to iamPrivilegeSet resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.PrivilegeSet.Relationship" }, "nullable": true, "readOnly": true }, "Privileges": { "description": "An array of relationships to iamPrivilege resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.Privilege.Relationship" }, "nullable": true, "readOnly": true }, "Roles": { "description": "An array of relationships to iamRole resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.Role.Relationship" }, "nullable": true, "readOnly": true }, "ServiceProvider": { "$ref": "#/components/schemas/iam.ServiceProvider.Relationship", "description": "A reference to a iamServiceProvider resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." } } } ] }, "iam.System.List": { "title": "List of 'iam.System' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.System' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.System' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.System" }, "nullable": true } } } ] }, "iam.TenantLinking": { "title": "Iam:Tenant Linking", "description": "Contains tenant linking information for CUI and CCC integration.", "x-allOf-name": "iam.TenantLinking", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.TenantLinking', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.TenantLinking" ], "default": "iam.TenantLinking", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.TenantLinking" ], "default": "iam.TenantLinking", "x-enum-as-string": true }, "Product": { "description": "The product name for the tenant linking (e.g., CUI, CCC).", "type": "string", "x-omitempty": true }, "TenantId": { "description": "The tenant ID for the linked product.", "type": "string", "x-omitempty": true } } } ] }, "iam.TestIdpConfiguration.Response": { "description": "The response body of a HTTP GET request for the 'iam.TestIdpConfiguration' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.TestIdpConfiguration' resources.", "x-one-of-name": "iam.TestIdpConfiguration.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.TestIdpConfiguration.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.TestIdpConfiguration.Relationship": { "description": "A relationship to the 'iam.TestIdpConfiguration' resource, or the expanded 'iam.TestIdpConfiguration' resource, or the 'null' value.", "x-one-of-name": "iam.TestIdpConfiguration.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iam.TestIdpConfiguration" } ], "discriminator": { "propertyName": "ClassId" } }, "iam.TestIdpConfiguration": { "title": "Iam:Test Idp Configuration", "description": "TestIdpConfiguration supports validating an IdP setup by performing a controlled authentication, currently supported only for testing LDAP configurations. test and capturing outcomes.\n#### Purpose\nIt helps administrators verify IdP integration parameters and diagnose configuration issues before production use.\n#### Key Concepts\n- **Validation Utility:** Initiates a test flow against the configured IdP.\n- **Diagnostic Feedback:** Provides success status and error details.\n- **Readiness Signal:** Confirms correctness of protocol and mapping settings.\n- **Admin Tool:** Designed for identity administrators managing SSO.", "x-allOf-name": "iam.TestIdpConfiguration", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.TestIdpConfiguration', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.TestIdpConfiguration" ], "default": "iam.TestIdpConfiguration", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.TestIdpConfiguration" ], "default": "iam.TestIdpConfiguration", "x-enum-as-string": true }, "ErrorDetails": { "description": "Error returned by the IdP when the configuration test fails.", "type": "string", "readOnly": true, "x-omitempty": true }, "IdpEntityId": { "description": "Entity ID of the IdP whose configuration needs to be tested.", "type": "string", "readOnly": true, "x-omitempty": true }, "IsPasswordSet": { "description": "Indicates whether the value of the 'password' property has been set.", "type": "boolean", "default": false, "readOnly": true, "x-omitempty": true }, "NoOfGroups": { "description": "Total number of groups of the user received from the IdP after successful authentication.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Password": { "description": "The password of the test user for testing the IdP configuration settings. It can be any string that adheres to the following constraints. It can have character except spaces, tabs, line breaks. It cannot be more than 256 characters.", "type": "string", "pattern": "^$|^\\S{3,256}$", "writeOnly": true, "x-omitempty": true }, "Status": { "description": "IdP configuration test result.\n* `Unverified` - The IdP configuration is yet to be verified.\n* `Verified` - Successfully authenticated the user via the configured IdP and verified the configuration parameters.\n* `Pending` - Pending verification of the IdP configuration.\n* `Failed` - Could not authenticate the user via the configured IdP and verify its configuration.", "type": "string", "enum": [ "Unverified", "Verified", "Pending", "Failed" ], "default": "Unverified", "readOnly": true, "x-omitempty": true }, "TriggerTest": { "description": "Trigger property used to initiate an IdP configuration test.", "type": "boolean", "x-omitempty": true }, "Username": { "description": "Email or userId of the test user for testing the IdP configuration settings.", "type": "string", "pattern": "^$|^(?:[a-zA-Z0-9._-]{3,256}|[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*)$", "x-omitempty": true }, "Idp": { "$ref": "#/components/schemas/iam.Idp.Relationship", "description": "A reference to a iamIdp resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "iam.TestIdpConfiguration.List": { "title": "List of 'iam.TestIdpConfiguration' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.TestIdpConfiguration' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.TestIdpConfiguration' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.TestIdpConfiguration" }, "nullable": true } } } ] }, "iam.TrustPoint.Response": { "description": "The response body of a HTTP GET request for the 'iam.TrustPoint' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.TrustPoint' resources.", "x-one-of-name": "iam.TrustPoint.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.TrustPoint.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.TrustPoint.Relationship": { "description": "A relationship to the 'iam.TrustPoint' resource, or the expanded 'iam.TrustPoint' resource, or the 'null' value.", "x-one-of-name": "iam.TrustPoint.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iam.TrustPoint" } ], "discriminator": { "propertyName": "ClassId" } }, "iam.TrustPoint": { "title": "Iam:Trust Point", "description": "The TrustPoint object represents a trusted source of certificates within the system, enabling secure communication and authentication.\n#### Purpose\nA TrustPoint serves as a repository for certificates, affirming the identity of trusted entities and facilitating secure interactions with external systems.\n#### Key Concepts\n- **Certificate Management:** Stores and manages X.509 certificates, supporting both root and intermediate certificates for authentication purposes.\n- **Security Assurance:** Provides a basis for secure communication by validating the identity of external entities through trusted certificates.\n- **Account Association:** Associates certificates with specific accounts, ensuring they are available for authentication within the account's scope.\n- **Certificate Import:** Allows the import of third-party certificates, enhancing security through integration with external certificate authorities.", "x-allOf-name": "iam.TrustPoint", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.TrustPoint', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.TrustPoint" ], "default": "iam.TrustPoint", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.TrustPoint" ], "default": "iam.TrustPoint", "x-enum-as-string": true }, "Certificates": { "type": "array", "items": { "description": "The collection of certificates in X509 certificate format.\nThis was obtained by parsing the chain property which holds the base 64 encoded chain of certificates.", "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/x509.Certificate", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Chain": { "description": "The certificate information for this trusted point. The certificate must be in Base64 encoded X.509 (CER) format.", "type": "string", "x-omitempty": true }, "Account": { "$ref": "#/components/schemas/iam.Account.Relationship", "description": "A reference to a iamAccount resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "AssignedToEntity": { "description": "An array of relationships to moBaseMo resources.", "type": "array", "items": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo.Relationship" }, "nullable": true, "readOnly": true } } } ] }, "iam.TrustPoint.List": { "title": "List of 'iam.TrustPoint' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.TrustPoint' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.TrustPoint' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.TrustPoint" }, "nullable": true } } } ] }, "iam.User.Response": { "description": "The response body of a HTTP GET request for the 'iam.User' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.User' resources.", "x-one-of-name": "iam.User.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.User.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.User.Relationship": { "description": "A relationship to the 'iam.User' resource, or the expanded 'iam.User' resource, or the 'null' value.", "x-one-of-name": "iam.User.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iam.User" } ], "discriminator": { "propertyName": "ClassId" } }, "iam.User": { "title": "User", "description": "The User object represents individual users within the system, encompassing their identity, permissions, and roles.\n#### Purpose\nA User is a central entity within the system, defining the attributes, and roles associated with an individual accessing the system. It enables personalized and secure interactions with the system's resources.\n #### Key Concepts\n - **Identity Management:** Maintains user identification details, including name, email, and unique identifiers, for authentication and authorization purposes.\n - **Role Assignment:** Associates users with roles, defining their access levels and capabilities within the system.\n - **Session Tracking:** Tracks user sessions, providing insights into login activity and enabling session management features.\n - **Security Controls:** Implements security measures such as password policies and account lockout features, ensuring user accounts are protected against unauthorized access.", "x-allOf-name": "iam.User", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.User', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.User" ], "default": "iam.User", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.User" ], "default": "iam.User", "x-enum-as-string": true }, "ClientIpAddress": { "description": "IP address from which the user last logged in to Intersight.", "type": "string", "readOnly": true, "x-omitempty": true }, "Email": { "description": "Email of the user. Remote users are added to Intersight using the email configured in the IdP.", "type": "string", "pattern": "^$|^[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$", "x-createOnly": true, "x-omitempty": true }, "ExternalIdentifier": { "description": "External identifier for the user, used for integration with external identity systems.", "type": "string", "x-omitempty": true }, "FirstName": { "description": "First name of the user. For remote users, this field is populated from the IdP attributes received after authentication.", "type": "string", "x-omitempty": true }, "LastLoginTime": { "description": "Last successful login time for user.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "LastName": { "description": "Last name of the user. For remote users, this field is populated from the IdP attributes received after authentication.", "type": "string", "x-omitempty": true }, "LastRoleModifiedTime": { "description": "Last role modification time for user.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "LockedUntil": { "description": "Time until which the user account will be locked out.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "Name": { "description": "Name of the user. For remote users, it is the value as configured in the IdP.", "type": "string", "readOnly": true, "x-omitempty": true }, "UserIdOrEmail": { "description": "UserID or email of the user. For remote users, it is the value as configured in the IDP.", "type": "string", "x-createOnly": true, "x-omitempty": true }, "UserType": { "description": "Type of the User. If a user is added manually by specifying the email address, or has logged in using groups, based on the IdP attributes received during authentication. If added manually, the user type will be static, otherwise dynamic.", "type": "string", "readOnly": true, "x-omitempty": true }, "UserUniqueIdentifier": { "description": "Unique id of the user used by the identity provider to store the user.", "type": "string", "readOnly": true, "x-omitempty": true }, "ApiKeys": { "description": "An array of relationships to iamApiKey resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.ApiKey.Relationship" }, "nullable": true, "readOnly": true }, "AppRegistrations": { "description": "An array of relationships to iamAppRegistration resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.AppRegistration.Relationship" }, "nullable": true, "readOnly": true }, "Idp": { "$ref": "#/components/schemas/iam.Idp.Relationship", "description": "A reference to a iamIdp resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "Idpreference": { "$ref": "#/components/schemas/iam.IdpReference.Relationship", "description": "A reference to a iamIdpReference resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "LocalUserPassword": { "$ref": "#/components/schemas/iam.LocalUserPassword.Relationship", "description": "A reference to a iamLocalUserPassword resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "OauthTokens": { "description": "An array of relationships to iamOAuthToken resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.OAuthToken.Relationship" }, "nullable": true, "readOnly": true }, "Permissions": { "description": "An array of relationships to iamPermission resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.Permission.Relationship" }, "nullable": true }, "Sessions": { "description": "An array of relationships to iamSession resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.Session.Relationship" }, "nullable": true, "readOnly": true }, "Usergroup": { "description": "An array of relationships to iamUserGroup resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.UserGroup.Relationship" }, "nullable": true, "readOnly": true } } } ] }, "iam.User.List": { "title": "List of 'iam.User' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.User' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.User' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.User" }, "nullable": true } } } ] }, "iam.UserDetails": { "title": "Iam:User Details", "description": "Holds information such as UserName and Email of a guest user logging in to the account.", "x-allOf-name": "iam.UserDetails", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.UserDetails', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.UserDetails" ], "default": "iam.UserDetails", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.UserDetails" ], "default": "iam.UserDetails", "x-enum-as-string": true }, "EmailNotificationStatus": { "description": "Stores the information on whether user has been sent an email about access details or not.\n* `NotSent` - The Account Admin might not choose send email notification to any of their guest users.\n* `Sent` - An email notification sent to notified users who are configured per guest access link.", "type": "string", "enum": [ "NotSent", "Sent" ], "default": "NotSent", "readOnly": true, "x-omitempty": true }, "UserEmail": { "description": "Stores the user email ID of the guest user.", "type": "string", "pattern": "^$|^[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$", "minLength": 4, "maxLength": 320, "x-omitempty": true }, "UserName": { "description": "Stores the user name of the guest user.", "type": "string", "minLength": 0, "maxLength": 500, "x-omitempty": true } } } ] }, "iam.UserGroup.Response": { "description": "The response body of a HTTP GET request for the 'iam.UserGroup' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.UserGroup' resources.", "x-one-of-name": "iam.UserGroup.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.UserGroup.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.UserGroup.Relationship": { "description": "A relationship to the 'iam.UserGroup' resource, or the expanded 'iam.UserGroup' resource, or the 'null' value.", "x-one-of-name": "iam.UserGroup.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iam.UserGroup" } ], "discriminator": { "propertyName": "ClassId" } }, "iam.UserGroup": { "title": "Iam:User Group", "description": "UserGroup provides a policy mechanism to assign permissions to cohorts of users based on identity attributes or explicit guest inclusion.\n#### Purpose\nUserGroup simplifies access management by mapping identity attributes (or guest lists) to permissions at scale.\n#### Key Concepts\n- **Attribute-based Access:** Qualifies users into groups using IdP attributes.\n- **Guest Access Mode:** Supports time-bound, link-based access for guest users.\n- **Permission Binding:** Assigns roles and privileges via permissions to the group.\n- **Lifecycle Governance:** Tracks activation/expiry for guest access scenarios.", "x-allOf-name": "iam.UserGroup", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.UserGroup', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.UserGroup" ], "default": "iam.UserGroup", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.UserGroup" ], "default": "iam.UserGroup", "x-enum-as-string": true }, "AccessActivationTime": { "description": "AccessActivationTime indicates the activation time for the guest user's access to the Account. Before this time, if guest user tries to login to the account, access the account will be denied.", "type": "string", "format": "date-time", "x-omitempty": true }, "AccessExpiryTime": { "description": "AccessExpiryTime indicates the expiration time for the guest user's access to the Account. Its value can only be assigned a date that falls within the range determined by the maximum expiration time configured for the API entries. The AccessExpiry date can be edited to be earlier or later.", "type": "string", "format": "date-time", "x-omitempty": true }, "AccessLink": { "description": "AccessLink using which the guest user uses to log in to Intersight.", "type": "string", "readOnly": true, "x-omitempty": true }, "GroupType": { "description": "Group type determines the type of groups that is being associated with users. By default, Default User group will be used for associating dynamic user login. If the value of the User Group is set to guest, then this type of user group will be used for guest user login.\n* `Default` - Default User Group Type used for dynamic users login.\n* `Guest` - Guest User Group type used for guest users login.", "type": "string", "enum": [ "Default", "Guest" ], "default": "Default", "x-omitempty": true }, "Instruction": { "description": "Instruction property holds detailed guidance and information intended for individuals accessing the system as guest users. It holds the information to assist guests in navigating the platform, understanding policies, and performing necessary actions to ensure a seamless and secure user experience.", "type": "string", "maxLength": 2048, "x-omitempty": true }, "Name": { "description": "The name of the user group which the dynamic/or guest user belongs to.", "type": "string", "minLength": 1, "maxLength": 2048, "x-omitempty": true }, "UniqueReferenceId": { "description": "A random mixed character string which is unique per user groups. UniqueReferenceId is used as key for identifying the guest user groups.", "type": "string", "readOnly": true, "x-omitempty": true }, "Idp": { "$ref": "#/components/schemas/iam.Idp.Relationship", "description": "A reference to a iamIdp resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "Idpreference": { "$ref": "#/components/schemas/iam.IdpReference.Relationship", "description": "A reference to a iamIdpReference resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "Permissions": { "description": "An array of relationships to iamPermission resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.Permission.Relationship" }, "nullable": true }, "Qualifier": { "$ref": "#/components/schemas/iam.AbstractQualifier.Relationship", "description": "A reference to a iamAbstractQualifier resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "Users": { "description": "An array of relationships to iamUser resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.User.Relationship" }, "nullable": true, "readOnly": true } } } ] }, "iam.UserGroup.List": { "title": "List of 'iam.UserGroup' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.UserGroup' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.UserGroup' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.UserGroup" }, "nullable": true } } } ] }, "iam.UserPreference.Response": { "description": "The response body of a HTTP GET request for the 'iam.UserPreference' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.UserPreference' resources.", "x-one-of-name": "iam.UserPreference.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.UserPreference.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.UserPreference.Relationship": { "description": "A relationship to the 'iam.UserPreference' resource, or the expanded 'iam.UserPreference' resource, or the 'null' value.", "x-one-of-name": "iam.UserPreference.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iam.UserPreference" } ], "discriminator": { "propertyName": "ClassId" } }, "iam.UserPreference": { "title": "Iam:User Preference", "description": "UserPreference captures user interface preferences\u2014such as layout, view state, or theme\u2014persisted per user and identity context.\n#### Purpose\nIt enables consistent, personalized UI experiences across sessions and devices.\n#### Key Concepts\n- **Per-user Configuration:** Bound to a user and IdP/IdP reference context.\n- **Shared Resource:** Accessible across organizations where applicable.\n- **Self-service Updates:** Users can read and update their preferences.\n- **UI-centric:** Focused on client experience, not authorization.", "x-allOf-name": "iam.UserPreference", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.UserPreference', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.UserPreference" ], "default": "iam.UserPreference", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.UserPreference" ], "default": "iam.UserPreference", "x-enum-as-string": true }, "Preference": { "description": "UI preferences of the user.", "nullable": true, "x-omitempty": true }, "UserUniqueIdentifier": { "description": "Unique id of the user used by the identity provider to store the user.", "type": "string", "readOnly": true, "x-omitempty": true }, "Idp": { "$ref": "#/components/schemas/iam.Idp.Relationship", "description": "A reference to a iamIdp resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "IdpReference": { "$ref": "#/components/schemas/iam.IdpReference.Relationship", "description": "A reference to a iamIdpReference resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "iam.UserPreference.List": { "title": "List of 'iam.UserPreference' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.UserPreference' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.UserPreference' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.UserPreference" }, "nullable": true } } } ] }, "iam.UserQualifier.Response": { "description": "The response body of a HTTP GET request for the 'iam.UserQualifier' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.UserQualifier' resources.", "x-one-of-name": "iam.UserQualifier.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.UserQualifier.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.UserQualifier": { "title": "Iam:User Qualifier", "description": "UserQualifier specifies explicit guest user lists for a guest-type UserGroup and supports notification flows.\n#### Purpose\nIt streamlines management of guest access by enumerating allowed users and automating communication to them.\n#### Key Concepts\n- **Explicit Inclusion:** Lists guest users for controlled access.\n- **Notification Control:** Supports emailing access details to users.\n- **Guest Lifecycle:** Aligns with group activation and expiry.\n- **Group-bound:** Functions in the context of a guest user group.", "x-allOf-name": "iam.UserQualifier", "allOf": [ { "$ref": "#/components/schemas/iam.AbstractQualifier" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.UserQualifier', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.UserQualifier" ], "default": "iam.UserQualifier", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.UserQualifier" ], "default": "iam.UserQualifier", "x-enum-as-string": true }, "LastNotificationTime": { "description": "Holds the information on when last email notification was sent to the guest users.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "NotificationScope": { "description": "Defines the scope of email notifications for guest users. It determines which guest users should receive email notifications about account access details. Options include notifying all users or only newly added users.\n* `All` - Email Notification is sent to all users.\n* `New` - Email Notification is sent to newly added users.", "type": "string", "enum": [ "All", "New" ], "default": "All", "x-omitempty": true }, "NotifyGuestUsers": { "description": "NotifyGuestUsers holds information on whether guest users have been notified about the guest access information. If set to true, all guest users will receive a email notification about the details of guest access link and instructions.", "type": "boolean", "x-omitempty": true }, "UserDetails": { "type": "array", "items": { "description": "Stores the guest user details.", "$ref": "#/components/schemas/iam.UserDetails", "x-omitempty": true }, "nullable": true } } } ] }, "iam.UserQualifier.List": { "title": "List of 'iam.UserQualifier' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.UserQualifier' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.UserQualifier' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.UserQualifier" }, "nullable": true } } } ] }, "iam.UserSetting.Response": { "description": "The response body of a HTTP GET request for the 'iam.UserSetting' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.UserSetting' resources.", "x-one-of-name": "iam.UserSetting.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.UserSetting.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.UserSetting.Relationship": { "description": "A relationship to the 'iam.UserSetting' resource, or the expanded 'iam.UserSetting' resource, or the 'null' value.", "x-one-of-name": "iam.UserSetting.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iam.UserSetting" } ], "discriminator": { "propertyName": "ClassId" } }, "iam.UserSetting": { "title": "Iam:User Setting", "description": "UserSetting stores specific UI-related settings that are not part of general preferences, such as session recording opt-in status.\n#### Purpose\nIt allows storing discrete user settings that drive UI features and compliance preferences.\n#### Key Concepts\n- **Fine-grained Settings:** Captures individual flags or controls.\n- **Per-user Scope:** Stored per user and IdP/IdP reference context.\n- **Complementary to Preferences:** Designed for settings distinct from bulk UI preferences.\n- **Self-managed:** Users can create and update their own settings.", "x-allOf-name": "iam.UserSetting", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.UserSetting', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.UserSetting" ], "default": "iam.UserSetting", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.UserSetting" ], "default": "iam.UserSetting", "x-enum-as-string": true }, "AllowUiSessionRecording": { "description": "UI preference of the user for Session Recording.", "type": "boolean", "default": true, "x-omitempty": true }, "DefaultPermission": { "type": "array", "items": { "description": "Stores the shared default permission selection for all supported login interfaces. Eligible CUI IdpReference users must retain a valid default permission entry once they have at least one allowed permission in the tenant.", "$ref": "#/components/schemas/iam.DefaultPermissionInfo", "x-omitempty": true }, "nullable": true }, "UserIdOrEmail": { "description": "UserID or email as configured in the IdP.", "type": "string", "readOnly": true, "x-omitempty": true }, "UserUniqueIdentifier": { "description": "Unique id of the user used by the identity provider to store the user.", "type": "string", "readOnly": true, "x-omitempty": true }, "Idp": { "$ref": "#/components/schemas/iam.Idp.Relationship", "description": "A reference to a iamIdp resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "IdpReference": { "$ref": "#/components/schemas/iam.IdpReference.Relationship", "description": "A reference to a iamIdpReference resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "iam.UserSetting.List": { "title": "List of 'iam.UserSetting' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.UserSetting' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.UserSetting' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.UserSetting" }, "nullable": true } } } ] }, "license.AccountLicenseData.Response": { "description": "The response body of a HTTP GET request for the 'license.AccountLicenseData' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'license.AccountLicenseData' resources.", "x-one-of-name": "license.AccountLicenseData.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/license.AccountLicenseData.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "license.AccountLicenseData.Relationship": { "description": "A relationship to the 'license.AccountLicenseData' resource, or the expanded 'license.AccountLicenseData' resource, or the 'null' value.", "x-one-of-name": "license.AccountLicenseData.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/license.AccountLicenseData" } ], "discriminator": { "propertyName": "ClassId" } }, "license.AccountLicenseData": { "title": "License:Account License Data", "description": "License information for an account.", "x-allOf-name": "license.AccountLicenseData", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'license.AccountLicenseData', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "license.AccountLicenseData" ], "default": "license.AccountLicenseData", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "license.AccountLicenseData" ], "default": "license.AccountLicenseData", "x-enum-as-string": true }, "AccountId": { "description": "Root user's ID of the account.", "type": "string", "readOnly": true, "x-omitempty": true }, "AgentData": { "description": "Agent trusted store data.", "type": "string", "readOnly": true, "x-omitempty": true }, "AuthExpireTime": { "description": "Authorization expiration time.", "type": "string", "readOnly": true, "x-omitempty": true }, "AuthInitialTime": { "description": "Intial authorization time.", "type": "string", "readOnly": true, "x-omitempty": true }, "AuthNextTime": { "description": "Next time for the authorization.", "type": "string", "readOnly": true, "x-omitempty": true }, "Category": { "description": "Account license data category name.", "type": "string", "readOnly": true, "x-omitempty": true }, "DefaultLicenseType": { "description": "Default license tier set by the user.\n* `Base` - Base as a License type. It is default license type.\n* `Essential` - Essential as a License type.\n* `Standard` - Standard as a License type.\n* `Advantage` - Advantage as a License type.\n* `Premier` - Premier as a License type.\n* `IWO-Essential` - IWO-Essential as a License type.\n* `IWO-Advantage` - IWO-Advantage as a License type.\n* `IWO-Premier` - IWO-Premier as a License type.\n* `IKS-Advantage` - IKS-Advantage as a License type.\n* `INC-Premier-1GFixed` - Premier 1G Fixed license tier for Intersight Nexus Cloud.\n* `INC-Premier-10GFixed` - Premier 10G Fixed license tier for Intersight Nexus Cloud.\n* `INC-Premier-100GFixed` - Premier 100G Fixed license tier for Intersight Nexus Cloud.\n* `INC-Premier-Mod4Slot` - Premier Modular 4 slot license tier for Intersight Nexus Cloud.\n* `INC-Premier-Mod8Slot` - Premier Modular 8 slot license tier for Intersight Nexus Cloud.\n* `INC-Premier-D2OpsFixed` - Premier D2Ops fixed license tier for Intersight Nexus Cloud.\n* `INC-Premier-D2OpsMod` - Premier D2Ops modular license tier for Intersight Nexus Cloud.\n* `INC-Premier-CentralizedMod8Slot` - Premier modular license tier of switch type CentralizedMod8Slot for Intersight Nexus Cloud.\n* `INC-Premier-DistributedMod8Slot` - Premier modular license tier of switch type DistributedMod8Slot for Intersight Nexus Cloud.\n* `ERP-Advantage` - Advantage license tier for ERP workflows.\n* `IntersightTrial` - Virtual dummy license type to indicate trial. Used for UI display of trial mode Intersight tiers.\n* `IWOTrial` - Virtual dummy license type to indicate trial. Used for UI display of trial mode IKS tiers.\n* `IKSTrial` - Virtual dummy license type to indicate trial. Used for UI display of trial mode IWO tiers.\n* `INCTrial` - Virtual dummy license type to indicate trial. Used for UI display of trial mode Nexus tiers.", "type": "string", "enum": [ "Base", "Essential", "Standard", "Advantage", "Premier", "IWO-Essential", "IWO-Advantage", "IWO-Premier", "IKS-Advantage", "INC-Premier-1GFixed", "INC-Premier-10GFixed", "INC-Premier-100GFixed", "INC-Premier-Mod4Slot", "INC-Premier-Mod8Slot", "INC-Premier-D2OpsFixed", "INC-Premier-D2OpsMod", "INC-Premier-CentralizedMod8Slot", "INC-Premier-DistributedMod8Slot", "ERP-Advantage", "IntersightTrial", "IWOTrial", "IKSTrial", "INCTrial" ], "default": "Base", "x-omitempty": true }, "DefaultLicenseTypeNewerModels": { "description": "Default license tier for newer model M7+ servers set by the user.\n* `Base` - Base as a License type. It is default license type.\n* `Essential` - Essential as a License type.\n* `Standard` - Standard as a License type.\n* `Advantage` - Advantage as a License type.\n* `Premier` - Premier as a License type.\n* `IWO-Essential` - IWO-Essential as a License type.\n* `IWO-Advantage` - IWO-Advantage as a License type.\n* `IWO-Premier` - IWO-Premier as a License type.\n* `IKS-Advantage` - IKS-Advantage as a License type.\n* `INC-Premier-1GFixed` - Premier 1G Fixed license tier for Intersight Nexus Cloud.\n* `INC-Premier-10GFixed` - Premier 10G Fixed license tier for Intersight Nexus Cloud.\n* `INC-Premier-100GFixed` - Premier 100G Fixed license tier for Intersight Nexus Cloud.\n* `INC-Premier-Mod4Slot` - Premier Modular 4 slot license tier for Intersight Nexus Cloud.\n* `INC-Premier-Mod8Slot` - Premier Modular 8 slot license tier for Intersight Nexus Cloud.\n* `INC-Premier-D2OpsFixed` - Premier D2Ops fixed license tier for Intersight Nexus Cloud.\n* `INC-Premier-D2OpsMod` - Premier D2Ops modular license tier for Intersight Nexus Cloud.\n* `INC-Premier-CentralizedMod8Slot` - Premier modular license tier of switch type CentralizedMod8Slot for Intersight Nexus Cloud.\n* `INC-Premier-DistributedMod8Slot` - Premier modular license tier of switch type DistributedMod8Slot for Intersight Nexus Cloud.\n* `ERP-Advantage` - Advantage license tier for ERP workflows.\n* `IntersightTrial` - Virtual dummy license type to indicate trial. Used for UI display of trial mode Intersight tiers.\n* `IWOTrial` - Virtual dummy license type to indicate trial. Used for UI display of trial mode IKS tiers.\n* `IKSTrial` - Virtual dummy license type to indicate trial. Used for UI display of trial mode IWO tiers.\n* `INCTrial` - Virtual dummy license type to indicate trial. Used for UI display of trial mode Nexus tiers.", "type": "string", "enum": [ "Base", "Essential", "Standard", "Advantage", "Premier", "IWO-Essential", "IWO-Advantage", "IWO-Premier", "IKS-Advantage", "INC-Premier-1GFixed", "INC-Premier-10GFixed", "INC-Premier-100GFixed", "INC-Premier-Mod4Slot", "INC-Premier-Mod8Slot", "INC-Premier-D2OpsFixed", "INC-Premier-D2OpsMod", "INC-Premier-CentralizedMod8Slot", "INC-Premier-DistributedMod8Slot", "ERP-Advantage", "IntersightTrial", "IWOTrial", "IKSTrial", "INCTrial" ], "default": "Base", "x-omitempty": true }, "ErrorDesc": { "description": "The detailed error message when there is any error related to license sync of this account.", "type": "string", "readOnly": true, "x-omitempty": true }, "Group": { "description": "Account license data group name.", "type": "string", "readOnly": true, "x-omitempty": true }, "HighestCompliantLicenseTier": { "description": "The highest license tier which is in compliant of this account.\n* `Base` - Base as a License type. It is default license type.\n* `Essential` - Essential as a License type.\n* `Standard` - Standard as a License type.\n* `Advantage` - Advantage as a License type.\n* `Premier` - Premier as a License type.\n* `IWO-Essential` - IWO-Essential as a License type.\n* `IWO-Advantage` - IWO-Advantage as a License type.\n* `IWO-Premier` - IWO-Premier as a License type.\n* `IKS-Advantage` - IKS-Advantage as a License type.\n* `INC-Premier-1GFixed` - Premier 1G Fixed license tier for Intersight Nexus Cloud.\n* `INC-Premier-10GFixed` - Premier 10G Fixed license tier for Intersight Nexus Cloud.\n* `INC-Premier-100GFixed` - Premier 100G Fixed license tier for Intersight Nexus Cloud.\n* `INC-Premier-Mod4Slot` - Premier Modular 4 slot license tier for Intersight Nexus Cloud.\n* `INC-Premier-Mod8Slot` - Premier Modular 8 slot license tier for Intersight Nexus Cloud.\n* `INC-Premier-D2OpsFixed` - Premier D2Ops fixed license tier for Intersight Nexus Cloud.\n* `INC-Premier-D2OpsMod` - Premier D2Ops modular license tier for Intersight Nexus Cloud.\n* `INC-Premier-CentralizedMod8Slot` - Premier modular license tier of switch type CentralizedMod8Slot for Intersight Nexus Cloud.\n* `INC-Premier-DistributedMod8Slot` - Premier modular license tier of switch type DistributedMod8Slot for Intersight Nexus Cloud.\n* `ERP-Advantage` - Advantage license tier for ERP workflows.\n* `IntersightTrial` - Virtual dummy license type to indicate trial. Used for UI display of trial mode Intersight tiers.\n* `IWOTrial` - Virtual dummy license type to indicate trial. Used for UI display of trial mode IKS tiers.\n* `IKSTrial` - Virtual dummy license type to indicate trial. Used for UI display of trial mode IWO tiers.\n* `INCTrial` - Virtual dummy license type to indicate trial. Used for UI display of trial mode Nexus tiers.", "type": "string", "enum": [ "Base", "Essential", "Standard", "Advantage", "Premier", "IWO-Essential", "IWO-Advantage", "IWO-Premier", "IKS-Advantage", "INC-Premier-1GFixed", "INC-Premier-10GFixed", "INC-Premier-100GFixed", "INC-Premier-Mod4Slot", "INC-Premier-Mod8Slot", "INC-Premier-D2OpsFixed", "INC-Premier-D2OpsMod", "INC-Premier-CentralizedMod8Slot", "INC-Premier-DistributedMod8Slot", "ERP-Advantage", "IntersightTrial", "IWOTrial", "IKSTrial", "INCTrial" ], "default": "Base", "readOnly": true, "x-omitempty": true }, "LastCssmSync": { "description": "Specifies last sync time with CSSM.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "LastRenew": { "description": "Specifies last certificate renew time with SA.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "LastSync": { "description": "Specifies last sync time with SA.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "LastUpdatedTime": { "description": "Record's last update datetime.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "LicenseState": { "description": "Aggregrated mode for the agent.", "type": "string", "readOnly": true, "x-omitempty": true }, "LicenseTechSupportInfo": { "description": "Tech-support info of a smart-agent.", "type": "string", "readOnly": true, "x-omitempty": true }, "RegisterExpireTime": { "description": "Registration exipiration time.", "type": "string", "readOnly": true, "x-omitempty": true }, "RegisterInitialTime": { "description": "Initial time of registration.", "type": "string", "readOnly": true, "x-omitempty": true }, "RegisterNextTime": { "description": "Next time for the license registration.", "type": "string", "readOnly": true, "x-omitempty": true }, "RegistrationStatus": { "description": "Registration status of a smart-agent.", "type": "string", "readOnly": true, "x-omitempty": true }, "RenewFailureString": { "description": "License renewal failure message.", "type": "string", "readOnly": true, "x-omitempty": true }, "SmartAccount": { "description": "Name of the smart account.", "type": "string", "readOnly": true, "x-omitempty": true }, "SmartAccountDomain": { "description": "Domain Name of the smart account.", "type": "string", "readOnly": true, "x-omitempty": true }, "SmartApiEnabled": { "description": "Indicate whether API integration is enabled.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "SmartApiSyncStatus": { "description": "The detailed error message when there is any smart API sync error related to this account.", "type": "string", "readOnly": true, "x-omitempty": true }, "SyncStatus": { "description": "Current sync status for the account.", "type": "string", "readOnly": true, "x-omitempty": true }, "VirtualAccount": { "description": "Name of the virtual account.", "type": "string", "readOnly": true, "x-omitempty": true }, "Account": { "$ref": "#/components/schemas/iam.Account.Relationship", "description": "A reference to a iamAccount resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "CustomerOp": { "$ref": "#/components/schemas/license.CustomerOp.Relationship", "description": "A reference to a licenseCustomerOp resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "ErpCustomerOp": { "$ref": "#/components/schemas/license.ErpCustomerOp.Relationship", "description": "A reference to a licenseErpCustomerOp resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "ErpLicenseCount": { "$ref": "#/components/schemas/license.ErpLicenseCount.Relationship", "description": "A reference to a licenseErpLicenseCount resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "IksCustomerOp": { "$ref": "#/components/schemas/license.IksCustomerOp.Relationship", "description": "A reference to a licenseIksCustomerOp resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "IksLicenseCount": { "$ref": "#/components/schemas/license.IksLicenseCount.Relationship", "description": "A reference to a licenseIksLicenseCount resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "IncCustomerOp": { "$ref": "#/components/schemas/license.IncCustomerOp.Relationship", "description": "A reference to a licenseIncCustomerOp resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "IncLicenseCount": { "$ref": "#/components/schemas/license.IncLicenseCount.Relationship", "description": "A reference to a licenseIncLicenseCount resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "IwoCustomerOp": { "$ref": "#/components/schemas/license.IwoCustomerOp.Relationship", "description": "A reference to a licenseIwoCustomerOp resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "IwoLicenseCount": { "$ref": "#/components/schemas/license.IwoLicenseCount.Relationship", "description": "A reference to a licenseIwoLicenseCount resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "LicenseInfoView": { "$ref": "#/components/schemas/license.LicenseInfoView.Relationship", "description": "A reference to a licenseLicenseInfoView resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "LicenseRegistrationStatus": { "$ref": "#/components/schemas/license.LicenseRegistrationStatus.Relationship", "description": "A reference to a licenseLicenseRegistrationStatus resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "Licenseinfos": { "description": "An array of relationships to licenseLicenseInfo resources.", "type": "array", "items": { "$ref": "#/components/schemas/license.LicenseInfo.Relationship" }, "nullable": true }, "SmartlicenseToken": { "$ref": "#/components/schemas/license.SmartlicenseToken.Relationship", "description": "A reference to a licenseSmartlicenseToken resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." } } } ] }, "license.AccountLicenseData.List": { "title": "List of 'license.AccountLicenseData' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'license.AccountLicenseData' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'license.AccountLicenseData' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/license.AccountLicenseData" }, "nullable": true } } } ] }, "license.CustomerOp.Response": { "description": "The response body of a HTTP GET request for the 'license.CustomerOp' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'license.CustomerOp' resources.", "x-one-of-name": "license.CustomerOp.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/license.CustomerOp.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "license.CustomerOp.Relationship": { "description": "A relationship to the 'license.CustomerOp' resource, or the expanded 'license.CustomerOp' resource, or the 'null' value.", "x-one-of-name": "license.CustomerOp.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/license.CustomerOp" } ], "discriminator": { "propertyName": "ClassId" } }, "license.CustomerOp": { "title": "License:Customer Op", "description": "CustomerOp object is integral to managing customer operations related to license registration and authentication within the system. This provides mechanisms for refreshing registration, renewing authorization, and enabling licensing features, ensuring seamless interaction with licensing services.\n#### Purpose\nCustomerOp object facilitates the management of licensing-related operations for customers. It allows users to trigger renewals, initiate trials, and manage registration states, providing a central interface for these critical operations.\n#### Key Concepts\n- **License Management:** Offers functionality to renew registration and authorization, ensuring licenses remain valid and operational.\n- **Trial Enablement:** Supports enabling trial modes for licensing, allowing customers to evaluate services before committing.\n- **Administrative Control:** Provides properties for activating license entitlements, ensuring customers can manage their license states effectively.\n- **Shared Organizational Resource:** Designed to operate within shared organizational contexts, allowing consistent application across different accounts and user roles.", "x-allOf-name": "license.CustomerOp", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'license.CustomerOp', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "license.CustomerOp" ], "default": "license.CustomerOp", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "license.CustomerOp" ], "default": "license.CustomerOp", "x-enum-as-string": true }, "ActiveAdmin": { "description": "The license administrative state.\nSet this property to 'true' to activate the license entitlements.", "type": "boolean", "x-omitempty": true }, "AllDevicesToDefaultTier": { "description": "Move all licensed devices to default license tier.", "type": "boolean", "x-omitempty": true }, "ClearApiSyncStatus": { "description": "Clear the status of smart API sync.", "type": "boolean", "x-omitempty": true }, "DeregisterDevice": { "description": "Trigger de-registration/disable.", "type": "boolean", "x-omitempty": true }, "EnableTrial": { "description": "Enable trial for Intersight licensing.", "type": "boolean", "x-omitempty": true }, "EvaluationPeriod": { "description": "The default Trial or Grace period customer is entitled to.", "type": "integer", "format": "int64", "x-omitempty": true }, "ExtraEvaluation": { "description": "The number of days the trial Trial or Grace period is extended. The trial or grace period can be extended once.", "type": "integer", "format": "int64", "x-omitempty": true }, "RenewAuthorization": { "description": "Trigger renew authorization.", "type": "boolean", "x-omitempty": true }, "RenewIdCertificate": { "description": "Trigger renew registration.", "type": "boolean", "x-omitempty": true }, "ShowAgentTechSupport": { "description": "Trigger show tech support feature.", "type": "boolean", "x-omitempty": true }, "AccountLicenseData": { "$ref": "#/components/schemas/license.AccountLicenseData.Relationship", "description": "A reference to a licenseAccountLicenseData resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." } } } ] }, "license.CustomerOp.List": { "title": "List of 'license.CustomerOp' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'license.CustomerOp' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'license.CustomerOp' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/license.CustomerOp" }, "nullable": true } } } ] }, "license.ErpCustomerOp.Response": { "description": "The response body of a HTTP GET request for the 'license.ErpCustomerOp' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'license.ErpCustomerOp' resources.", "x-one-of-name": "license.ErpCustomerOp.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/license.ErpCustomerOp.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "license.ErpCustomerOp.Relationship": { "description": "A relationship to the 'license.ErpCustomerOp' resource, or the expanded 'license.ErpCustomerOp' resource, or the 'null' value.", "x-one-of-name": "license.ErpCustomerOp.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/license.ErpCustomerOp" } ], "discriminator": { "propertyName": "ClassId" } }, "license.ErpCustomerOp": { "title": "License:Erp Customer Op", "description": "The ErpCustomerOp object is crucial for managing operations related to ERP licensing, providing tools for trial enablement and administrative controls.\n#### Purpose\nErpCustomerOp serves as the operational interface for ERP license management, offering functionalities for trial periods and tier settings, ensuring customers can effectively manage their ERP configurations.\n#### Key Concepts\n- **ERP Licensing:** Focuses on the management of ERP service licenses, ensuring customers can tailor their configurations to business needs.\n- **Trial Enablement:** Allows activation of trial modes, offering opportunities to explore ERP service features.\n- **License Tier Management:** Supports settings for active tiers, providing flexibility in service configuration and utilization.\n- **Administrative Activation:** Provides controls for activating licenses, ensuring customers maintain access to ERP service capabilities.", "x-allOf-name": "license.ErpCustomerOp", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'license.ErpCustomerOp', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "license.ErpCustomerOp" ], "default": "license.ErpCustomerOp", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "license.ErpCustomerOp" ], "default": "license.ErpCustomerOp", "x-enum-as-string": true }, "ActiveAdmin": { "description": "The ERP license administrative state.\nSet this property to 'true' to activate the ERP license entitlements.", "type": "boolean", "x-omitempty": true }, "EnableTrial": { "description": "Enable trial for ERP licensing.", "type": "boolean", "x-omitempty": true }, "EvaluationPeriod": { "description": "The default Trial or Grace period the customer is entitled to.", "type": "integer", "format": "int64", "x-omitempty": true }, "ExtraEvaluation": { "description": "The number of days the trial Trial or Grace period is extended. The trial or grace period can be extended once.", "type": "integer", "format": "int64", "x-omitempty": true }, "AccountLicenseData": { "$ref": "#/components/schemas/license.AccountLicenseData.Relationship", "description": "A reference to a licenseAccountLicenseData resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." } } } ] }, "license.ErpCustomerOp.List": { "title": "List of 'license.ErpCustomerOp' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'license.ErpCustomerOp' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'license.ErpCustomerOp' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/license.ErpCustomerOp" }, "nullable": true } } } ] }, "license.ErpLicenseCount.Response": { "description": "The response body of a HTTP GET request for the 'license.ErpLicenseCount' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'license.ErpLicenseCount' resources.", "x-one-of-name": "license.ErpLicenseCount.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/license.ErpLicenseCount.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "license.ErpLicenseCount.Relationship": { "description": "A relationship to the 'license.ErpLicenseCount' resource, or the expanded 'license.ErpLicenseCount' resource, or the 'null' value.", "x-one-of-name": "license.ErpLicenseCount.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/license.ErpLicenseCount" } ], "discriminator": { "propertyName": "ClassId" } }, "license.ErpLicenseCount": { "title": "License:Erp License Count", "description": "Customer operation object to request reservation code.", "x-allOf-name": "license.ErpLicenseCount", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'license.ErpLicenseCount', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "license.ErpLicenseCount" ], "default": "license.ErpLicenseCount", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "license.ErpLicenseCount" ], "default": "license.ErpLicenseCount", "x-enum-as-string": true }, "AdvantageCount": { "description": "The total number of devices claimed in the Erp workflow Advantage tier.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "AccountLicenseData": { "$ref": "#/components/schemas/license.AccountLicenseData.Relationship", "description": "A reference to a licenseAccountLicenseData resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." } } } ] }, "license.ErpLicenseCount.List": { "title": "List of 'license.ErpLicenseCount' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'license.ErpLicenseCount' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'license.ErpLicenseCount' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/license.ErpLicenseCount" }, "nullable": true } } } ] }, "license.IksCustomerOp.Response": { "description": "The response body of a HTTP GET request for the 'license.IksCustomerOp' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'license.IksCustomerOp' resources.", "x-one-of-name": "license.IksCustomerOp.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/license.IksCustomerOp.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "license.IksCustomerOp.Relationship": { "description": "A relationship to the 'license.IksCustomerOp' resource, or the expanded 'license.IksCustomerOp' resource, or the 'null' value.", "x-one-of-name": "license.IksCustomerOp.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/license.IksCustomerOp" } ], "discriminator": { "propertyName": "ClassId" } }, "license.IksCustomerOp": { "title": "License:Iks Customer Op", "description": "The IksCustomerOp object handles customer operations related to the Intersight Kubernetes Service (IKS) licensing, providing mechanisms for trial enablement and tier management.\n#### Purpose\nIksCustomerOp is designed to facilitate the management of Kubernetes service licenses. It enables trial periods, tier settings, and administrative controls, ensuring customers can leverage Kubernetes services effectively.\n#### Key Concepts\n- **Kubernetes Service Management:** Focuses on the licensing aspects of Kubernetes services, ensuring customers can optimize their configurations.\n- **Trial Enablement:** Allows users to activate trial modes, providing opportunities to explore Kubernetes service features.\n- **License Tier Configuration:** Supports active tier settings, allowing customization based on customer requirements and service levels.\n- **Administrative Entitlements:** Provides controls to activate licenses, ensuring customers maintain access to Kubernetes service capabilities.", "x-allOf-name": "license.IksCustomerOp", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'license.IksCustomerOp', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "license.IksCustomerOp" ], "default": "license.IksCustomerOp", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "license.IksCustomerOp" ], "default": "license.IksCustomerOp", "x-enum-as-string": true }, "ActiveAdmin": { "description": "The Intersight Kubernetes Service license administrative state.\nSet this property to 'true' to activate the IKS license entitlements.", "type": "boolean", "x-omitempty": true }, "EnableTrial": { "description": "Enable trial for IKS licensing.", "type": "boolean", "x-omitempty": true }, "EvaluationPeriod": { "description": "The default Trial or Grace period the customer is entitled to.", "type": "integer", "format": "int64", "x-omitempty": true }, "ExtraEvaluation": { "description": "The number of days the trial Trial or Grace period is extended. The trial or grace period can be extended once.", "type": "integer", "format": "int64", "x-omitempty": true }, "AccountLicenseData": { "$ref": "#/components/schemas/license.AccountLicenseData.Relationship", "description": "A reference to a licenseAccountLicenseData resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." } } } ] }, "license.IksCustomerOp.List": { "title": "List of 'license.IksCustomerOp' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'license.IksCustomerOp' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'license.IksCustomerOp' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/license.IksCustomerOp" }, "nullable": true } } } ] }, "license.IksLicenseCount.Response": { "description": "The response body of a HTTP GET request for the 'license.IksLicenseCount' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'license.IksLicenseCount' resources.", "x-one-of-name": "license.IksLicenseCount.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/license.IksLicenseCount.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "license.IksLicenseCount.Relationship": { "description": "A relationship to the 'license.IksLicenseCount' resource, or the expanded 'license.IksLicenseCount' resource, or the 'null' value.", "x-one-of-name": "license.IksLicenseCount.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/license.IksLicenseCount" } ], "discriminator": { "propertyName": "ClassId" } }, "license.IksLicenseCount": { "title": "License:Iks License Count", "description": "Customer operation object to request reservation code.", "x-allOf-name": "license.IksLicenseCount", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'license.IksLicenseCount', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "license.IksLicenseCount" ], "default": "license.IksLicenseCount", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "license.IksLicenseCount" ], "default": "license.IksLicenseCount", "x-enum-as-string": true }, "AdvantageCount": { "description": "The total number of devices claimed in the IKS Advantage tier.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "AccountLicenseData": { "$ref": "#/components/schemas/license.AccountLicenseData.Relationship", "description": "A reference to a licenseAccountLicenseData resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." } } } ] }, "license.IksLicenseCount.List": { "title": "List of 'license.IksLicenseCount' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'license.IksLicenseCount' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'license.IksLicenseCount' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/license.IksLicenseCount" }, "nullable": true } } } ] }, "license.IncCustomerOp.Response": { "description": "The response body of a HTTP GET request for the 'license.IncCustomerOp' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'license.IncCustomerOp' resources.", "x-one-of-name": "license.IncCustomerOp.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/license.IncCustomerOp.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "license.IncCustomerOp.Relationship": { "description": "A relationship to the 'license.IncCustomerOp' resource, or the expanded 'license.IncCustomerOp' resource, or the 'null' value.", "x-one-of-name": "license.IncCustomerOp.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/license.IncCustomerOp" } ], "discriminator": { "propertyName": "ClassId" } }, "license.IncCustomerOp": { "title": "License:Inc Customer Op", "description": "The IncCustomerOp object is central to managing operations related to the Intersight Nexus Cloud (INC) licensing, offering functionalities for trial management and administrative control.\n#### Purpose \nIncCustomerOp facilitates management of Nexus Cloud licenses, providing tools for trial enablement and tier configuration. It ensures customers can access and manage cloud services efficiently.\n#### Key Concepts \n- **Nexus Cloud Licensing:** Centralizes management of cloud service licenses, allowing customers to optimize their cloud configurations.\n- **Trial Management:** Supports enabling and terminating trial periods, providing flexibility in evaluating cloud services.\n- **Tier Configuration:** Offers settings for active license tiers, ensuring customers can tailor cloud services to their operational needs.\n- **Administrative Activation:** Empowers users to activate license entitlements, ensuring access to cloud service capabilities.", "x-allOf-name": "license.IncCustomerOp", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'license.IncCustomerOp', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "license.IncCustomerOp" ], "default": "license.IncCustomerOp", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "license.IncCustomerOp" ], "default": "license.IncCustomerOp", "x-enum-as-string": true }, "ActiveAdmin": { "description": "The Nexus Cloud license administrative state.\nSet this property to 'true' to activate the Nexus Cloud license entitlements.", "type": "boolean", "x-omitempty": true }, "EnableTrial": { "description": "Enable trial for Nexus Cloud licensing.", "type": "boolean", "x-omitempty": true }, "EvaluationPeriod": { "description": "The default Trial or Grace period the customer is entitled to.", "type": "integer", "format": "int64", "x-omitempty": true }, "ExtraEvaluation": { "description": "The number of days the trial Trial or Grace period is extended. The trial or grace period can be extended once.", "type": "integer", "format": "int64", "x-omitempty": true }, "TerminateTrial": { "description": "Terminate trial mode for Nexus Cloud.", "type": "boolean", "x-omitempty": true }, "AccountLicenseData": { "$ref": "#/components/schemas/license.AccountLicenseData.Relationship", "description": "A reference to a licenseAccountLicenseData resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." } } } ] }, "license.IncCustomerOp.List": { "title": "List of 'license.IncCustomerOp' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'license.IncCustomerOp' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'license.IncCustomerOp' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/license.IncCustomerOp" }, "nullable": true } } } ] }, "license.IncLicenseCount.Response": { "description": "The response body of a HTTP GET request for the 'license.IncLicenseCount' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'license.IncLicenseCount' resources.", "x-one-of-name": "license.IncLicenseCount.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/license.IncLicenseCount.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "license.IncLicenseCount.Relationship": { "description": "A relationship to the 'license.IncLicenseCount' resource, or the expanded 'license.IncLicenseCount' resource, or the 'null' value.", "x-one-of-name": "license.IncLicenseCount.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/license.IncLicenseCount" } ], "discriminator": { "propertyName": "ClassId" } }, "license.IncLicenseCount": { "title": "License:Inc License Count", "description": "Customer operation object to request reservation code.", "x-allOf-name": "license.IncLicenseCount", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'license.IncLicenseCount', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "license.IncLicenseCount" ], "default": "license.IncLicenseCount", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "license.IncLicenseCount" ], "default": "license.IncLicenseCount", "x-enum-as-string": true }, "Premier100GfxCount": { "description": "The total number of devices claimed in the premier 100G fixed tier Intersight Nexus Cloud.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Premier10GfxCount": { "description": "The total number of devices claimed in the premier 10G fixed tier Intersight Nexus Cloud.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Premier1GfxCount": { "description": "The total number of devices claimed in the premier 1G fixed tier Intersight Nexus Cloud.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "PremierCentralizedMod8SlotCount": { "description": "The total number of devices claimed in the CentralizedMod8Slot premier tier Intersight Nexus Cloud.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "PremierD2OpsFixedCount": { "description": "The total number of devices claimed in the D2Ops Fixed premier tier Intersight Nexus Cloud.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "PremierD2OpsModCount": { "description": "The total number of devices claimed in the D2Ops modular premier tier Intersight Nexus Cloud.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "PremierDistributedMod8SlotCount": { "description": "The total number of devices claimed in the DistributedMod8Slot premier tier Intersight Nexus Cloud.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "PremierMod4SlotCount": { "description": "The total number of devices claimed in the modular 4 slot premier tier Intersight Nexus Cloud.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "PremierMod8SlotCount": { "description": "The total number of devices claimed in the modular 8 slot premier tier Intersight Nexus Cloud.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "AccountLicenseData": { "$ref": "#/components/schemas/license.AccountLicenseData.Relationship", "description": "A reference to a licenseAccountLicenseData resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." } } } ] }, "license.IncLicenseCount.List": { "title": "List of 'license.IncLicenseCount' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'license.IncLicenseCount' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'license.IncLicenseCount' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/license.IncLicenseCount" }, "nullable": true } } } ] }, "license.IwoCustomerOp.Response": { "description": "The response body of a HTTP GET request for the 'license.IwoCustomerOp' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'license.IwoCustomerOp' resources.", "x-one-of-name": "license.IwoCustomerOp.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/license.IwoCustomerOp.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "license.IwoCustomerOp.Relationship": { "description": "A relationship to the 'license.IwoCustomerOp' resource, or the expanded 'license.IwoCustomerOp' resource, or the 'null' value.", "x-one-of-name": "license.IwoCustomerOp.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/license.IwoCustomerOp" } ], "discriminator": { "propertyName": "ClassId" } }, "license.IwoCustomerOp": { "title": "License:Iwo Customer Op", "description": "The IwoCustomerOp object focuses on operations related to the Intersight Workload Optimizer (IWO) licensing, offering tools for managing license tiers and trials within the workload optimization context.\n#### Purpose\nIwoCustomerOp serves as the operational interface for managing workload optimizer licensing. It supports administrative functions, trial enablement, and tier management, ensuring customers can optimize their licensing configurations.\n#### Key Concepts\n- **Workload Optimization:** Facilitates management of IWO license entitlements, allowing customers to tailor their optimization settings to specific needs.\n- **License Tier Management:** Supports setting and managing active license types, providing flexibility in how services are configured and utilized.\n- **Trial Operations:**Enables trial periods for customers to assess the workload optimizer features and benefits.\n- **Administrative Activation:** Allows activation of license entitlements, ensuring operational continuity and access to optimizer capabilities.", "x-allOf-name": "license.IwoCustomerOp", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'license.IwoCustomerOp', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "license.IwoCustomerOp" ], "default": "license.IwoCustomerOp", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "license.IwoCustomerOp" ], "default": "license.IwoCustomerOp", "x-enum-as-string": true }, "ActiveAdmin": { "description": "The workload optimizer license administrative state.\nSet this property to 'true' to activate the workload optimizer license entitlements.", "type": "boolean", "x-omitempty": true }, "ActiveLicenseType": { "description": "Active workload optimizer license tier set by user.\n* `Base` - Base as a License type. It is default license type.\n* `Essential` - Essential as a License type.\n* `Standard` - Standard as a License type.\n* `Advantage` - Advantage as a License type.\n* `Premier` - Premier as a License type.\n* `IWO-Essential` - IWO-Essential as a License type.\n* `IWO-Advantage` - IWO-Advantage as a License type.\n* `IWO-Premier` - IWO-Premier as a License type.\n* `IKS-Advantage` - IKS-Advantage as a License type.\n* `INC-Premier-1GFixed` - Premier 1G Fixed license tier for Intersight Nexus Cloud.\n* `INC-Premier-10GFixed` - Premier 10G Fixed license tier for Intersight Nexus Cloud.\n* `INC-Premier-100GFixed` - Premier 100G Fixed license tier for Intersight Nexus Cloud.\n* `INC-Premier-Mod4Slot` - Premier Modular 4 slot license tier for Intersight Nexus Cloud.\n* `INC-Premier-Mod8Slot` - Premier Modular 8 slot license tier for Intersight Nexus Cloud.\n* `INC-Premier-D2OpsFixed` - Premier D2Ops fixed license tier for Intersight Nexus Cloud.\n* `INC-Premier-D2OpsMod` - Premier D2Ops modular license tier for Intersight Nexus Cloud.\n* `INC-Premier-CentralizedMod8Slot` - Premier modular license tier of switch type CentralizedMod8Slot for Intersight Nexus Cloud.\n* `INC-Premier-DistributedMod8Slot` - Premier modular license tier of switch type DistributedMod8Slot for Intersight Nexus Cloud.\n* `ERP-Advantage` - Advantage license tier for ERP workflows.\n* `IntersightTrial` - Virtual dummy license type to indicate trial. Used for UI display of trial mode Intersight tiers.\n* `IWOTrial` - Virtual dummy license type to indicate trial. Used for UI display of trial mode IKS tiers.\n* `IKSTrial` - Virtual dummy license type to indicate trial. Used for UI display of trial mode IWO tiers.\n* `INCTrial` - Virtual dummy license type to indicate trial. Used for UI display of trial mode Nexus tiers.", "type": "string", "enum": [ "Base", "Essential", "Standard", "Advantage", "Premier", "IWO-Essential", "IWO-Advantage", "IWO-Premier", "IKS-Advantage", "INC-Premier-1GFixed", "INC-Premier-10GFixed", "INC-Premier-100GFixed", "INC-Premier-Mod4Slot", "INC-Premier-Mod8Slot", "INC-Premier-D2OpsFixed", "INC-Premier-D2OpsMod", "INC-Premier-CentralizedMod8Slot", "INC-Premier-DistributedMod8Slot", "ERP-Advantage", "IntersightTrial", "IWOTrial", "IKSTrial", "INCTrial" ], "default": "Base", "x-omitempty": true }, "EnableTrial": { "description": "Enable trial for Intersight licensing.", "type": "boolean", "x-omitempty": true }, "EvaluationPeriod": { "description": "The default Trial or Grace period customer is entitled to.", "type": "integer", "format": "int64", "x-omitempty": true }, "ExtraEvaluation": { "description": "The number of days the trial Trial or Grace period is extended. The trial or grace period can be extended once.", "type": "integer", "format": "int64", "x-omitempty": true }, "AccountLicenseData": { "$ref": "#/components/schemas/license.AccountLicenseData.Relationship", "description": "A reference to a licenseAccountLicenseData resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." } } } ] }, "license.IwoCustomerOp.List": { "title": "List of 'license.IwoCustomerOp' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'license.IwoCustomerOp' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'license.IwoCustomerOp' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/license.IwoCustomerOp" }, "nullable": true } } } ] }, "license.IwoLicenseCount.Response": { "description": "The response body of a HTTP GET request for the 'license.IwoLicenseCount' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'license.IwoLicenseCount' resources.", "x-one-of-name": "license.IwoLicenseCount.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/license.IwoLicenseCount.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "license.IwoLicenseCount.Relationship": { "description": "A relationship to the 'license.IwoLicenseCount' resource, or the expanded 'license.IwoLicenseCount' resource, or the 'null' value.", "x-one-of-name": "license.IwoLicenseCount.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/license.IwoLicenseCount" } ], "discriminator": { "propertyName": "ClassId" } }, "license.IwoLicenseCount": { "title": "License:Iwo License Count", "description": "Customer operation object to request reservation code.", "x-allOf-name": "license.IwoLicenseCount", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'license.IwoLicenseCount', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "license.IwoLicenseCount" ], "default": "license.IwoLicenseCount", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "license.IwoLicenseCount" ], "default": "license.IwoLicenseCount", "x-enum-as-string": true }, "VmLicenseCount": { "description": "The total number of devices claimed in the Intersight account.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "AccountLicenseData": { "$ref": "#/components/schemas/license.AccountLicenseData.Relationship", "description": "A reference to a licenseAccountLicenseData resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." } } } ] }, "license.IwoLicenseCount.List": { "title": "List of 'license.IwoLicenseCount' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'license.IwoLicenseCount' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'license.IwoLicenseCount' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/license.IwoLicenseCount" }, "nullable": true } } } ] }, "license.LicenseInfo.Response": { "description": "The response body of a HTTP GET request for the 'license.LicenseInfo' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'license.LicenseInfo' resources.", "x-one-of-name": "license.LicenseInfo.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/license.LicenseInfo.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "license.LicenseInfo.Relationship": { "description": "A relationship to the 'license.LicenseInfo' resource, or the expanded 'license.LicenseInfo' resource, or the 'null' value.", "x-one-of-name": "license.LicenseInfo.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/license.LicenseInfo" } ], "discriminator": { "propertyName": "ClassId" } }, "license.LicenseInfo": { "title": "License:License Info", "description": "License state information for a specific license entitlement. Essentials license entitlement is supported currently.\nlicenseState attribute is used for license enforcement. When license state is one of TrialPeriod, Compliance, or OutOfCompliance,\nthe feature set defined for the license entitlement is granted to the customer.", "x-allOf-name": "license.LicenseInfo", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'license.LicenseInfo', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "license.LicenseInfo" ], "default": "license.LicenseInfo", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "license.LicenseInfo" ], "default": "license.LicenseInfo", "x-enum-as-string": true }, "ActiveAdmin": { "description": "The license administrative state.\nSet this property to 'true' to activate the license entitlements.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "Balance": { "description": "The total balance we have for licenses.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "DaysLeft": { "description": "The number of days left for licenseState to stay in TrialPeriod or OutOfCompliance state.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "EndTime": { "description": "The date and time when the trial period expires.\nThe value of the 'endTime' property is set when the account enters the TrialPeriod or OutOfCompliance state.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "EnforceMode": { "description": "The entitlement mode reported by Cisco Smart Software Manager.", "type": "string", "readOnly": true, "x-omitempty": true }, "ErrorDesc": { "description": "The detailed error message when there is any error related to this licensing entitlement.", "type": "string", "readOnly": true, "x-omitempty": true }, "EvaluationPeriod": { "description": "The default Trial or Grace period customer is entitled to.", "type": "integer", "format": "int64", "x-omitempty": true }, "ExpireTime": { "description": "The date and time when the next expiration time of license subscription.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "ExtraEvaluation": { "description": "The number of days the trial Trial or Grace period is extended.\nThe trial or grace period can be extended once.", "type": "integer", "format": "int64", "x-omitempty": true }, "LastTrialGraceEvalTime": { "description": "The last time the trial/grace period evaluation was performed for this license.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "LicenseCount": { "description": "The total number of license consumed in the Intersight account.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "LicenseCountPurchased": { "description": "The total number of license purchased from cisco.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "LicenseState": { "description": "The license state defined by Intersight.\nThe value may be one of NotLicensed, TrialPeriod, OutOfCompliance, Compliance, GraceExpired, or TrialExpired.\n* `NotLicensed` - The license token is neither activated nor registered.\n* `GraceExpired` - The license grace period has expired.\n* `TrialPeriod` - The 90 days of trial period.\n* `OutOfCompliance` - The license is out of compliance.\n* `Compliance` - The license is in compliance.\n* `TrialExpired` - The trial period of 90 days has expired.", "type": "string", "enum": [ "NotLicensed", "GraceExpired", "TrialPeriod", "OutOfCompliance", "Compliance", "TrialExpired" ], "default": "NotLicensed", "readOnly": true, "x-omitempty": true }, "LicenseType": { "description": "The name of the Intersight license entitlement.\nFor example, this property may be set to 'Essential'.\n* `Base` - Base as a License type. It is default license type.\n* `Essential` - Essential as a License type.\n* `Standard` - Standard as a License type.\n* `Advantage` - Advantage as a License type.\n* `Premier` - Premier as a License type.\n* `IWO-Essential` - IWO-Essential as a License type.\n* `IWO-Advantage` - IWO-Advantage as a License type.\n* `IWO-Premier` - IWO-Premier as a License type.\n* `IKS-Advantage` - IKS-Advantage as a License type.\n* `INC-Premier-1GFixed` - Premier 1G Fixed license tier for Intersight Nexus Cloud.\n* `INC-Premier-10GFixed` - Premier 10G Fixed license tier for Intersight Nexus Cloud.\n* `INC-Premier-100GFixed` - Premier 100G Fixed license tier for Intersight Nexus Cloud.\n* `INC-Premier-Mod4Slot` - Premier Modular 4 slot license tier for Intersight Nexus Cloud.\n* `INC-Premier-Mod8Slot` - Premier Modular 8 slot license tier for Intersight Nexus Cloud.\n* `INC-Premier-D2OpsFixed` - Premier D2Ops fixed license tier for Intersight Nexus Cloud.\n* `INC-Premier-D2OpsMod` - Premier D2Ops modular license tier for Intersight Nexus Cloud.\n* `INC-Premier-CentralizedMod8Slot` - Premier modular license tier of switch type CentralizedMod8Slot for Intersight Nexus Cloud.\n* `INC-Premier-DistributedMod8Slot` - Premier modular license tier of switch type DistributedMod8Slot for Intersight Nexus Cloud.\n* `ERP-Advantage` - Advantage license tier for ERP workflows.\n* `IntersightTrial` - Virtual dummy license type to indicate trial. Used for UI display of trial mode Intersight tiers.\n* `IWOTrial` - Virtual dummy license type to indicate trial. Used for UI display of trial mode IKS tiers.\n* `IKSTrial` - Virtual dummy license type to indicate trial. Used for UI display of trial mode IWO tiers.\n* `INCTrial` - Virtual dummy license type to indicate trial. Used for UI display of trial mode Nexus tiers.", "type": "string", "enum": [ "Base", "Essential", "Standard", "Advantage", "Premier", "IWO-Essential", "IWO-Advantage", "IWO-Premier", "IKS-Advantage", "INC-Premier-1GFixed", "INC-Premier-10GFixed", "INC-Premier-100GFixed", "INC-Premier-Mod4Slot", "INC-Premier-Mod8Slot", "INC-Premier-D2OpsFixed", "INC-Premier-D2OpsMod", "INC-Premier-CentralizedMod8Slot", "INC-Premier-DistributedMod8Slot", "ERP-Advantage", "IntersightTrial", "IWOTrial", "IKSTrial", "INCTrial" ], "default": "Base", "readOnly": true, "x-omitempty": true }, "NetSubstitution": { "description": "The total number of substituted licenses added or removed.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "StartTime": { "description": "The date and time when the licenseState entered the TrialPeriod or OutOfCompliance state.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "SubscriptionId": { "description": "The id of license subscription.", "type": "string", "readOnly": true, "x-omitempty": true }, "SubstitutedLicense": { "type": "array", "items": { "description": "The substitute license that is used.", "$ref": "#/components/schemas/license.SubstituteLicense", "readOnly": true, "x-omitempty": true }, "nullable": true }, "TrialAdmin": { "description": "The administrative state of the trial license.\nWhen the LicenseState is set to 'NotLicensed', 'trialAdmin' can be set to true to start the trial period,\ni.e. licenseState is set to be TrialPeriod.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "AccountLicenseData": { "$ref": "#/components/schemas/license.AccountLicenseData.Relationship", "description": "A reference to a licenseAccountLicenseData resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." } } } ] }, "license.LicenseInfo.List": { "title": "List of 'license.LicenseInfo' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'license.LicenseInfo' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'license.LicenseInfo' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/license.LicenseInfo" }, "nullable": true } } } ] }, "license.LicenseInfoView.Response": { "description": "The response body of a HTTP GET request for the 'license.LicenseInfoView' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'license.LicenseInfoView' resources.", "x-one-of-name": "license.LicenseInfoView.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/license.LicenseInfoView.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "license.LicenseInfoView.Relationship": { "description": "A relationship to the 'license.LicenseInfoView' resource, or the expanded 'license.LicenseInfoView' resource, or the 'null' value.", "x-one-of-name": "license.LicenseInfoView.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/license.LicenseInfoView" } ], "discriminator": { "propertyName": "ClassId" } }, "license.LicenseInfoView": { "title": "License:License Info View", "description": "The LicenseInfoView object provides a custom view for license information, designed to be displayed by user interfaces, enhancing user experience and information accessibility.\n#### Purpose\nLicenseInfoView serves as a presentation layer for license information, offering structured views that enhance the user's ability to access and understand licensing data.\n#### Key Concepts\n- **Custom View Creation:** Facilitates the creation of tailored views for license information, ensuring data is presented in an accessible and user-friendly manner.\n- **UI Integration:** Designed for integration with user interfaces, providing seamless access to licensing data.\n- **Information Accessibility:** Enhances the ability of users to access and interpret license information, supporting informed decision-making.\n- **Organizational Resource:** Operates within shared organizational contexts, ensuring consistent presentation across different accounts and user roles.", "x-allOf-name": "license.LicenseInfoView", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'license.LicenseInfoView', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "license.LicenseInfoView" ], "default": "license.LicenseInfoView", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "license.LicenseInfoView" ], "default": "license.LicenseInfoView", "x-enum-as-string": true }, "AccountLicenseData": { "$ref": "#/components/schemas/license.AccountLicenseData.Relationship", "description": "A reference to a licenseAccountLicenseData resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." } } } ] }, "license.LicenseInfoView.List": { "title": "List of 'license.LicenseInfoView' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'license.LicenseInfoView' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'license.LicenseInfoView' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/license.LicenseInfoView" }, "nullable": true } } } ] }, "license.LicenseRegistrationStatus.Response": { "description": "The response body of a HTTP GET request for the 'license.LicenseRegistrationStatus' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'license.LicenseRegistrationStatus' resources.", "x-one-of-name": "license.LicenseRegistrationStatus.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/license.LicenseRegistrationStatus.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "license.LicenseRegistrationStatus.Relationship": { "description": "A relationship to the 'license.LicenseRegistrationStatus' resource, or the expanded 'license.LicenseRegistrationStatus' resource, or the 'null' value.", "x-one-of-name": "license.LicenseRegistrationStatus.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/license.LicenseRegistrationStatus" } ], "discriminator": { "propertyName": "ClassId" } }, "license.LicenseRegistrationStatus": { "title": "License:License Registration Status", "description": "The LicenseRegistrationStatus object is essential for monitoring the current step of license registration status, offering insights into registration flows and completion states.\n#### Purpose\nLicenseRegistrationStatus provides visibility into the stages of license registration, allowing users to track progress and manage registration flows effectively.\n#### Key Concepts\n- **Registration Monitoring:** Centralizes tracking of registration status, offering insights into current flow and completion stages.\n- **Trial Completion Tracking:** Supports monitoring of trial registration completion, ensuring users can manage trial flows effectively.\n- **Account Status Visibility:** Provides information on new account statuses, supporting UI theme upgrades and user experience enhancements.\n- **Organizational Resource:** Designed to operate within shared organizational contexts, ensuring consistent tracking across different accounts and user roles.", "x-allOf-name": "license.LicenseRegistrationStatus", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'license.LicenseRegistrationStatus', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "license.LicenseRegistrationStatus" ], "default": "license.LicenseRegistrationStatus", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "license.LicenseRegistrationStatus" ], "default": "license.LicenseRegistrationStatus", "x-enum-as-string": true }, "AccountCreationState": { "description": "Stores information on whether account has gone through the registration wizard. True if has not.", "type": "boolean", "x-omitempty": true }, "IsNewAccount": { "description": "Stores information on whether account is new. This data is used for UI theme upgrade, where existing users will be shown a slightly different screen. True if new.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "LicenseRegistrationState": { "description": "Stores information on the current flow of license registration.\n* `RegistrationNotStarted` - The license registration state to chose between trial and registration.\n* `RegistrationStarted` - The license registration state during set up flow.\n* `RegistrationComplete` - The license registration state after completion.", "type": "string", "enum": [ "RegistrationNotStarted", "RegistrationStarted", "RegistrationComplete" ], "default": "RegistrationNotStarted", "x-omitempty": true }, "TrialRegistrationComplete": { "description": "Stores information on whether trial flow has been completed. True if trial registration finish.", "type": "boolean", "x-omitempty": true }, "AccountLicenseData": { "$ref": "#/components/schemas/license.AccountLicenseData.Relationship", "description": "A reference to a licenseAccountLicenseData resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." } } } ] }, "license.LicenseRegistrationStatus.List": { "title": "List of 'license.LicenseRegistrationStatus' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'license.LicenseRegistrationStatus' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'license.LicenseRegistrationStatus' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/license.LicenseRegistrationStatus" }, "nullable": true } } } ] }, "license.LicenseReservationOp.Response": { "description": "The response body of a HTTP GET request for the 'license.LicenseReservationOp' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'license.LicenseReservationOp' resources.", "x-one-of-name": "license.LicenseReservationOp.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/license.LicenseReservationOp.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "license.LicenseReservationOp": { "title": "License:License Reservation Op", "description": "Customer operation object to request reservation code.", "x-allOf-name": "license.LicenseReservationOp", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'license.LicenseReservationOp', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "license.LicenseReservationOp" ], "default": "license.LicenseReservationOp", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "license.LicenseReservationOp" ], "default": "license.LicenseReservationOp", "x-enum-as-string": true }, "AuthCode": { "description": "Revervation code used to install the license.", "type": "string", "x-omitempty": true }, "AuthCodeInstalled": { "description": "Flag to indicate whether authorization code is installed.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "ConfirmCode": { "description": "Confirm code used to complete the license update on smart license account.", "type": "string", "readOnly": true, "x-omitempty": true }, "GenerateRequestCode": { "description": "Trigger the generation of request code for specific license reservation.", "type": "boolean", "x-omitempty": true }, "GenerateReturnCode": { "description": "Trigger the generation of return code for specific license reservation.", "type": "boolean", "x-omitempty": true }, "RequestCode": { "description": "Revervation code used to generate authorization code from CSSM.", "type": "string", "readOnly": true, "x-omitempty": true }, "ReturnCode": { "description": "Return code used to return the reserved license to smart license account.", "type": "string", "readOnly": true, "x-omitempty": true }, "Account": { "$ref": "#/components/schemas/iam.Account.Relationship", "description": "A reference to a iamAccount resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "license.LicenseReservationOp.List": { "title": "List of 'license.LicenseReservationOp' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'license.LicenseReservationOp' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'license.LicenseReservationOp' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/license.LicenseReservationOp" }, "nullable": true } } } ] }, "license.SmartlicenseToken.Response": { "description": "The response body of a HTTP GET request for the 'license.SmartlicenseToken' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'license.SmartlicenseToken' resources.", "x-one-of-name": "license.SmartlicenseToken.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/license.SmartlicenseToken.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "license.SmartlicenseToken.Relationship": { "description": "A relationship to the 'license.SmartlicenseToken' resource, or the expanded 'license.SmartlicenseToken' resource, or the 'null' value.", "x-one-of-name": "license.SmartlicenseToken.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/license.SmartlicenseToken" } ], "discriminator": { "propertyName": "ClassId" } }, "license.SmartlicenseToken": { "title": "License:Smartlicense Token", "description": "The SmartlicenseToken object manages the collection of license registration tokens, ensuring secure and efficient handling of licensing credentials.\n#### Purpose\nSmartlicenseToken serves as the repository for license registration tokens, providing mechanisms for secure storage and retrieval of licensing credentials.\n#### Key Concepts\n- **Token Management:** Centralizes storage and management of license registration tokens, ensuring secure handling of credentials.\n- **Credential Security:** Focuses on the security aspects of token management, ensuring tokens are protected and accessible only to authorized users.\n- **Organizational Resource:** Operates within shared organizational contexts, allowing consistent application across different accounts and user roles.\n- **Integration:** Designed to integrate seamlessly with licensing processes, supporting efficient registration and authorization flows.", "x-allOf-name": "license.SmartlicenseToken", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'license.SmartlicenseToken', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "license.SmartlicenseToken" ], "default": "license.SmartlicenseToken", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "license.SmartlicenseToken" ], "default": "license.SmartlicenseToken", "x-enum-as-string": true }, "Token": { "description": "Smart license registration token.", "type": "string", "x-omitempty": true }, "AccountLicenseData": { "$ref": "#/components/schemas/license.AccountLicenseData.Relationship", "description": "A reference to a licenseAccountLicenseData resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." } } } ] }, "license.SmartlicenseToken.List": { "title": "List of 'license.SmartlicenseToken' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'license.SmartlicenseToken' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'license.SmartlicenseToken' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/license.SmartlicenseToken" }, "nullable": true } } } ] }, "license.SubstituteLicense": { "title": "License:Substitute License", "description": "License tiers can be substituted with higher tiers. Will contain information on the type of license being used\nfor substitution, the number of substutions used, and the substitution type.", "x-allOf-name": "license.SubstituteLicense", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'license.SubstituteLicense', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "license.SubstituteLicense" ], "default": "license.SubstituteLicense", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "license.SubstituteLicense" ], "default": "license.SubstituteLicense", "x-enum-as-string": true }, "SubstitutedLicense": { "description": "The substitute license that is used.", "type": "string", "readOnly": true, "x-omitempty": true }, "SubstitutedQuantity": { "description": "The number of substitute licenses that are used.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "SubstitutionType": { "description": "The substitution from lower or from higher tier.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "meraki.Device.Response": { "description": "The response body of a HTTP GET request for the 'meraki.Device' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'meraki.Device' resources.", "x-one-of-name": "meraki.Device.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/meraki.Device.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "meraki.Device.Relationship": { "description": "A relationship to the 'meraki.Device' resource, or the expanded 'meraki.Device' resource, or the 'null' value.", "x-one-of-name": "meraki.Device.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/meraki.Device" } ], "discriminator": { "propertyName": "ClassId" } }, "meraki.Device": { "title": "Meraki:Device", "description": "A device belonging to a organization's network.", "x-allOf-name": "meraki.Device", "allOf": [ { "$ref": "intersight-server-v3-1.0.11-20260807064027971.json#/components/schemas/equipment.AbstractDevice" }, { "type": "object", "description": "Definition of the list of properties defined in 'meraki.Device', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "meraki.Device" ], "default": "meraki.Device", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "meraki.Device" ], "default": "meraki.Device", "x-enum-as-string": true }, "LanIp": { "description": "LAN IP address of the device.", "type": "string", "readOnly": true, "x-omitempty": true }, "Mac": { "description": "The MAC address of the device.", "type": "string", "readOnly": true, "x-omitempty": true }, "NetworkId": { "description": "The network the device belongs to.", "type": "string", "readOnly": true, "x-omitempty": true }, "Network": { "$ref": "#/components/schemas/meraki.Network.Relationship", "description": "A reference to a merakiNetwork resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "meraki.Device.List": { "title": "List of 'meraki.Device' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'meraki.Device' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'meraki.Device' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/meraki.Device" }, "nullable": true } } } ] }, "meraki.Network.Response": { "description": "The response body of a HTTP GET request for the 'meraki.Network' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'meraki.Network' resources.", "x-one-of-name": "meraki.Network.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/meraki.Network.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "meraki.Network.Relationship": { "description": "A relationship to the 'meraki.Network' resource, or the expanded 'meraki.Network' resource, or the 'null' value.", "x-one-of-name": "meraki.Network.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/meraki.Network" } ], "discriminator": { "propertyName": "ClassId" } }, "meraki.Network": { "title": "Meraki:Network", "description": "A network belonging to an organization.", "x-allOf-name": "meraki.Network", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'meraki.Network', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "meraki.Network" ], "default": "meraki.Network", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "meraki.Network" ], "default": "meraki.Network", "x-enum-as-string": true }, "Name": { "description": "The Meraki network name seamlessly uniting devices for effortless connectivity.", "type": "string", "readOnly": true, "x-omitempty": true }, "NetworkId": { "description": "The unique Meraki network id.", "type": "string", "readOnly": true, "x-omitempty": true }, "NetworkTags": { "type": "array", "items": { "description": "A list of tags applied to the network.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "OrganizationId": { "description": "The unique Meraki organization id.", "type": "string", "readOnly": true, "x-omitempty": true }, "ProductTypes": { "type": "array", "items": { "description": "Product type. example types are appliance and switch.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Organization": { "$ref": "#/components/schemas/meraki.Organization.Relationship", "description": "A reference to a merakiOrganization resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "meraki.Network.List": { "title": "List of 'meraki.Network' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'meraki.Network' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'meraki.Network' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/meraki.Network" }, "nullable": true } } } ] }, "meraki.Organization.Response": { "description": "The response body of a HTTP GET request for the 'meraki.Organization' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'meraki.Organization' resources.", "x-one-of-name": "meraki.Organization.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/meraki.Organization.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "meraki.Organization.Relationship": { "description": "A relationship to the 'meraki.Organization' resource, or the expanded 'meraki.Organization' resource, or the 'null' value.", "x-one-of-name": "meraki.Organization.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/meraki.Organization" } ], "discriminator": { "propertyName": "ClassId" } }, "meraki.Organization": { "title": "Meraki:Organization", "description": "Meraki organization which leverages Meraki's cloud-managed networking solutions > to streamline and enhance its IT infrastructure.", "x-allOf-name": "meraki.Organization", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'meraki.Organization', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "meraki.Organization" ], "default": "meraki.Organization", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "meraki.Organization" ], "default": "meraki.Organization", "x-enum-as-string": true }, "Name": { "description": "The Meraki organization name.", "type": "string", "readOnly": true, "x-omitempty": true }, "OrganizationId": { "description": "The Meraki organization id.", "type": "string", "readOnly": true, "x-omitempty": true }, "RegisteredDevice": { "$ref": "#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "meraki.Organization.List": { "title": "List of 'meraki.Organization' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'meraki.Organization' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'meraki.Organization' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/meraki.Organization" }, "nullable": true } } } ] }, "meraki.PortProfile.Response": { "description": "The response body of a HTTP GET request for the 'meraki.PortProfile' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'meraki.PortProfile' resources.", "x-one-of-name": "meraki.PortProfile.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/meraki.PortProfile.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "meraki.PortProfile": { "title": "Meraki:Port Profile", "description": "A switch port configuration profile belonging to an organization.", "x-allOf-name": "meraki.PortProfile", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'meraki.PortProfile', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "meraki.PortProfile" ], "default": "meraki.PortProfile", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "meraki.PortProfile" ], "default": "meraki.PortProfile", "x-enum-as-string": true }, "Name": { "description": "The name of the port profile.", "type": "string", "readOnly": true, "x-omitempty": true }, "ProfileId": { "description": "The unique identifier for the port profile.", "type": "string", "readOnly": true, "x-omitempty": true }, "RegisteredDevice": { "$ref": "#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "meraki.PortProfile.List": { "title": "List of 'meraki.PortProfile' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'meraki.PortProfile' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'meraki.PortProfile' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/meraki.PortProfile" }, "nullable": true } } } ] }, "meraki.Tag.Response": { "description": "The response body of a HTTP GET request for the 'meraki.Tag' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'meraki.Tag' resources.", "x-one-of-name": "meraki.Tag.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/meraki.Tag.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "meraki.Tag": { "title": "Meraki:Tag", "description": "Tag on different meraki entities e.g. device, network and switch port.", "x-allOf-name": "meraki.Tag", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'meraki.Tag', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "meraki.Tag" ], "default": "meraki.Tag", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "meraki.Tag" ], "default": "meraki.Tag", "x-enum-as-string": true }, "Name": { "description": "The name of the tag on different meraki entities.", "type": "string", "readOnly": true, "x-omitempty": true }, "Type": { "description": "Type of the tag on different meraki entities.\n* `unknown` - The tag type is unknown, it is used as default value.\n* `Network` - The tag belongs to Meraki network.\n* `Device` - The tag belongs to Meraki device.\n* `SwitchPort` - The tag belongs to Meraki switch port.", "type": "string", "enum": [ "unknown", "Network", "Device", "SwitchPort" ], "default": "unknown", "readOnly": true, "x-omitempty": true }, "Device": { "$ref": "#/components/schemas/meraki.Device.Relationship", "description": "A reference to a merakiDevice resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Network": { "$ref": "#/components/schemas/meraki.Network.Relationship", "description": "A reference to a merakiNetwork resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "meraki.Tag.List": { "title": "List of 'meraki.Tag' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'meraki.Tag' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'meraki.Tag' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/meraki.Tag" }, "nullable": true } } } ] }, "meta.AccessPrivilege": { "title": "Meta:Access Privilege", "description": "The required access privilege for a given Managed Object and CRUD operation.", "x-allOf-name": "meta.AccessPrivilege", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'meta.AccessPrivilege', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "meta.AccessPrivilege" ], "default": "meta.AccessPrivilege", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "meta.AccessPrivilege" ], "default": "meta.AccessPrivilege", "x-enum-as-string": true }, "Method": { "description": "The type of CRUD operation (create, read, update, delete) for which an access privilege is required.\n* `Update` - The 'update' operation/state.\n* `Create` - The 'create' operation/state.\n* `Read` - The 'read' operation/state.\n* `Delete` - The 'delete' operation/state.", "type": "string", "enum": [ "Update", "Create", "Read", "Delete" ], "default": "Update", "readOnly": true, "x-omitempty": true }, "Privilege": { "description": "The name of the privilege which is required to invoke the specified CRUD method.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "meta.Definition.Response": { "description": "The response body of a HTTP GET request for the 'meta.Definition' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'meta.Definition' resources.", "x-one-of-name": "meta.Definition.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/meta.Definition.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "meta.Definition": { "title": "Meta:Definition", "description": "The meta-data of managed objects and complex types.", "x-allOf-name": "meta.Definition", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'meta.Definition', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "meta.Definition" ], "default": "meta.Definition", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "meta.Definition" ], "default": "meta.Definition", "x-enum-as-string": true }, "AccessPrivileges": { "type": "array", "items": { "description": "The list of access privileges that are required to perform CRUD operations on this managed object. If no access privileges are specified, the object is not accessible.", "$ref": "#/components/schemas/meta.AccessPrivilege", "readOnly": true, "x-omitempty": true }, "nullable": true }, "AncestorClasses": { "type": "array", "items": { "description": "An array of parent metaclasses in the class inheritance hierarchy. The first element in the array is the parent class. The next element is the grand-parent, etc. The last element in the array is the mo.BaseMo class.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "DisplayNameMetas": { "type": "array", "items": { "description": "The user appropriate display name meta.", "$ref": "#/components/schemas/meta.DisplayNameDefinition", "readOnly": true, "x-omitempty": true }, "nullable": true }, "EnablePreviousMo": { "description": "When true, MO change events for this type include the previous (old) value of each modified field alongside the new value, so consumers (e.g. post-processing services) can see both. Implemented by enabling MongoDB change stream pre-image snapshots for the collection.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "IdentityConstraints": { "type": "array", "items": { "description": "Meta definition for the identity constraints in the meta class.", "$ref": "#/components/schemas/meta.IdentityDefinition", "readOnly": true, "x-omitempty": true }, "nullable": true }, "IsConcrete": { "description": "Boolean flag to specify whether the meta class is a concrete class or not.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "MetaType": { "description": "Indicates whether the meta class is a complex type or managed object.\n* `ManagedObject` - The meta.Definition object describes a managed object.\n* `ComplexType` - The meta.Definition object describes a nested complex type within a managed object.", "type": "string", "enum": [ "ManagedObject", "ComplexType" ], "default": "ManagedObject", "readOnly": true, "x-omitempty": true }, "Name": { "description": "The fully-qualified class name of the Managed Object or complex type. For example, \"compute:Blade\" where the Managed Object is \"Blade\" and the package is 'compute'.", "type": "string", "readOnly": true, "x-omitempty": true }, "Namespace": { "description": "The namespace of the meta.", "type": "string", "readOnly": true, "x-omitempty": true }, "Owner": { "description": "A value describing the owner for a given Managed Object, such as Account or Organization.\n* `System` - Any Managed Object with OwnerType as System is root for objects common to all accounts. Any object which inherits permissions from this object has owners as system and is common to all accounts. Objects with owner as system can only be read by user and modification is not allowed by user.\n* `Yes` - Any Managed Object with OwnerType as Yes is root for objects which need security filtering. Currently objects with owner yes are account and device registration. Any object with owner ''yes'' has self moid in owners and any objects which inherits permissions from this object has root object moid as owners. In user context, account filtering is enforced by providing access to objects with owner as account moid. In device context, device filtering is enforced by providing access to objects with owner as device moid.\n* `No` - Any Managed Object with OwnerType as No inherits base mo properties like owners, domain group moid, account moid, permission resources from inherit permission relation. Inherit permission relation could be with an object whose owner is system/organization/yes/no.\n* `Internal` - Any Managed Object with OwnerType as Internal is internal to system. Such Managed Objects cannot be accessed using REST APIs and can be created, updated or deleted in any security context.\n* `Organization` - Any Managed Object with OwnerType as Organization is contained under an organization like profiles, policies, user defined workflows. Implicitly an organization on-peer-delete relation is added in this object.", "type": "string", "enum": [ "System", "Yes", "No", "Internal", "Organization" ], "default": "System", "readOnly": true, "x-omitempty": true }, "ParentClass": { "description": "The fully-qualified name of the parent metaclass in the class inheritance hierarchy.", "type": "string", "readOnly": true, "x-omitempty": true }, "PermissionSupported": { "description": "Boolean flag to specify whether instances of this class type can be specified in permissions for instance based access control. Permissions can be created for entire Intersight account or to a subset of resources (instance based access control). In the first release, permissions are supported for entire account or for a subset of organizations.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "Properties": { "type": "array", "items": { "description": "Meta definition for the properties in the meta class and from all classes in the inheritance hierarchy.", "$ref": "#/components/schemas/meta.PropDefinition", "readOnly": true, "x-omitempty": true }, "nullable": true }, "RbacResource": { "description": "Boolean flag to specify whether instances of this class type can be assigned to resource groups that are part of an organization for access control. Inventoried physical/logical objects which needs access control should have rbacResource=true. These objects are not part of any organization by default like device registrations and should be assigned to organizations for access control. Profiles, policies, workflow definitions which are created by specifying organization need not have this flag set.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "Relationships": { "type": "array", "items": { "description": "Meta definition for the relationship in the meta class.", "$ref": "#/components/schemas/meta.RelationshipDefinition", "readOnly": true, "x-omitempty": true }, "nullable": true }, "ResourcePoolTypes": { "type": "array", "items": { "description": "A collection of Pool types. When the collection contains any value, it means a ResourcePool of the current MO or its child MO can be created with given Pool type. Consider for example, if there is a requirement to support pool creation for Virtual Machines, then we shall add this property for VirtualMachine MO with an appropriate pool name to represent the Virtual Machine pool in the UI.\nResourcePoolTypes = \"Virtual Machine\"\nThe newly added pool type \"Virtual Machine\" needs to be updated in Malibu's ResourceType enum. While creating the resource pool, UI will list the supported pool types specified in this enum. Once the pool type is selected, the MOs updated with the matching ResourcePoolType property will be listed for selection to create the pool.\nThe same ResourcePoolType name can be used for more than one MOs. Consider as an example, RackUnit and Blade MOs can be grouped under a pool type called 'Server'. Also this can be used at abstract class as well. For example, compute.Physical is abstract class for compute.RackUnit and compute.Blade; so, instead of adding this property at compute.Blade and compute.RackUnit, it can be added at abstract class level, which is compute.Physical.\nResourcePoolTypes property of an MO can hold one or more values. Consider compute.RackUnit MO can be considered for creating two distinct type of pools - say, Server Pool and Rack Server Pool. In this case, we need to update the ResourcePoolTypes property as below:\nResourcePoolTypes = \"Server, Rack Server\".", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "RestPath": { "description": "Restful URL path for the meta.", "type": "string", "readOnly": true, "x-omitempty": true }, "Version": { "description": "The version of the service that defines the meta-data.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "meta.Definition.List": { "title": "List of 'meta.Definition' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'meta.Definition' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'meta.Definition' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/meta.Definition" }, "nullable": true } } } ] }, "meta.DisplayNameDefinition": { "title": "Meta:Display Name Definition", "description": "A rule for constructing user appropriate names for MO instances using the fields of the MO instance and MOs in its Ancestors hierarchy.", "x-allOf-name": "meta.DisplayNameDefinition", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'meta.DisplayNameDefinition', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "meta.DisplayNameDefinition" ], "default": "meta.DisplayNameDefinition", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "meta.DisplayNameDefinition" ], "default": "meta.DisplayNameDefinition", "x-enum-as-string": true }, "Format": { "description": "A specification for constructing the displayname from the MO's properties.", "type": "string", "readOnly": true, "x-omitempty": true }, "IncludeAncestor": { "description": "An indication of whether the displayname should be contructed 'recursively' including the displayname of the first ancestor with a similarly named displayname.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "Name": { "description": "The name of the displayname used as a key in the DisplayName map which is returned as part of an MO for a Rest request.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "meta.IdentityDefinition": { "title": "Meta:Identity Definition", "description": "Definitions for the identity constraints in meta.", "x-allOf-name": "meta.IdentityDefinition", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'meta.IdentityDefinition', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "meta.IdentityDefinition" ], "default": "meta.IdentityDefinition", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "meta.IdentityDefinition" ], "default": "meta.IdentityDefinition", "x-enum-as-string": true }, "Fields": { "type": "array", "items": { "description": "Array of fields that uniquely identify the managed object.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true } } } ] }, "meta.PropDefinition": { "title": "Meta:Prop Definition", "description": "Definitions for the properties in a meta.", "x-allOf-name": "meta.PropDefinition", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'meta.PropDefinition', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "meta.PropDefinition" ], "default": "meta.PropDefinition", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "meta.PropDefinition" ], "default": "meta.PropDefinition", "x-enum-as-string": true }, "ApiAccess": { "description": "API access control for the property. Examples are NoAccess, ReadOnly, CreateOnly etc.\n* `NoAccess` - The property is not accessible from the API.\n* `ReadOnly` - The value of the property is read-only.An HTTP 4xx status code is returned when the user sends a POST/PUT/PATCH request that containsa ReadOnly property.\n* `CreateOnly` - The value of the property can be set when the REST resource is created. It cannot be changed after object creation.An HTTP 4xx status code is returned when the user sends a POST/PUT/PATCH request that containsa CreateOnly property.CreateOnly properties are returned in the response body of HTTP GET requests.\n* `ReadWrite` - The property has read/write access.\n* `WriteOnly` - The value of the property can be set but it is never returned in the response body of supported HTTP methods.This settings is used for sensitive properties such as passwords.\n* `ReadOnCreate` - The value of the property is returned in the HTTP POST response body when the REST resource is created.The property is not writeable and cannot be queried through a GET request after the resource has been created.", "type": "string", "enum": [ "NoAccess", "ReadOnly", "CreateOnly", "ReadWrite", "WriteOnly", "ReadOnCreate" ], "default": "NoAccess", "readOnly": true, "x-omitempty": true }, "Default": { "description": "The default value of the property. Not applicable when IsComplexType is True.", "nullable": true, "readOnly": true, "x-omitempty": true }, "IsCollection": { "description": "Indicates whether the property is a collection (i.e. a JSON array), otherwise it is a single value.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "IsComplexType": { "description": "Indicates whether the property is a complex type, otherwise it is a basic scalar type.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "Kind": { "description": "The kind of the property.\n* `Unknown` - The property kind is unknown.\n* `Boolean` - The 'Boolean' kind of property.\n* `String` - The 'String' kind of property.\n* `Integer` - The 'Integer' kind of property.\n* `Int32` - The 'Int32' kind of property.\n* `Int64` - The 'Int64' kind of property.\n* `Float` - The 'Float' kind of property.\n* `Double` - The 'Double' kind of property.\n* `Date` - The 'Date' kind of property.\n* `Duration` - The 'Duration' kind of property.\n* `Time` - The 'Time' kind of property.\n* `Json` - The 'JSON' kind of property.\n* `Binary` - The 'Binary' kind of property.\n* `EnumString` - The 'EnumString' kind of property.\n* `EnumInteger` - The 'EnumInteger' kind of property.\n* `ComplexType` - The 'ComplexType' kind of property.", "type": "string", "enum": [ "Unknown", "Boolean", "String", "Integer", "Int32", "Int64", "Float", "Double", "Date", "Duration", "Time", "Json", "Binary", "EnumString", "EnumInteger", "ComplexType" ], "default": "Unknown", "readOnly": true, "x-omitempty": true }, "Name": { "description": "The name of the property.", "type": "string", "readOnly": true, "x-omitempty": true }, "OpSecurity": { "description": "The data-at-rest security protection applied to this property when a Managed Object is persisted.\nFor example, Encrypted or Cleartext.\n* `ClearText` - Data at rest is not encrypted using account specific keys.Note that data is always protected using volume encryption. ClearText propertiesare queryable and searchable.\n* `Encrypted` - The value of the property is encrypted with account-specific cryptographic keys.This setting is used for properties that contain sensitive data. Encrypted propertiesare not queryable and searchable.\n* `Pbkdf2` - The value of the property is hashed using the pbkdf2 key derivation functions thattakes a password, a salt, and a cost factor as inputs then generates a password hash.Its purpose is to make each password guessing trial by an attacker who has obtaineda password hash file expensive and therefore the cost of a guessing attack high or prohibitive.\n* `Bcrypt` - The value of the property is hashed using the bcrypt key derivation function.\n* `Sha512crypt` - The value of the property is hashed using the sha512crypt key derivation function.\n* `Argon2id` - The value of the property is hashed using the argon2id key derivation function.", "type": "string", "enum": [ "ClearText", "Encrypted", "Pbkdf2", "Bcrypt", "Sha512crypt", "Argon2id" ], "default": "ClearText", "readOnly": true, "x-omitempty": true }, "SearchWeight": { "description": "Enables the property to be searchable from global search. A value of 0 means this property is not globally searchable.", "type": "number", "format": "float", "readOnly": true, "x-omitempty": true }, "Type": { "description": "The type of the property. In case of collection properties the type is that of individual elements.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "meta.RelationshipDefinition": { "title": "Meta:Relationship Definition", "description": "Definitions for the relationship in a meta.", "x-allOf-name": "meta.RelationshipDefinition", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'meta.RelationshipDefinition', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "meta.RelationshipDefinition" ], "default": "meta.RelationshipDefinition", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "meta.RelationshipDefinition" ], "default": "meta.RelationshipDefinition", "x-enum-as-string": true }, "ApiAccess": { "description": "API access definition for this relationship.\n* `NoAccess` - The property is not accessible from the API.\n* `ReadOnly` - The value of the property is read-only.An HTTP 4xx status code is returned when the user sends a POST/PUT/PATCH request that containsa ReadOnly property.\n* `CreateOnly` - The value of the property can be set when the REST resource is created. It cannot be changed after object creation.An HTTP 4xx status code is returned when the user sends a POST/PUT/PATCH request that containsa CreateOnly property.CreateOnly properties are returned in the response body of HTTP GET requests.\n* `ReadWrite` - The property has read/write access.\n* `WriteOnly` - The value of the property can be set but it is never returned in the response body of supported HTTP methods.This settings is used for sensitive properties such as passwords.\n* `ReadOnCreate` - The value of the property is returned in the HTTP POST response body when the REST resource is created.The property is not writeable and cannot be queried through a GET request after the resource has been created.", "type": "string", "enum": [ "NoAccess", "ReadOnly", "CreateOnly", "ReadWrite", "WriteOnly", "ReadOnCreate" ], "default": "NoAccess", "readOnly": true, "x-omitempty": true }, "Collection": { "description": "Specifies whether the relationship is a collection.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "Export": { "description": "When turned off, the peer MO is not exported when the local MO is exported.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "ExportWithPeer": { "description": "When turned on, the local MO is exported when the peer is exported.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "Name": { "description": "The name of the relationship.", "type": "string", "readOnly": true, "x-omitempty": true }, "OnDelete": { "description": "The action to perform on the peer MO when the local MO is deleted.\n* `Unset` - Any relationship from the peer managed object to the managed object being deleted is unset.\n* `Cascade` - The peer managed object is deleted.\n* `Prohibit` - The deletion is prevented when the relationship is set.\n* `Ignore` - No action is performed on the relationship value or the peer managed object of the relationship.", "type": "string", "enum": [ "Unset", "Cascade", "Prohibit", "Ignore" ], "default": "Unset", "readOnly": true, "x-omitempty": true }, "OnPeerDelete": { "description": "The action to perform on the local MO when the peer MO is deleted.\n* `Unset` - Any relationship from the peer managed object to the managed object being deleted is unset.\n* `Cascade` - The peer managed object is deleted.\n* `Prohibit` - The deletion is prevented when the relationship is set.\n* `Ignore` - No action is performed on the relationship value or the peer managed object of the relationship.", "type": "string", "enum": [ "Unset", "Cascade", "Prohibit", "Ignore" ], "default": "Unset", "readOnly": true, "x-omitempty": true }, "PeerRelName": { "description": "Name of relationship in peer managed object.", "type": "string", "readOnly": true, "x-omitempty": true }, "PeerSupportedObjectTypes": { "type": "array", "items": { "description": "The list of supported object types for the peer MO.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "PeerSync": { "description": "When turned on, peer MO corresponding to the reference provided in relation is updated with a reference to the current MO.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "Type": { "description": "Fully qualified type of the peer managed object.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "notification.AbstractAdvisoryFilter": { "title": "Notification:Abstract Advisory Filter", "description": "Filter for a specific advisory type with selected severities and optional CVSS score filtering.", "x-allOf-name": "notification.AbstractAdvisoryFilter", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" } ] }, "notification.AbstractCondition": { "title": "Notification:Abstract Condition", "description": "AbstractCondition is a base abstract class for all types of conditions for notification.Subscription Mo.\nAll conditions types inherit from this base type. It describes the match criteria (condition) for the subscription.\nAbstract type to be used as a condition for notification.Subscription object.\nGives the ability to change add different conditions types in the model without\ndrastic changes to the model itself.", "x-allOf-name": "notification.AbstractCondition", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" } ] }, "notification.AbstractMoCondition": { "title": "Notification:Abstract Mo Condition", "description": "This condition type gives the ability to subscribe to the cond.Alarm ObjectType and provide\na list of Severities you're interested in.", "x-allOf-name": "notification.AbstractMoCondition", "allOf": [ { "$ref": "#/components/schemas/notification.AbstractCondition" }, { "type": "object", "description": "Definition of the list of properties defined in 'notification.AbstractMoCondition', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "notification.AdvisoryMoCondition", "notification.AlarmMoCondition", "notification.ApplianceUpgradeMoCondition", "notification.DistributableMoCondition", "notification.MoCondition", "notification.SimpleMoCondition", "notification.SoftwareReleaseMetaMoCondition" ], "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "notification.AdvisoryMoCondition", "notification.AlarmMoCondition", "notification.ApplianceUpgradeMoCondition", "notification.DistributableMoCondition", "notification.MoCondition", "notification.SimpleMoCondition", "notification.SoftwareReleaseMetaMoCondition" ], "x-enum-as-string": true }, "Enabled": { "description": "The condition can be switched on/off with out necessity to change the subscription\nsettings: actions, conditions, etc.\nEx.: Subscription MO can be configured, but switched off.", "type": "boolean", "default": true, "x-omitempty": true }, "MoType": { "description": "MoType for which the condition is created.", "type": "string", "x-omitempty": true }, "Operations": { "type": "array", "items": { "description": "The type of change (create, update, delete) performed on the MO.\n* `None` - The 'none' operation/state.Indicates a configuration profile has been deployed, and the desired configuration matches the actual device configuration.\n* `Created` - The 'create' operation/state.Indicates a configuration profile has been created and associated with a device, but the configuration specified in the profilehas not been applied yet. For example, this could happen when the user creates a server profile and has not deployed the profile yet.\n* `Modified` - The 'update' operation/state.Indicates some of the desired configuration changes specified in a profile have not been been applied to the associated device.This happens when the user has made changes to a profile and has not deployed the changes yet, or when the workflow to applythe configuration changes has not completed successfully.\n* `Deleted` - The 'delete' operation/state.Indicates a configuration profile has been been disassociated from a device and the user has not undeployed these changes yet.", "type": "string", "enum": [ "None", "Created", "Modified", "Deleted" ], "default": "None", "x-omitempty": true }, "nullable": true } } } ] }, "notification.AccountSubscription.Response": { "description": "The response body of a HTTP GET request for the 'notification.AccountSubscription' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'notification.AccountSubscription' resources.", "x-one-of-name": "notification.AccountSubscription.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/notification.AccountSubscription.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "notification.AccountSubscription": { "title": "Notification:Account Subscription", "description": "The AccountSubscription object is a crucial component of the Intersight notification framework, designed to facilitate account-level subscriptions managed by Account Administrators. This provides a structured way to handle notifications based on specific events within an account, ensuring administrators can effectively configure and manage subscription settings.\n#### Purpose\nThe AccountSubscription object enables administrators to set up notifications for various account events. It serves as the blueprint for creating, updating, and managing subscriptions, ensuring that notifications are sent according to predefined conditions and actions.\n#### Key Concepts\n- **Account-Level Management:** Designed for account administrators, allowing easy configuration of subscription settings at the account level.\n- **Integration with Notification Methods:** Supports multiple notification methods such as email and webhook to meet diverse requirements.\n- **Conditional Notifications:** Allows definition of conditions that trigger notifications, ensuring only relevant alerts are sent.\n- **Access Control:** Enforces privilege sets so only authorized users can create, update, or delete subscriptions, maintaining security and integrity.\n- **Flexibility and Scalability:** Scales notification features to support complex use cases and evolving business needs.", "x-allOf-name": "notification.AccountSubscription", "allOf": [ { "$ref": "#/components/schemas/notification.Subscription" }, { "type": "object", "description": "Definition of the list of properties defined in 'notification.AccountSubscription', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "notification.AccountSubscription" ], "default": "notification.AccountSubscription", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "notification.AccountSubscription" ], "default": "notification.AccountSubscription", "x-enum-as-string": true }, "Description": { "description": "The description for the subscription.", "type": "string", "pattern": "^$|^[a-zA-Z0-9_.\\- ]{1,128}$", "x-omitempty": true }, "Name": { "description": "The name of the subscription.", "type": "string", "pattern": "^[a-zA-Z0-9_.-]{1,64}$", "x-omitempty": true }, "Type": { "description": "The chosen subscription type imposes it is own validation rules.\nWhen 'email' type is chosen, actions array can contain only one entry and it is entry should be of can\nbe only notification.SendEmail; conditions can contain only notification.AlarmMoCondition and condition\ntypes should be unique.\nWhen the 'webhook' type is chosen, the actions array can contain only one entry and it is entry should be of can\nbe only notification.TriggerWebhook; conditions can contain up to a limited amount of entries and all of them\nshould be of type notification.MoCondition.\n* `email` - Email type requires usage of notification.SendEmail complex types for actionsand notification.AlarmMoCondition complex types for conditions.\n* `webhook` - Webhook type requires usage of notification.TriggerWebhook complex types for actionsand notification.MoCondition complex types for conditions.", "type": "string", "enum": [ "email", "webhook" ], "default": "email", "x-createOnly": true, "x-omitempty": true }, "Verify": { "description": "Used to verify the actions of the Subscription MO. For a 'webhook' type Ping event is sent to verify\nthat the webhook server is accessible. For an 'email' type there will be a verification email sent.\n* `none` - No actions will be verified. Default value.\n* `all` - All actions will be re-verified. The previous state of the verification will be preserved.", "type": "string", "enum": [ "none", "all" ], "default": "none", "x-omitempty": true }, "Account": { "$ref": "#/components/schemas/iam.Account.Relationship", "description": "A reference to a iamAccount resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Certificate": { "$ref": "#/components/schemas/iam.TrustPoint.Relationship", "description": "A reference to a iamTrustPoint resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "FilterRefs": { "description": "An array of relationships to moBaseMo resources.", "type": "array", "items": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo.Relationship" }, "nullable": true, "readOnly": true } } } ] }, "notification.AccountSubscription.List": { "title": "List of 'notification.AccountSubscription' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'notification.AccountSubscription' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'notification.AccountSubscription' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/notification.AccountSubscription" }, "nullable": true } } } ] }, "notification.Action": { "title": "Notification:Action", "description": "Action abstract complex type describes the action the framework should perform when the event matched\nwith a specific subscription is found. Ex.: Send Email, Send Mobile Push, Publish to a specific topic, etc.", "x-allOf-name": "notification.Action", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" } ] }, "notification.AdvisoryMoCondition": { "title": "Notification:Advisory Mo Condition", "description": "This condition type gives the ability to subscribe to the tam.AdvisoryInstance ObjectType and provide\na list of Advisory Types you're interested in.", "x-allOf-name": "notification.AdvisoryMoCondition", "allOf": [ { "$ref": "#/components/schemas/notification.AbstractMoCondition" }, { "type": "object", "description": "Definition of the list of properties defined in 'notification.AdvisoryMoCondition', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "notification.AdvisoryMoCondition" ], "default": "notification.AdvisoryMoCondition", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "notification.AdvisoryMoCondition" ], "default": "notification.AdvisoryMoCondition", "x-enum-as-string": true }, "AdvisoryFilters": { "type": "array", "items": { "description": "List of Advisory Types on which user wants to receive notifications.\nThe list of exposed advisory types is Security, Field Notice, and End of Life.", "$ref": "#/components/schemas/notification.AbstractAdvisoryFilter", "x-omitempty": true }, "nullable": true }, "OdataFilter": { "description": "Odata filter string managed internally. It is built with specific ObjectType properties.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "notification.AggregationSettings": { "title": "Notification:Aggregation Settings", "description": "Settings for events grouping.", "x-allOf-name": "notification.AggregationSettings", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'notification.AggregationSettings', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "notification.AggregationSettings" ], "default": "notification.AggregationSettings", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "notification.AggregationSettings" ], "default": "notification.AggregationSettings", "x-enum-as-string": true }, "Enabled": { "description": "Show if aggregation is enabled or not. If aggregation is enabled, events will be grouped and delivered\nas one notification, if it is disabled - each event will be delivered as independent notification.", "type": "boolean", "x-omitempty": true }, "EventsLimit": { "description": "Limit of events in one group. If this limit is reached, a window will be closed regardless of the time limit.", "type": "integer", "format": "int64", "x-omitempty": true }, "Size": { "description": "Time in seconds which means the max time after which the window will be closed.", "type": "string", "x-omitempty": true }, "Step": { "description": "Time in seconds which means how long after the last event Intersight should wait for the next event to come.\nIf there's no new event that matches with the same Subscription within this time, then the window will be closed.", "type": "string", "x-omitempty": true } } } ] }, "notification.AlarmMoCondition": { "title": "Notification:Alarm Mo Condition", "description": "This condition type gives the ability to subscribe to the cond.Alarm ObjectType and provide\na list of Severities you're interested in.", "x-allOf-name": "notification.AlarmMoCondition", "allOf": [ { "$ref": "#/components/schemas/notification.AbstractMoCondition" }, { "type": "object", "description": "Definition of the list of properties defined in 'notification.AlarmMoCondition', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "notification.AlarmMoCondition" ], "default": "notification.AlarmMoCondition", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "notification.AlarmMoCondition" ], "default": "notification.AlarmMoCondition", "x-enum-as-string": true }, "OdataFilter": { "description": "Odata filter string managed internally. It is built with specific ObjectType properties.", "type": "string", "readOnly": true, "x-omitempty": true }, "Severity": { "type": "array", "items": { "description": "List of Severities on which user wants to receive notifications.\nThe list of exposed severities is Info, Critical, Warning.\n* `None` - The Enum value None represents that there is no severity.\n* `Info` - The Enum value Info represents the Informational level of severity.\n* `Critical` - The Enum value Critical represents the Critical level of severity.\n* `Warning` - The Enum value Warning represents the Warning level of severity.\n* `Cleared` - The Enum value Cleared represents that the alarm severity has been cleared.", "type": "string", "enum": [ "None", "Info", "Critical", "Warning", "Cleared" ], "default": "None", "x-omitempty": true }, "nullable": true } } } ] }, "notification.ApplianceUpgradeMoCondition": { "title": "Notification:Appliance Upgrade Mo Condition", "description": "This condition type gives the ability to subscribe to the appliance.Upgrade ObjectType and provide a list of Image statuses you're interested in.", "x-allOf-name": "notification.ApplianceUpgradeMoCondition", "allOf": [ { "$ref": "#/components/schemas/notification.AbstractMoCondition" }, { "type": "object", "description": "Definition of the list of properties defined in 'notification.ApplianceUpgradeMoCondition', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "notification.ApplianceUpgradeMoCondition" ], "default": "notification.ApplianceUpgradeMoCondition", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "notification.ApplianceUpgradeMoCondition" ], "default": "notification.ApplianceUpgradeMoCondition", "x-enum-as-string": true }, "OdataFilter": { "description": "Odata filter string managed internally. It is built with specific ObjectType properties.", "type": "string", "readOnly": true, "x-omitempty": true }, "Statuses": { "type": "array", "items": { "description": "List of Appliance Image Statuses for which user wants to receive notifications.\n* `None` - Default value for ImageStatus enum.\n* `InstallPending` - InstallPending status means the image is downloaded and available for installation on appliance.\n* `InstallComplete` - InstallComplete status means the image installation task has been completed. It includes both success and failure case.", "type": "string", "enum": [ "None", "InstallPending", "InstallComplete" ], "default": "None", "x-omitempty": true }, "nullable": true } } } ] }, "notification.DistributableMoCondition": { "title": "Notification:Distributable Mo Condition", "description": "This condition type gives the ability to subscribe to the software.HyperflexBundleDistributable or firmware.Distributable or appliance.ApplianceDistributable\nor software.HciBundleDistributable ObjectType.", "x-allOf-name": "notification.DistributableMoCondition", "allOf": [ { "$ref": "#/components/schemas/notification.AbstractMoCondition" }, { "type": "object", "description": "Definition of the list of properties defined in 'notification.DistributableMoCondition', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "notification.DistributableMoCondition" ], "default": "notification.DistributableMoCondition", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "notification.DistributableMoCondition" ], "default": "notification.DistributableMoCondition", "x-enum-as-string": true }, "ImageType": { "description": "Image type for which user wants to create notification.\nThe list of valid values for Image type of notification.DistributableMoCondition is software.HyperflexBundleDistributable, software.ApplianceDistributableIntelligence,\nfirmware.Distributable, software.HciBundleDistributable.\n* `None` - Default value for DistributableObjectType enum.\n* `software.ApplianceDistributableIntelligence` - Object type for Appliance Intelligence updates related distributable.\n* `firmware.Distributable` - Object type for firmware related distributable.\n* `software.HyperflexBundleDistributable` - Object type for HyperFlex related distributable.\n* `software.ApplianceDistributableConnected` - Object type for Appliance related distributable. By Choosing this, user shows intent to use the downloaded image for Connected appliance. \n* `software.ApplianceDistributablePrivate` - Object type for Appliance related distributable. By Choosing this, user shows intent to use the downloaded image for Private appliance. \n* `software.UcsdBundleDistributable` - Object type for UCSD related distributable.\n* `software.HciBundleDistributable` - Object type for HCI Bundle related distributable.", "type": "string", "enum": [ "None", "software.ApplianceDistributableIntelligence", "firmware.Distributable", "software.HyperflexBundleDistributable", "software.ApplianceDistributableConnected", "software.ApplianceDistributablePrivate", "software.UcsdBundleDistributable", "software.HciBundleDistributable" ], "default": "None", "x-omitempty": true }, "OdataFilter": { "description": "Odata filter string managed internally. It is built with specific ObjectType properties.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "notification.EolAdvisoryFilter": { "title": "Notification:Eol Advisory Filter", "description": "Filter for a specific end-of-life advisory with selected severities.", "x-allOf-name": "notification.EolAdvisoryFilter", "allOf": [ { "$ref": "#/components/schemas/notification.AbstractAdvisoryFilter" }, { "type": "object", "description": "Definition of the list of properties defined in 'notification.EolAdvisoryFilter', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "notification.EolAdvisoryFilter" ], "default": "notification.EolAdvisoryFilter", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "notification.EolAdvisoryFilter" ], "default": "notification.EolAdvisoryFilter", "x-enum-as-string": true }, "MilestoneType": { "type": "array", "items": { "description": "List of Milestone Types on which user wants to receive notifications.\n* `unknown` - The type of end-of-life milestone is not defined.\n* `endOfSoftwareMaintenanceDate` - The last date that Cisco Engineering may release any final software maintenance releases or bug fixes. After this date, Cisco Engineering may no longer develop, repair, maintain, or test the product software and only critical security updates will be provided on this release train. \n* `lastDateOfSupport` - The last date to receive service and support for the software. After this date, all support services for the software are unavailable, and the software becomes obsolete. \n* `endOfLifeAnnouncementDate` - The date the document that announces the end-of-sale and end-of-life of a product is distributed to the general public.", "type": "string", "enum": [ "unknown", "endOfSoftwareMaintenanceDate", "lastDateOfSupport", "endOfLifeAnnouncementDate" ], "default": "unknown", "x-omitempty": true }, "nullable": true } } } ] }, "notification.FieldNoticeAdvisoryFilter": { "title": "Notification:Field Notice Advisory Filter", "description": "Filter for a specific field notice advisory with selected severities.", "x-allOf-name": "notification.FieldNoticeAdvisoryFilter", "allOf": [ { "$ref": "#/components/schemas/notification.AbstractAdvisoryFilter" }, { "type": "object", "description": "Definition of the list of properties defined in 'notification.FieldNoticeAdvisoryFilter', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "notification.FieldNoticeAdvisoryFilter" ], "default": "notification.FieldNoticeAdvisoryFilter", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "notification.FieldNoticeAdvisoryFilter" ], "default": "notification.FieldNoticeAdvisoryFilter", "x-enum-as-string": true }, "Severity": { "type": "array", "items": { "description": "List of FnSeverities on which user wants to receive notifications.\n* `na` - < For field notices, where Severity or Impact rating is not applicable.\n* `critical` - < If applicable, customers may experience downtime or might be at risk of affecting services. Urgent attention and response action are desirable.\n* `high` - < If applicable, it may degrade or might have a potential degradation, Attention and response based on deployment scenarios.\n* `medium` - < If applicable, it may affect system performance or functionality but are less like to pose an immediate risk to the network. Actions to be taken in due course of time based on deployment scenarios.\n* `low` - < If applicable, Unlikely to expect disrupted functionality. Minor in nature and can be addressed as per convenience.", "type": "string", "enum": [ "na", "critical", "high", "medium", "low" ], "default": "na", "x-omitempty": true }, "nullable": true } } } ] }, "notification.HttpHeader": { "title": "Notification:Http Header", "description": "HttpHeader represents a single HTTP header as a name/value pair. Used to specify\ncustom headers that are attached to each webhook notification request.\nExactly one of clearTextValue or encryptedValue must be set. When encrypt is\nfalse, clearTextValue is used. When encrypt is true, encryptedValue is used and\nthe value is stored encrypted and decrypted before being attached to outgoing requests.", "x-allOf-name": "notification.HttpHeader", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'notification.HttpHeader', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "notification.HttpHeader" ], "default": "notification.HttpHeader", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "notification.HttpHeader" ], "default": "notification.HttpHeader", "x-enum-as-string": true }, "ClearTextValue": { "description": "The plaintext value of the HTTP header. Use this field when the header value\nis not sensitive. Used only when encrypt is false.", "type": "string", "x-omitempty": true }, "Encrypt": { "description": "When false (default), clearTextValue is attached to the outgoing request as-is.\nWhen true, encryptedValue is decrypted and attached to the outgoing request.", "type": "boolean", "x-omitempty": true }, "EncryptedValue": { "description": "The sensitive value of the HTTP header, stored encrypted. Use this field when\nthe header value is sensitive, for example an API key or token. Used only when\nencrypt is true. Not returned in GET API responses; use IsEncryptedValueSet to\ncheck whether a value has been set.", "type": "string", "writeOnly": true, "x-omitempty": true }, "IsEncryptedValueSet": { "description": "Indicates whether the value of the 'encryptedValue' property has been set.", "type": "boolean", "default": false, "readOnly": true, "x-omitempty": true }, "Name": { "description": "Name of the HTTP header, for example X-Custom-Header.", "type": "string", "x-omitempty": true } } } ] }, "notification.MoCondition": { "title": "Notification:Mo Condition", "description": "This condition type gives the ability to subscribe to arbitrary MO type with arbitrary OData filter string and operation.", "x-allOf-name": "notification.MoCondition", "allOf": [ { "$ref": "#/components/schemas/notification.AbstractMoCondition" }, { "type": "object", "description": "Definition of the list of properties defined in 'notification.MoCondition', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "notification.MoCondition" ], "default": "notification.MoCondition", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "notification.MoCondition" ], "default": "notification.MoCondition", "x-enum-as-string": true }, "OdataFilter": { "description": "Odata filter string managed internally. It is built with specific ObjectType properties.", "type": "string", "x-omitempty": true } } } ] }, "notification.SecurityAdvisoryFilter": { "title": "Notification:Security Advisory Filter", "description": "Filter for a specific security advisory with selected severities.", "x-allOf-name": "notification.SecurityAdvisoryFilter", "allOf": [ { "$ref": "#/components/schemas/notification.AbstractAdvisoryFilter" }, { "type": "object", "description": "Definition of the list of properties defined in 'notification.SecurityAdvisoryFilter', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "notification.SecurityAdvisoryFilter" ], "default": "notification.SecurityAdvisoryFilter", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "notification.SecurityAdvisoryFilter" ], "default": "notification.SecurityAdvisoryFilter", "x-enum-as-string": true }, "Severity": { "type": "array", "items": { "description": "List of Psirt Severities on which user wants to receive notifications.\n* `critical` - < If applicable, it may expose users to critical failures and it needs to be addressed immediately. For e.g. a PSIRT advisory with a corresponding CVSS score of above 9.0.\n* `high` - < If applicable, it may expose the users to critical failure and it needs to be addressed immediately. For e.g. a PSIRT advisory with a corresponding CVSS score between 7.0-8.9. These may be the vulnerabilities that are more difficult to exploit than the ones deemed critical but once exploited, the will cause critical failures.\n* `medium` - < If applicable, it may expose the users to failure of certain functions. for e.g. a PSIRT advisory with a corresponding CVSS score between 4.0-6.9. These may be the vulnerabilities that are mitigated to a large extent but that may still be exploited in certain restricted cases.\n* `info` - < If applicable, it may have some minimal impact for certain functions in the user environment. For e.g. a PSIRT advisory with a corresponding CVSS score below 4.0.", "type": "string", "enum": [ "critical", "high", "medium", "info" ], "default": "critical", "x-omitempty": true }, "nullable": true } } } ] }, "notification.SendEmail": { "title": "Notification:Send Email", "description": "SendEmail complexType holds the recipient's email address.", "x-allOf-name": "notification.SendEmail", "allOf": [ { "$ref": "#/components/schemas/notification.Action" }, { "type": "object", "description": "Definition of the list of properties defined in 'notification.SendEmail', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "notification.SendEmail" ], "default": "notification.SendEmail", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "notification.SendEmail" ], "default": "notification.SendEmail", "x-enum-as-string": true }, "Email": { "description": "Email of the recipient, who expects to be notified about the event that happens in Intersight.", "type": "string", "x-omitempty": true } } } ] }, "notification.SimpleFilter": { "title": "Notification:Simple Filter", "description": "Single filter condition with an operator, property, and value.\nUsed by notification SimpleMoCondition when a flat predicate is sufficient (not the shared filterexpr tree).", "x-allOf-name": "notification.SimpleFilter", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'notification.SimpleFilter', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "notification.SimpleFilter" ], "default": "notification.SimpleFilter", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "notification.SimpleFilter" ], "default": "notification.SimpleFilter", "x-enum-as-string": true }, "Operator": { "description": "The operator to apply (eq, ne, contains, in).", "type": "string", "x-omitempty": true }, "Property": { "description": "The property name to filter on (e.g., HostName, Domain,\nServerProfile, Organization).", "type": "string", "x-omitempty": true }, "Value": { "type": "array", "items": { "description": "Values to match the property against. Can be a list of strings.", "type": "string", "x-omitempty": true }, "nullable": true } } } ] }, "notification.SimpleMoCondition": { "title": "Notification:Simple Mo Condition", "description": "This condition type gives the ability to subscribe to arbitrary ObjectType \nwith a controlled list of OData filter string and operation. Primarily used \nfor email subscriptions created by the user or a northbound system.", "x-allOf-name": "notification.SimpleMoCondition", "allOf": [ { "$ref": "#/components/schemas/notification.AbstractMoCondition" }, { "type": "object", "description": "Definition of the list of properties defined in 'notification.SimpleMoCondition', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "notification.SimpleMoCondition" ], "default": "notification.SimpleMoCondition", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "notification.SimpleMoCondition" ], "default": "notification.SimpleMoCondition", "x-enum-as-string": true }, "Filter": { "description": "Simple single-predicate filter. Use either this or filterExpression, not both.\nCriteria that preserves the UI entered filter query.", "$ref": "#/components/schemas/notification.SimpleFilter", "x-omitempty": true }, "FilterExpression": { "description": "Boolean expression of predicates. Use either this or filter, not both.\nWhen set, odataFilter is built by the server from this tree.", "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/filterexpr.FilterExpression", "x-omitempty": true }, "OdataFilter": { "description": "Odata filter string managed internally. It is built with specific ObjectType properties.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "notification.SoftwareReleaseMetaMoCondition": { "title": "Notification:Software Release Meta Mo Condition", "description": "This condition type gives the ability to subscribe to the software.ReleaseMeta ObjectType and provide a list of ImageTypes you're interested in.", "x-allOf-name": "notification.SoftwareReleaseMetaMoCondition", "allOf": [ { "$ref": "#/components/schemas/notification.AbstractMoCondition" }, { "type": "object", "description": "Definition of the list of properties defined in 'notification.SoftwareReleaseMetaMoCondition', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "notification.SoftwareReleaseMetaMoCondition" ], "default": "notification.SoftwareReleaseMetaMoCondition", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "notification.SoftwareReleaseMetaMoCondition" ], "default": "notification.SoftwareReleaseMetaMoCondition", "x-enum-as-string": true }, "ImageTypes": { "type": "array", "items": { "description": "List of Image types for which user wants to receive notifications.\nThe list of valid Image types for notification.SoftwareReleaseMetaMoCondition is software.ApplianceDistributableConnected, software.ApplianceDistributablePrivate,\nsoftware.UcsdBundleDistributable.\n* `None` - Default value for DistributableObjectType enum.\n* `software.ApplianceDistributableIntelligence` - Object type for Appliance Intelligence updates related distributable.\n* `firmware.Distributable` - Object type for firmware related distributable.\n* `software.HyperflexBundleDistributable` - Object type for HyperFlex related distributable.\n* `software.ApplianceDistributableConnected` - Object type for Appliance related distributable. By Choosing this, user shows intent to use the downloaded image for Connected appliance. \n* `software.ApplianceDistributablePrivate` - Object type for Appliance related distributable. By Choosing this, user shows intent to use the downloaded image for Private appliance. \n* `software.UcsdBundleDistributable` - Object type for UCSD related distributable.\n* `software.HciBundleDistributable` - Object type for HCI Bundle related distributable.", "type": "string", "enum": [ "None", "software.ApplianceDistributableIntelligence", "firmware.Distributable", "software.HyperflexBundleDistributable", "software.ApplianceDistributableConnected", "software.ApplianceDistributablePrivate", "software.UcsdBundleDistributable", "software.HciBundleDistributable" ], "default": "None", "x-omitempty": true }, "nullable": true }, "OdataFilter": { "description": "Odata filter string managed internally. It is built with specific ObjectType properties.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "notification.Subscription": { "title": "Notification:Subscription", "description": "Subscription is the abstract model that holds shared properties for all subscription types.\nDifferent types of subscriptions extend this model and add their own required properties.", "x-allOf-name": "notification.Subscription", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'notification.Subscription', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "notification.AccountSubscription" ], "default": "notification.AccountSubscription", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "notification.AccountSubscription" ], "default": "notification.AccountSubscription", "x-enum-as-string": true }, "Actions": { "type": "array", "items": { "description": "Notification method that should be used to notify about events that match with a subscription.", "$ref": "#/components/schemas/notification.Action", "x-omitempty": true }, "nullable": true }, "ConditionOperator": { "description": "Operation that binds all the different conditions together.\n* `All` - All is an AND condition applied against the individual conditions.\n* `Any` - Any is an OR condition applied against the individual conditions.", "type": "string", "enum": [ "All", "Any" ], "default": "All", "x-omitempty": true }, "Conditions": { "type": "array", "items": { "description": "Conditions is the array of abstract conditions which should be applied to the event.", "$ref": "#/components/schemas/notification.AbstractCondition", "x-omitempty": true }, "nullable": true }, "Enabled": { "description": "Subscription can be switched on/off without necessity to change the subscription\nsettings: notification methods, conditions, etc.\nEx.: Subscription MO can be configured, but switched off.", "type": "boolean", "x-omitempty": true } } } ] }, "notification.TriggerWebhook": { "title": "Notification:Trigger Webhook", "description": "TriggerWebhook complexType holds the Payload URL's server meta info.\nConfigure at most one primary signing or credential mechanism: secret (HMAC-SHA256),\nauthentication (Basic, Bearer, Splunk), and/or customHeaders (use EncryptedValue\nfor sensitive values such as API keys). Setting both secret and a real\nauthentication credential at the same time is rejected at create/update time.\nIf secret is unset, customHeaders is empty, and authentication is unset or\nasset.NoAuthenticationCredential, deliveries are sent with no HMAC signing and\nno Authorization header (unauthenticated outbound webhook).", "x-allOf-name": "notification.TriggerWebhook", "allOf": [ { "$ref": "#/components/schemas/notification.Action" }, { "type": "object", "description": "Definition of the list of properties defined in 'notification.TriggerWebhook', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "notification.TriggerWebhook" ], "default": "notification.TriggerWebhook", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "notification.TriggerWebhook" ], "default": "notification.TriggerWebhook", "x-enum-as-string": true }, "Authentication": { "description": "The credential used to authenticate webhook delivery requests. When set to a\nreal credential, the appropriate authentication header (Basic, Bearer, or Splunk)\nis attached to each outgoing notification. If not set or if\nasset.NoAuthenticationCredential is used, requests use HMAC-SHA256 via the secret\nfield when secret is set; otherwise the request is sent without Authorization\nsigning or headers.", "$ref": "#/components/schemas/asset.Credential", "x-omitempty": true }, "ClearSecret": { "description": "When set to true on update, the HMAC shared secret is not carried over from the previous\nstored action when the request omits the write-only ``secret`` field. Use this to clear\nthe signing key without re-sending a secret value. When false or not set, the prior\nbehavior applies: the previous secret is preserved on PATCH if ``secret`` is omitted.", "type": "boolean", "default": false, "x-omitempty": true }, "CustomHeaders": { "type": "array", "items": { "description": "List of additional HTTP headers to attach to each webhook notification request.\nThese headers are sent in addition to any headers set by the authentication\ncredential. Each entry must have a unique header name.", "$ref": "#/components/schemas/notification.HttpHeader", "x-omitempty": true }, "maxItems": 10, "nullable": true }, "FirstFailedRequest": { "description": "Holds the timestamp of the first failed request. The first time the notification is not delivered to the\nwebhook server, the user will have the Warning alarm in the system. Next 48 hours the system still will try\nto notify the webhook server. If after 48 hours the server is not recovered, the system will mark this\nwebhook as Inactive, and the user will have a critical alarm in the system.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "IsSecretSet": { "description": "Indicates whether the value of the 'secret' property has been set.", "type": "boolean", "default": false, "readOnly": true, "x-omitempty": true }, "LastNetworkError": { "description": "Holds the error message for the user of the last response.", "type": "string", "readOnly": true, "x-omitempty": true }, "LastResponseCode": { "description": "Holds the code of the last response, which helps to debug the issue in case if webhook server is not reachable.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Secret": { "description": "Prefer the Authentication property to configure how webhook deliveries are authenticated, including the Authorization header.\nThis field holds the shared secret used for HMAC-SHA256 signing when no credential is configured, and remains supported for existing integrations.\nBy this header developers of the webhooks servers can make sure that events are received from the trusted source - Intersight.", "type": "string", "writeOnly": true, "x-omitempty": true }, "State": { "description": "State of the action shows whether this action passes the verification or not. If this property holds\n'Inactive' value, this action will not be executed. To verify action again, use the Verify property from the MO.\n* `Inactive` - Inactive state means action didn't pass the verification and it won't be executed.\n* `Active` - Active state means that action successfully passed the verification and it is ready to be performed.", "type": "string", "enum": [ "Inactive", "Active" ], "default": "Inactive", "readOnly": true, "x-omitempty": true }, "Url": { "description": "Payload URL of the recipient app, which is intended to serve the events that happens in Intersight.", "type": "string", "pattern": "^https:\\/\\/[\\w.-]+(?:\\.[\\w\\.-]+)+[\\w\\-\\._~:/?#[\\]@!\\$&'\\(\\)\\*\\+,;=.]+$", "x-omitempty": true } } } ] }, "oauth.AccessToken.Response": { "description": "The response body of a HTTP GET request for the 'oauth.AccessToken' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'oauth.AccessToken' resources.", "x-one-of-name": "oauth.AccessToken.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/oauth.AccessToken.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "oauth.AccessToken.Relationship": { "description": "A relationship to the 'oauth.AccessToken' resource, or the expanded 'oauth.AccessToken' resource, or the 'null' value.", "x-one-of-name": "oauth.AccessToken.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/oauth.AccessToken" } ], "discriminator": { "propertyName": "ClassId" } }, "oauth.AccessToken": { "title": "Oauth:Access Token", "description": "The AccessToken object is a key component of the OAuth-based authentication system, designed to manage API access tokens associated with user accounts. This provides a secure mechanism for applications to access services on behalf of users, ensuring that permissions and access controls are upheld.\n#### Purpose\nThe AccessToken object serves as a secure representation of authorization for specific applications to interact with designated services. It supports seamless and efficient access management while maintaining strict security protocols.\n#### Key Concepts\n- **Authorization Management:** Represents the OAuth access token, which embodies the permissions granted to a specific application for accessing a service.\n- **Security:** Ensures that access tokens are securely issued and managed, with support for refresh tokens to prolong access without user intervention.\n- **Access Control:** The AccessToken object supports privilege sets to ensure that only authorized administrators can read or delete access tokens.\n- **Relationship Handling:** Linked to the iam.Account object, representing the account responsible for managing the OAuth process.", "x-allOf-name": "oauth.AccessToken", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'oauth.AccessToken', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "oauth.AccessToken" ], "default": "oauth.AccessToken", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "oauth.AccessToken" ], "default": "oauth.AccessToken", "x-enum-as-string": true }, "ApiType": { "description": "OAuth API type (e.g., Smart licensing API).\n* `Unknown` - Unknown serves as the default API type.\n* `SmartLicensing-API` - Smart licensing API type.\n* `CommerceEstimate-API` - Commerce Estimate API type.", "type": "string", "enum": [ "Unknown", "SmartLicensing-API", "CommerceEstimate-API" ], "default": "Unknown", "x-createOnly": true, "x-omitempty": true }, "Expiry": { "description": "Access token expiration date and time.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "Issuer": { "description": "OAuth access token issuer.", "type": "string", "readOnly": true, "x-omitempty": true }, "RefreshExpiry": { "description": "Refresh token expiration date and time.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "TokenOwner": { "description": "MOID of the access token owner.", "type": "string", "readOnly": true, "x-omitempty": true }, "Account": { "$ref": "#/components/schemas/iam.Account.Relationship", "description": "A reference to a iamAccount resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "oauth.AccessToken.List": { "title": "List of 'oauth.AccessToken' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'oauth.AccessToken' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'oauth.AccessToken' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/oauth.AccessToken" }, "nullable": true } } } ] }, "oauth.Authorization.Response": { "description": "The response body of a HTTP GET request for the 'oauth.Authorization' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'oauth.Authorization' resources.", "x-one-of-name": "oauth.Authorization.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/oauth.Authorization.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "oauth.Authorization": { "title": "Oauth:Authorization", "description": "The Authorization object underpins the OAuth2 authorization process, enabling user consent for external interactions on behalf of their account. It supports secure and efficient management of user credentials for accessing external services.\n#### Purpose\nAuthorization serves as the conduit for user consent, allowing Intersight to interact with external software repositories securely on behalf of users, particularly in support of OAuth2 resource owner grant types.\n#### Key Concepts\n- **User Consent:** Facilitates secure consent mechanisms for external interactions, ensuring user credentials are protected.\n- **Security Measures:** Incorporates encryption and secure handling of user credentials, safeguarding access and interactions.\n- **Privileged Access:** Ensures that only authorized administrators can create, update, or read authorizations, maintaining strict access controls.\n- **Account Integration:** Associated with the iam.Account object, providing a structured approach to managing user authorization processes.", "x-allOf-name": "oauth.Authorization", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'oauth.Authorization', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "oauth.Authorization" ], "default": "oauth.Authorization", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "oauth.Authorization" ], "default": "oauth.Authorization", "x-enum-as-string": true }, "ApiType": { "description": "OAuth API type (e.g., Smart licensing API).\n* `Unknown` - Unknown serves as the default API type.\n* `SmartLicensing-API` - Smart licensing API type.\n* `CommerceEstimate-API` - Commerce Estimate API type.", "type": "string", "enum": [ "Unknown", "SmartLicensing-API", "CommerceEstimate-API" ], "default": "Unknown", "writeOnly": true, "x-omitempty": true }, "IsPasswordSet": { "description": "Indicates whether the value of the 'password' property has been set.", "type": "boolean", "default": false, "readOnly": true, "x-omitempty": true }, "IsUserIdSet": { "description": "Indicates whether the value of the 'userId' property has been set.", "type": "boolean", "default": false, "readOnly": true, "x-omitempty": true }, "Password": { "description": "Password used by Intersight to create OAuth2 tokens for interacting with the external repository on behalf of the user account.", "type": "string", "writeOnly": true, "x-omitempty": true }, "UserId": { "description": "Username used by Intersight to create OAuth2 tokens for interacting with the external repository on behalf of the user account.", "type": "string", "writeOnly": true, "x-omitempty": true }, "AccessToken": { "$ref": "#/components/schemas/oauth.AccessToken.Relationship", "description": "A reference to a oauthAccessToken resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Account": { "$ref": "#/components/schemas/iam.Account.Relationship", "description": "A reference to a iamAccount resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "oauth.Authorization.List": { "title": "List of 'oauth.Authorization' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'oauth.Authorization' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'oauth.Authorization' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/oauth.Authorization" }, "nullable": true } } } ] }, "openapi.ApiInfo": { "title": "Openapi:Api Info", "description": "Meta information about the API that will be generated as task.", "x-allOf-name": "openapi.ApiInfo", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'openapi.ApiInfo', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "openapi.ApiInfo" ], "default": "openapi.ApiInfo", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "openapi.ApiInfo" ], "default": "openapi.ApiInfo", "x-enum-as-string": true }, "ApiPathObjectIdentifier": { "description": "Unique identifier for the ApiMethod object that holds more information about this API.", "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef", "x-omitempty": true }, "Description": { "description": "A detailed description of the API.", "type": "string", "x-omitempty": true }, "DisplayLabel": { "description": "Display name of the selected API endpoint.", "type": "string", "x-omitempty": true }, "Method": { "description": "Method Type of the selected API.\n* `GET` - Method type which indicates it is a GET API call.\n* `POST` - Method type which indicates it is a POST API call.\n* `PUT` - Method type which indicates it is a PUT API call.\n* `PATCH` - Method type which indicates it is a PATCH API call.\n* `DELETE` - Method type which indicates it is a DELETE API call.", "type": "string", "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "default": "GET", "x-omitempty": true }, "Name": { "description": "Name of the selected API endpoint.", "type": "string", "x-omitempty": true }, "Path": { "description": "API Path of the selected API endpoint.", "type": "string", "x-omitempty": true }, "ValidationError": { "description": "Validation error messages will be captured by this property.", "type": "string", "readOnly": true, "x-omitempty": true }, "ValidationStatus": { "description": "Validation Status of selected API that indicates if the API validation passed or failed.\n* `none` - Indicates the default status.\n* `Success` - Denotes that the validation is successful.\n* `Failed` - Denotes that the validation failed. Validation could fail if information present in the OpenAPI specification is incomplete or missing.", "type": "string", "enum": [ "none", "Success", "Failed" ], "default": "none", "readOnly": true, "x-omitempty": true } } } ] }, "openapi.ApiMethodMeta.Response": { "description": "The response body of a HTTP GET request for the 'openapi.ApiMethodMeta' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'openapi.ApiMethodMeta' resources.", "x-one-of-name": "openapi.ApiMethodMeta.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/openapi.ApiMethodMeta.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "openapi.ApiMethodMeta": { "title": "Openapi:Api Method Meta", "description": "Contains metadata about APIs in the previously uploaded OpenAPI specification file.", "x-allOf-name": "openapi.ApiMethodMeta", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'openapi.ApiMethodMeta', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "openapi.ApiMethodMeta" ], "default": "openapi.ApiMethodMeta", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "openapi.ApiMethodMeta" ], "default": "openapi.ApiMethodMeta", "x-enum-as-string": true }, "Description": { "description": "The description of the given API.", "type": "string", "readOnly": true, "x-omitempty": true }, "DisplayLabel": { "description": "The display label of the given API.", "type": "string", "readOnly": true, "x-omitempty": true }, "Method": { "description": "The method type for the given API.\n* `GET` - Method type which indicates it is a GET API call.\n* `POST` - Method type which indicates it is a POST API call.\n* `PUT` - Method type which indicates it is a PUT API call.\n* `PATCH` - Method type which indicates it is a PATCH API call.\n* `DELETE` - Method type which indicates it is a DELETE API call.", "type": "string", "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "default": "GET", "readOnly": true, "x-omitempty": true }, "Name": { "description": "The description of the given API.", "type": "string", "readOnly": true, "x-omitempty": true }, "Path": { "description": "Path of the selected API endpoint.", "type": "string", "readOnly": true, "x-omitempty": true }, "Source": { "$ref": "#/components/schemas/openapi.ProcessFile.Relationship", "description": "A reference to a openapiProcessFile resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "openapi.ApiMethodMeta.List": { "title": "List of 'openapi.ApiMethodMeta' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'openapi.ApiMethodMeta' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'openapi.ApiMethodMeta' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/openapi.ApiMethodMeta" }, "nullable": true } } } ] }, "openapi.FailedTask": { "title": "Openapi:Failed Task", "description": "A type that holds information about failed tasks.", "x-allOf-name": "openapi.FailedTask", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'openapi.FailedTask', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "openapi.FailedTask" ], "default": "openapi.FailedTask", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "openapi.FailedTask" ], "default": "openapi.FailedTask", "x-enum-as-string": true }, "Name": { "description": "Name of the task.", "type": "string", "x-omitempty": true }, "Path": { "description": "REST API path of the task.", "type": "string", "x-omitempty": true }, "Reason": { "description": "Indicates the reason for task creation failure.", "type": "string", "x-omitempty": true } } } ] }, "openapi.KeyValuePair": { "title": "Openapi:Key Value Pair", "description": "A key, value pair to hold different types of key, value information.", "x-allOf-name": "openapi.KeyValuePair", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'openapi.KeyValuePair', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "openapi.KeyValuePair" ], "default": "openapi.KeyValuePair", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "openapi.KeyValuePair" ], "default": "openapi.KeyValuePair", "x-enum-as-string": true }, "Key": { "description": "Name of the key variable.", "type": "string", "x-omitempty": true }, "Value": { "description": "Value of the key variable.", "type": "string", "x-omitempty": true } } } ] }, "openapi.OpenApiSpecification.Response": { "description": "The response body of a HTTP GET request for the 'openapi.OpenApiSpecification' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'openapi.OpenApiSpecification' resources.", "x-one-of-name": "openapi.OpenApiSpecification.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/openapi.OpenApiSpecification.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "openapi.OpenApiSpecification.Relationship": { "description": "A relationship to the 'openapi.OpenApiSpecification' resource, or the expanded 'openapi.OpenApiSpecification' resource, or the 'null' value.", "x-one-of-name": "openapi.OpenApiSpecification.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/openapi.OpenApiSpecification" } ], "discriminator": { "propertyName": "ClassId" } }, "openapi.OpenApiSpecification": { "title": "OpenAPI Specification File Upload", "description": "An OpenAPI specification file uploaded to generate workflow tasks.", "x-allOf-name": "openapi.OpenApiSpecification", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/softwarerepository.File" }, { "type": "object", "description": "Definition of the list of properties defined in 'openapi.OpenApiSpecification', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "openapi.OpenApiSpecification" ], "default": "openapi.OpenApiSpecification", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "openapi.OpenApiSpecification" ], "default": "openapi.OpenApiSpecification", "x-enum-as-string": true }, "FilePath": { "description": "The path of the file in S3/minio bucket.", "type": "string", "readOnly": true, "x-omitempty": true }, "FileUploadId": { "description": "A unique tracking ID for the file being uploaded.", "type": "string", "readOnly": true, "x-omitempty": true }, "Organization": { "$ref": "#/components/schemas/organization.Organization.Relationship", "description": "A reference to a organizationOrganization resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true } } } ] }, "openapi.OpenApiSpecification.List": { "title": "List of 'openapi.OpenApiSpecification' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'openapi.OpenApiSpecification' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'openapi.OpenApiSpecification' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/openapi.OpenApiSpecification" }, "nullable": true } } } ] }, "openapi.ProcessFile.Response": { "description": "The response body of a HTTP GET request for the 'openapi.ProcessFile' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'openapi.ProcessFile' resources.", "x-one-of-name": "openapi.ProcessFile.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/openapi.ProcessFile.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "openapi.ProcessFile.Relationship": { "description": "A relationship to the 'openapi.ProcessFile' resource, or the expanded 'openapi.ProcessFile' resource, or the 'null' value.", "x-one-of-name": "openapi.ProcessFile.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/openapi.ProcessFile" } ], "discriminator": { "propertyName": "ClassId" } }, "openapi.ProcessFile": { "title": "Openapi:Process File", "description": "Validates the OpenAPI specification file. On successful validation, it persists information about the available APIs. This information can be used to create tasks in the cloud orchestrator.", "x-allOf-name": "openapi.ProcessFile", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'openapi.ProcessFile', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "openapi.ProcessFile" ], "default": "openapi.ProcessFile", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "openapi.ProcessFile" ], "default": "openapi.ProcessFile", "x-enum-as-string": true }, "FailureReason": { "description": "An error message for when download, validation or processing of OpenAPI Specification fails.", "type": "string", "readOnly": true, "x-omitempty": true }, "FileDownloadStatus": { "description": "Status of the internal OpenAPI specification fetch operation\n* `none` - Indicates the default status\n* `InProgress` - Indicates that operation is in progress\n* `Completed` - Indicates that the operation is complete\n* `Failed` - Indicates that the operation has failed. Check the failureReason attribute for more details.", "type": "string", "enum": [ "none", "InProgress", "Completed", "Failed" ], "default": "none", "readOnly": true, "x-omitempty": true }, "FileProcessingStatus": { "description": "Status of the OpenAPI specification processing operation. The OpenAPI specification file is processed to create APIMethod objects.\n* `none` - Indicates the default status\n* `InProgress` - Indicates that operation is in progress\n* `Completed` - Indicates that the operation is complete\n* `Failed` - Indicates that the operation has failed. Check the failureReason attribute for more details.", "type": "string", "enum": [ "none", "InProgress", "Completed", "Failed" ], "default": "none", "readOnly": true, "x-omitempty": true }, "FileValidationStatus": { "description": "Status of the OpenAPI specification validation operation.\n* `none` - Indicates the default status\n* `InProgress` - Indicates that operation is in progress\n* `Completed` - Indicates that the operation is complete\n* `Failed` - Indicates that the operation has failed. Check the failureReason attribute for more details.", "type": "string", "enum": [ "none", "InProgress", "Completed", "Failed" ], "default": "none", "readOnly": true, "x-omitempty": true }, "SpecFilePath": { "description": "The location of the previously uploaded OpenAPI specification file.", "type": "string", "x-omitempty": true }, "FileInfo": { "$ref": "#/components/schemas/openapi.OpenApiSpecification.Relationship", "description": "A reference to a openapiOpenApiSpecification resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "Organization": { "$ref": "#/components/schemas/organization.Organization.Relationship", "description": "A reference to a organizationOrganization resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true } } } ] }, "openapi.ProcessFile.List": { "title": "List of 'openapi.ProcessFile' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'openapi.ProcessFile' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'openapi.ProcessFile' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/openapi.ProcessFile" }, "nullable": true } } } ] }, "openapi.TaskGenerationRequest.Response": { "description": "The response body of a HTTP GET request for the 'openapi.TaskGenerationRequest' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'openapi.TaskGenerationRequest' resources.", "x-one-of-name": "openapi.TaskGenerationRequest.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/openapi.TaskGenerationRequest.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "openapi.TaskGenerationRequest.Relationship": { "description": "A relationship to the 'openapi.TaskGenerationRequest' resource, or the expanded 'openapi.TaskGenerationRequest' resource, or the 'null' value.", "x-one-of-name": "openapi.TaskGenerationRequest.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/openapi.TaskGenerationRequest" } ], "discriminator": { "propertyName": "ClassId" } }, "openapi.TaskGenerationRequest": { "title": "Openapi:Task Generation Request", "description": "Creates a request which has information about the tasks that need to be created from the previously uploaded OpenAPI specification file. This object internally triggers a workflow that creates tasks which can be used in workflows.", "x-allOf-name": "openapi.TaskGenerationRequest", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'openapi.TaskGenerationRequest', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "openapi.TaskGenerationRequest" ], "default": "openapi.TaskGenerationRequest", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "openapi.TaskGenerationRequest" ], "default": "openapi.TaskGenerationRequest", "x-enum-as-string": true }, "EndpointType": { "description": "Indicates if target endpoint is external or internal. An endpoint is internal if the target is an Intersight resource. For instance, configuring an intersight object using a Task.\n* `External` - Denotes that the target endpoint is an external API endpoint.\n* `Internal` - Denotes that the target endpoint is a Intersight API endpoint.", "type": "string", "enum": [ "External", "Internal" ], "default": "External", "x-omitempty": true }, "FailedTasks": { "type": "array", "items": { "description": "List of tasks that could not be created.", "$ref": "#/components/schemas/openapi.FailedTask", "readOnly": true, "x-omitempty": true }, "nullable": true }, "HeaderParameters": { "type": "array", "items": { "description": "Common header parameters that apply to all tasks being created.", "$ref": "#/components/schemas/openapi.KeyValuePair", "x-omitempty": true }, "nullable": true }, "IsValidateRequest": { "description": "When this value is set to true, the task name validations happen and provides the task validation status against each of the selected API on the property selectedApis When this value is set to false, an internal workflow to generate the tasks is submitted, conflicting task names are created with an incremented version.", "type": "boolean", "x-omitempty": true }, "Protocol": { "description": "Specifies the REST API protocol being used, which can be one of HTTP or HTTPS.\n* `HTTPS` - Denotes that the API call uses the HTTPS protocol type\n* `HTTP` - Denotes that the API call uses the HTTP protocol type", "type": "string", "enum": [ "HTTPS", "HTTP" ], "default": "HTTPS", "x-omitempty": true }, "QueryParameters": { "type": "array", "items": { "description": "Common query parameters that apply to all GET tasks being created. These do not apply to POST, PATCH operations.", "$ref": "#/components/schemas/openapi.KeyValuePair", "x-omitempty": true }, "nullable": true }, "SelectedApis": { "type": "array", "items": { "description": "Specifies a list of APIs, Method for which tasks will be created.", "$ref": "#/components/schemas/openapi.ApiInfo", "x-omitempty": true }, "nullable": true }, "Status": { "description": "Depicts the status of the task creation request.\n* `none` - Indicates the default status.\n* `InProgress` - Request has been picked up for generating tasks from the OpenAPI Specification file.\n* `Completed` - All the tasks from the request have been created.\n* `Failed` - There were failures in generating one or more tasks in the request.", "type": "string", "enum": [ "none", "InProgress", "Completed", "Failed" ], "default": "none", "readOnly": true, "x-omitempty": true }, "TaskPrefix": { "description": "Optional string that can be prefixed to the name of created tasks.", "type": "string", "x-omitempty": true }, "TaskTags": { "type": "array", "items": { "description": "Tags which apply to the created tasks.", "$ref": "#/components/schemas/openapi.KeyValuePair", "x-omitempty": true }, "nullable": true }, "Url": { "description": "Specifies the URL of the endpoint that the created task communicates with. It is defaulted to intersight.com for internal endpoints.", "type": "string", "x-omitempty": true }, "Organization": { "$ref": "#/components/schemas/organization.Organization.Relationship", "description": "A reference to a organizationOrganization resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true }, "Source": { "$ref": "#/components/schemas/openapi.ProcessFile.Relationship", "description": "A reference to a openapiProcessFile resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "Workflow": { "$ref": "intersight-orchestrator-v3-1.0.11-20260807064027971.json#/components/schemas/workflow.WorkflowInfo.Relationship", "description": "A reference to a workflowWorkflowInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "openapi.TaskGenerationRequest.List": { "title": "List of 'openapi.TaskGenerationRequest' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'openapi.TaskGenerationRequest' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'openapi.TaskGenerationRequest' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/openapi.TaskGenerationRequest" }, "nullable": true } } } ] }, "openapi.TaskGenerationResult.Response": { "description": "The response body of a HTTP GET request for the 'openapi.TaskGenerationResult' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'openapi.TaskGenerationResult' resources.", "x-one-of-name": "openapi.TaskGenerationResult.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/openapi.TaskGenerationResult.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "openapi.TaskGenerationResult": { "title": "Openapi:Task Generation Result", "description": "Provides information about the status of the tasks created for a TaskGenerationRequest.", "x-allOf-name": "openapi.TaskGenerationResult", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'openapi.TaskGenerationResult', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "openapi.TaskGenerationResult" ], "default": "openapi.TaskGenerationResult", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "openapi.TaskGenerationResult" ], "default": "openapi.TaskGenerationResult", "x-enum-as-string": true }, "FailureReason": { "description": "An error message for when task creation fails.", "type": "string", "readOnly": true, "x-omitempty": true }, "TaskDisplayName": { "description": "The display label of the task that is created.", "type": "string", "readOnly": true, "x-omitempty": true }, "TaskName": { "description": "The name of the task that is created.", "type": "string", "readOnly": true, "x-omitempty": true }, "TaskStatus": { "description": "Denotes the status of the task creation.\n* `none` - Indicates the default status\n* `InProgress` - Indicates that operation is in progress\n* `Completed` - Indicates that the operation is complete\n* `Failed` - Indicates that the operation has failed. Check the failureReason attribute for more details.", "type": "string", "enum": [ "none", "InProgress", "Completed", "Failed" ], "default": "none", "readOnly": true, "x-omitempty": true }, "TaskVersion": { "description": "The version number of the created tasks.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "TaskGenerationRequest": { "$ref": "#/components/schemas/openapi.TaskGenerationRequest.Relationship", "description": "A reference to a openapiTaskGenerationRequest resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "openapi.TaskGenerationResult.List": { "title": "List of 'openapi.TaskGenerationResult' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'openapi.TaskGenerationResult' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'openapi.TaskGenerationResult' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/openapi.TaskGenerationResult" }, "nullable": true } } } ] }, "oprs.Deployment.Response": { "description": "The response body of a HTTP GET request for the 'oprs.Deployment' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'oprs.Deployment' resources.", "x-one-of-name": "oprs.Deployment.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/oprs.Deployment.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "oprs.Deployment": { "title": "Oprs:Deployment", "description": "The Deployment object monitors the status of operators deployed within the assist environment. This provides insights into the operational health and configuration of deployed agents.\n#### Purpose\nDeployment is designed to ensure the continuous monitoring and management of operator deployments, providing real-time status updates and facilitating proactive maintenance.\n#### Key Concepts\n- **Status Monitoring:** Tracks the health and operational status of deployed agents.\n- **Access Control:** Utilizes privilege sets to regulate monitoring operations and ensure secure data handling.", "x-allOf-name": "oprs.Deployment", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'oprs.Deployment', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "oprs.Deployment" ], "default": "oprs.Deployment", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "oprs.Deployment" ], "default": "oprs.Deployment", "x-enum-as-string": true }, "AvailableReplicas": { "description": "Available number of replicas.", "type": "integer", "format": "int64", "x-omitempty": true }, "DesiredReplicas": { "description": "The expected number of replicas.", "type": "integer", "format": "int64", "x-omitempty": true }, "Event": { "description": "The type of event which was triggered.", "type": "string", "x-omitempty": true }, "Labels": { "type": "array", "items": { "description": "A simple key value pair type.", "$ref": "#/components/schemas/oprs.Kvpair", "x-omitempty": true }, "nullable": true }, "Name": { "description": "Agent name for which the event is triggered.", "type": "string", "x-omitempty": true }, "Namespace": { "description": "Name space in which the agents are running.", "type": "string", "x-omitempty": true }, "Status": { "description": "Status which shows if the resource is healthy or not.\n* `` - An Unknown status indicates that the resource status is not known.\n* `Healthy` - A healthy status indicates that the resource is healthy and running as per spec.\n* `Unhealthy` - An unhealthy status indicates that the resource is down.", "type": "string", "enum": [ "", "Healthy", "Unhealthy" ], "default": "", "x-omitempty": true }, "TimeStamp": { "description": "The time at which the event was generated. Date is accurate to Intersights clock. This time will be used to identify order of events.", "type": "string", "format": "date-time", "x-omitempty": true }, "UnavailableReplicas": { "description": "Number of replicas Unavailable.", "type": "integer", "format": "int64", "x-omitempty": true }, "Assist": { "$ref": "#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." } } } ] }, "oprs.Deployment.List": { "title": "List of 'oprs.Deployment' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'oprs.Deployment' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'oprs.Deployment' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/oprs.Deployment" }, "nullable": true } } } ] }, "oprs.Kvpair": { "title": "Oprs:Kvpair", "description": "A simple key value pair type.", "x-allOf-name": "oprs.Kvpair", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'oprs.Kvpair', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "oprs.Kvpair" ], "default": "oprs.Kvpair", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "oprs.Kvpair" ], "default": "oprs.Kvpair", "x-enum-as-string": true }, "Key": { "description": "Name of the property which is used as key.", "type": "string", "x-omitempty": true }, "Value": { "description": "Value of the property corresponding to the key.", "type": "string", "x-omitempty": true } } } ] }, "oprs.SyncTargetListMessage.Response": { "description": "The response body of a HTTP GET request for the 'oprs.SyncTargetListMessage' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'oprs.SyncTargetListMessage' resources.", "x-one-of-name": "oprs.SyncTargetListMessage.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/oprs.SyncTargetListMessage.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "oprs.SyncTargetListMessage": { "title": "Oprs:Sync Target List Message", "description": "The SyncTargetListMessage object manages the synchronization of target lists between assist environments and Euclid for reconciliation purposes. It ensures consistent data exchange and alignment of target configurations.\n#### Purpose\nSyncTargetListMessage is designed to streamline the synchronization process, facilitating accurate and timely data updates between interconnected systems.\n#### Key Concepts\n- **Data Synchronization:** Coordinates the exchange and alignment of target lists across systems.\n- **Access Control:** Employs privilege sets to manage permissions and ensure secure data exchange.", "x-allOf-name": "oprs.SyncTargetListMessage", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'oprs.SyncTargetListMessage', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "oprs.SyncTargetListMessage" ], "default": "oprs.SyncTargetListMessage", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "oprs.SyncTargetListMessage" ], "default": "oprs.SyncTargetListMessage", "x-enum-as-string": true }, "AssistId": { "description": "The unique id of the assist which is associated with this message.", "type": "string", "x-omitempty": true }, "TargetType": { "description": "The target type for which this sync message is meant for.\n* `` - An unrecognized platform type.\n* `APIC` - A Cisco Application Policy Infrastructure Controller (APIC) cluster.\n* `CAPIC` - A Cisco Cloud Application Policy Infrastructure Controller (Cloud APIC) instance.\n* `DCNM` - A Cisco Data Center Network Manager (DCNM) instance.\n* `UCSFI` - A Cisco UCS Fabric Interconnect that is managed by Cisco UCS Manager (UCSM).\n* `UCSFIISM` - A Cisco UCS Fabric Interconnect that is managed by Cisco Intersight.\n* `IMC` - A standalone Cisco UCS rack server (Deprecated).\n* `IMCM4` - A standalone Cisco UCS C-Series or S-Series M4 server.\n* `IMCM5` - A standalone Cisco UCS C-Series or S-Series M5 server.\n* `IMCRack` - A standalone Cisco UCS C-Series or S-Series M6 or newer server.\n* `UCSIOM` - A Cisco UCS Blade Chassis I/O Module (IOM).\n* `UCSPCIeNODE` - A Cisco UCS PCIe Node in a blade form factor.\n* `UCSXFM` - A Cisco UCS Fabric Extender Module (XFM).\n* `HX` - A Cisco HyperFlex (HX) cluster.\n* `UCSD` - A Cisco UCS Director (UCSD) instance.\n* `UCSXECMC` - A Cisco UCSXE Chassis Management Controller.\n* `UCSXESecureRouter` - A secure networking router node designed to operate as part of a UCSXE chassis.\n* `IntersightAppliance` - A Cisco Intersight Connected Virtual Appliance instance.\n* `IntersightAssist` - A Cisco Intersight Assist instance.\n* `PureStorageFlashArray` - A Pure Storage FlashArray that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer and storage management features are supported on this device.\n* `PureStorageFlashBladeSystem` - A Pure Storage FlashBlade target that is managed using Cisco Intersight Assist. Storage management feature is supported on this device.\n* `NexusDevice` - A Cisco Nexus Network Switch that is managed using Cisco Intersight Assist.\n* `ACISwitch` - A Cisco Nexus Network Switch with the embedded Device Connector and is a part of the Cisco ACI fabric.\n* `NexusSwitch` - A standalone Cisco Nexus Network Switch with the embedded Device Connector.\n* `MDSSwitch` - A Cisco MDS Switch that is managed using the embedded Device Connector.\n* `MDSDevice` - A Cisco MDS Switch that is managed using Cisco Intersight Assist.\n* `UCSC885` - A standalone Cisco UCS C885 Server.\n* `CAI845A` - A standalone Cisco AI 845A Server.\n* `UCSC890` - A standalone Cisco UCS C890 server managed using Cisco Intersight Assist.\n* `RedfishServer` - A generic target type for servers that support Redfish APIs and is managed using Cisco Intersight Assist. Support is limited to HPE and Dell Servers.\n* `NetAppOntap` - A Netapp ONTAP Storage system that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this device.\n* `NetAppActiveIqUnifiedManager` - A NetApp Active IQ Unified Manager (AIQUM) that is managed using Cisco Intersight Assist.\n* `EmcScaleIo` - An EMC ScaleIO Software Defined Storage system that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this device.\n* `EmcVmax` - An EMC VMAX 2 or 3 series enterprise storage array that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this device.\n* `EmcVplex` - An EMC VPLEX virtual storage system that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this device.\n* `EmcXtremIo` - An EMC XtremIO SSD storage system that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this device.\n* `VmwareVcenter` - A VMware vCenter instance that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer and Virtualization features are supported on this hypervisor.\n* `MicrosoftHyperV` - A Microsoft Hyper-V host that is managed using Cisco Intersight Assist. Optionally, other hosts in the cluster can be discovered through this host. Cisco Intersight Workload Optimizer features are supported on this hypervisor.\n* `AppDynamics` - An AppDynamics controller running in a SaaS or on-prem datacenter. On-prem AppDynamics instance is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this controller.\n* `Dynatrace` - A Dynatrace Server instance running in a SaaS or on-prem datacenter. On-prem Dynatrace instance is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this server.\n* `NewRelic` - A NewRelic user account. The NewRelic instance monitors the application infrastructure. Cisco Intersight Workload Optimizer features are supported on this server.\n* `ServiceNow` - A cloud-based workflow automation platform that enables enterprise organizations to improve operational efficiencies by streamlining and automating routine work tasks.\n* `Umbrella` - Umbrella cloud target that discovers and monitors an organization. It discovers entities like Datacenters, Devices, Tunnels, Networks, etc.\n* `CloudFoundry` - An open source cloud platform on which developers can build, deploy, run and scale applications.\n* `MicrosoftAzureApplicationInsights` - A feature of Azure Monitor, is an extensible Application Performance Management service for developers and DevOps professionals to monitor their live applications.\n* `OpenStack` - An OpenStack target manages Virtual Machines, Physical Machines, Datacenters and Virtual Datacenters using different OpenStack services as administrative endpoints.\n* `MicrosoftSqlServer` - A Microsoft SQL database server that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this database.\n* `MySqlServer` - A MySQL database server that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this database.\n* `OracleDatabaseServer` - An Oracle database server that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this database.\n* `IBMWebSphereApplicationServer` - An IBM WebSphere Application server that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this application server.\n* `OracleWebLogicServer` - Oracle WebLogic Server is a unified and extensible platform for developing, deploying and running enterprise applications, such as Java, for on-premises and in the cloud. WebLogic Server offers a robust, mature, and scalable implementation of Java Enterprise Edition (EE) and Jakarta EE.\n* `ApacheTomcatServer` - An Apache Tomcat server that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this server.\n* `JavaVirtualMachine` - A JVM Application with JMX configured that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this application.\n* `RedHatJBossApplicationServer` - JBoss Application Server is an open-source, cross-platform Java application server developed by JBoss, a division of Red Hat Inc. It is an open-source implementation of Java 2 Enterprise Edition (J2EE) that is used for implementing Java applications and other Web-based applications and software.\n* `Kubernetes` - A Kubernetes cluster that runs containerized applications, with Kubernetes Collector installed. Cisco Intersight Workload Optimizer features are supported on Kubernetes cluster.\n* `AmazonWebService` - An Amazon Web Service cloud account. Cisco Intersight Workload Optimizer and Virtualization features are supported on this cloud.\n* `AmazonWebServiceBilling` - An Amazon Web Service cloud billing account used to retrieve billing information stored in S3 bucket. Cisco Intersight Workload Optimizer features are supported on this cloud.\n* `GoogleCloudPlatform` - A Google Cloud Platform service account with access to one or more projects. Cisco Intersight Workload Optimizer features are supported on this cloud.\n* `GoogleCloudPlatformBilling` - A Google Cloud Platform service account used to retrieve billing information from BigQuery. Cisco Intersight Workload Optimizer features are supported on this cloud.\n* `MicrosoftAzureServicePrincipal` - A Microsoft Azure Service Principal account with access to Azure subscriptions. Cisco Intersight Workload Optimizer features are supported on this cloud.\n* `MicrosoftAzureEnterpriseAgreement` - A Microsoft Azure Enterprise Agreement enrolment used to retrieve pricing and billing information. Cisco Intersight Workload Optimizer features are supported on this cloud.\n* `MicrosoftAzureBilling` - A Microsoft Azure Service Principal account with access to billing information. Cisco Intersight Workload Optimizer features are supported on this cloud.\n* `DellCompellent` - A Dell EMC SC Series (Compellent) storage system that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this device.\n* `HPE3Par` - A HPE 3PAR StoreServ system that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this device.\n* `RedHatEnterpriseVirtualization` - A Red Hat Enterprise Virtualization Hypervisor system that manages Virtual Machines.\n* `NutanixAcropolis` - A Nutanix Acropolis cluster that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this cluster.\n* `NutanixPrismCentral` - A Nutanix Prism Central cluster. Prism central is a virtual appliance for managing Nutanix clusters and services.\n* `HPEOneView` - A HPE OneView system that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this system.\n* `ServiceEngine` - Cisco Application Services Engine. Cisco Application Services Engine is a platform to deploy and manage applications.\n* `HitachiVirtualStoragePlatform` - A Hitachi Virtual Storage Platform (Hitachi VSP) that is managed using Cisco Intersight Assist.\n* `GenericTarget` - A generic third-party target supported only in Partner Integration Appliance. This target type is used for development purposes and will not be supported in production environment.\n* `IMCBlade` - A Cisco UCS blade server managed by Cisco Intersight.\n* `TerraformCloud` - A Terraform Cloud Business Tier account.\n* `TerraformAgent` - A Terraform Cloud Agent that will be deployed on Cisco Intersight Assist. The agent can be used to plan and apply Terraform runs from a Terraform Cloud workspace.\n* `CustomTarget` - CustomTarget is deprecated. Use HTTPEndpoint type to claim HTTP endpoints.\n* `AnsibleEndpoint` - An external endpoint that is added as a target which can be accessed through Ansible in Intersight Cloud Orchestrator automation workflows.\n* `HTTPEndpoint` - An HTTP endpoint that can be accessed in Intersight Orchestrator workflows directly or using Cisco Intersight Assist. Authentication Schemes supported are Basic and Bearer Token.\n* `SSHEndpoint` - An SSH endpoint that can be accessed in Intersight Orchestrator workflows using Cisco Intersight Assist.\n* `CiscoCatalyst` - A Cisco Catalyst networking switch device.\n* `PowerShellEndpoint` - A Windows operating system server on which PowerShell scripts can be executed using Cisco Intersight Assist.\n* `CiscoDNAC` - A Cisco Digital Network Architecture (DNA) Center appliance.\n* `CiscoFMC` - A Cisco Secure Firewall Management Center.\n* `ViptelaCloud` - ViptelaCloud is deprecated. Use CatalystSDWANManager type to claim Catalyst SDWAN Manager which can manage Catalyst SDWAN devices.\n* `CatalystSDWANManager` - A Cisco Catalyst SD-WAN Manager.\n* `MerakiCloud` - A Cisco Meraki Organization.\n* `CiscoISE` - A Cisco Identity Services Engine (ISE) target.", "type": "string", "enum": [ "", "APIC", "CAPIC", "DCNM", "UCSFI", "UCSFIISM", "IMC", "IMCM4", "IMCM5", "IMCRack", "UCSIOM", "UCSPCIeNODE", "UCSXFM", "HX", "UCSD", "UCSXECMC", "UCSXESecureRouter", "IntersightAppliance", "IntersightAssist", "PureStorageFlashArray", "PureStorageFlashBladeSystem", "NexusDevice", "ACISwitch", "NexusSwitch", "MDSSwitch", "MDSDevice", "UCSC885", "CAI845A", "UCSC890", "RedfishServer", "NetAppOntap", "NetAppActiveIqUnifiedManager", "EmcScaleIo", "EmcVmax", "EmcVplex", "EmcXtremIo", "VmwareVcenter", "MicrosoftHyperV", "AppDynamics", "Dynatrace", "NewRelic", "ServiceNow", "Umbrella", "CloudFoundry", "MicrosoftAzureApplicationInsights", "OpenStack", "MicrosoftSqlServer", "MySqlServer", "OracleDatabaseServer", "IBMWebSphereApplicationServer", "OracleWebLogicServer", "ApacheTomcatServer", "JavaVirtualMachine", "RedHatJBossApplicationServer", "Kubernetes", "AmazonWebService", "AmazonWebServiceBilling", "GoogleCloudPlatform", "GoogleCloudPlatformBilling", "MicrosoftAzureServicePrincipal", "MicrosoftAzureEnterpriseAgreement", "MicrosoftAzureBilling", "DellCompellent", "HPE3Par", "RedHatEnterpriseVirtualization", "NutanixAcropolis", "NutanixPrismCentral", "HPEOneView", "ServiceEngine", "HitachiVirtualStoragePlatform", "GenericTarget", "IMCBlade", "TerraformCloud", "TerraformAgent", "CustomTarget", "AnsibleEndpoint", "HTTPEndpoint", "SSHEndpoint", "CiscoCatalyst", "PowerShellEndpoint", "CiscoDNAC", "CiscoFMC", "ViptelaCloud", "CatalystSDWANManager", "MerakiCloud", "CiscoISE" ], "default": "", "x-omitempty": true }, "Targets": { "type": "array", "items": { "description": "The list of targets for which this sync message is meant for.", "type": "string", "x-omitempty": true }, "nullable": true }, "TimeStamp": { "description": "The time at which the event was generated. Date is accurate to Intersights clock. This time will be used to identify order of events.", "type": "string", "format": "date-time", "x-omitempty": true }, "Assist": { "$ref": "#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." } } } ] }, "oprs.SyncTargetListMessage.List": { "title": "List of 'oprs.SyncTargetListMessage' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'oprs.SyncTargetListMessage' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'oprs.SyncTargetListMessage' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/oprs.SyncTargetListMessage" }, "nullable": true } } } ] }, "organization.Organization.Response": { "description": "The response body of a HTTP GET request for the 'organization.Organization' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'organization.Organization' resources.", "x-one-of-name": "organization.Organization.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/organization.Organization.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "organization.Organization.Relationship": { "description": "A relationship to the 'organization.Organization' resource, or the expanded 'organization.Organization' resource, or the 'null' value.", "x-one-of-name": "organization.Organization.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/organization.Organization" } ], "discriminator": { "propertyName": "ClassId" } }, "organization.Organization": { "title": "Organization", "description": "Organization provides multi-tenancy within an account. Multiple organizations can be present under an account. Resources are associated to organization using resource groups. Organization can have heterogeneous resources. Resources can be shared among multiple organizations. Organizations are associated to user permissions and privileges can be specified to provide access control. User can have access to multiple organizations in same permission and with different privileges on each organization.", "x-allOf-name": "organization.Organization", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'organization.Organization', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "organization.Organization" ], "default": "organization.Organization", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "organization.Organization" ], "default": "organization.Organization", "x-enum-as-string": true }, "Description": { "description": "The informative description about the usage of this organization.", "type": "string", "x-omitempty": true }, "Name": { "description": "The name of the organization. There can be multiple organizations under an account.", "type": "string", "pattern": "^[a-zA-Z0-9_.:-]{1,64}$", "minLength": 1, "maxLength": 64, "x-omitempty": true }, "Account": { "$ref": "#/components/schemas/iam.Account.Relationship", "description": "A reference to a iamAccount resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "ResourceGroups": { "description": "An array of relationships to resourceGroup resources.", "type": "array", "items": { "$ref": "#/components/schemas/resource.Group.Relationship" }, "nullable": true }, "SharedWithResources": { "description": "An array of relationships to moBaseMo resources.", "type": "array", "items": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo.Relationship" }, "nullable": true, "readOnly": true } } } ] }, "organization.Organization.List": { "title": "List of 'organization.Organization' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'organization.Organization' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'organization.Organization' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/organization.Organization" }, "nullable": true } } } ] }, "resource.AbstractReservation": { "title": "Resource:Abstract Reservation", "description": "You can reserve resources for use cases related to Pools or Groups. For example, resources that are decommissioned or reserved for future allocation are maintained in the Reservation model, where AbstractReservation serves as the base class for reservations.", "x-allOf-name": "resource.AbstractReservation", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'resource.AbstractReservation', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "resource.Reservation", "resourcepool.MembershipReservation" ], "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "resource.Reservation", "resourcepool.MembershipReservation" ], "x-enum-as-string": true }, "Description": { "description": "Details of the use case for which the reservation was created, such as decommissioning.", "type": "string", "x-createOnly": true, "x-omitempty": true }, "Expiration": { "description": "The resource reservation includes an expiration date and a timestamp indicating when this management object will be cleared. The expiration date is set during the decommissioning process and is maintained for a period of 3 months.", "type": "string", "format": "date-time", "x-createOnly": true, "x-omitempty": true }, "ReservationSelector": { "description": "The unique identification of the resource is based on the resource OData string, which is mentioned as part of the ReservationSelector. For example, 'Serial eq 'EM6259AE6B'.", "type": "string", "x-createOnly": true, "x-omitempty": true }, "ResourceType": { "description": "The type of resource that is placed into resource groups or pools. Resource Type can be either 'compute.Blade' or 'compute.RackUnit' for pools.", "type": "string", "x-createOnly": true, "x-omitempty": true }, "Status": { "description": "The reservation status can be in the 'Created', 'Processing', 'Failed', or 'Finished' state.\n* `Created` - By default, a reservation is in Created status.\n* `Processing` - A reservation is changed to Processing status for appliance mode resource claim requests.\n* `Failed` - A reservation is changed to Failed status if the validations on resources, resource groups fails.\n* `Finished` - A reservation is changed to Finished status if the validations on resources, resource groups are successful. The resource moids in reservation will be added to resource groups using OData filters.", "type": "string", "enum": [ "Created", "Processing", "Failed", "Finished" ], "default": "Created", "readOnly": true, "x-omitempty": true }, "Identity": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo.Relationship", "description": "A reference to a moBaseMo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true } } } ] }, "resource.AbstractResourceQualificationPolicy.Relationship": { "description": "A relationship to the 'resource.AbstractResourceQualificationPolicy' resource, or the expanded 'resource.AbstractResourceQualificationPolicy' resource, or the 'null' value.", "x-one-of-name": "resource.AbstractResourceQualificationPolicy.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/resource.AbstractResourceQualificationPolicy" } ], "discriminator": { "propertyName": "ClassId" } }, "resource.AbstractResourceQualificationPolicy": { "title": "Resource:Abstract Resource Qualification Policy", "description": "The base QualificationPolicy extends from AbstractPolicy; all qualification policies will be derived from this class. For example, ServerPoolQualificationPolicy.", "x-allOf-name": "resource.AbstractResourceQualificationPolicy", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractPolicy" }, { "type": "object", "description": "Definition of the list of properties defined in 'resource.AbstractResourceQualificationPolicy', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "resourcepool.ChassisQualificationPolicy", "resourcepool.QualificationPolicy" ], "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "resourcepool.ChassisQualificationPolicy", "resourcepool.QualificationPolicy" ], "x-enum-as-string": true }, "Qualifiers": { "type": "array", "items": { "description": "Set of conditions to qualify the servers.", "$ref": "#/components/schemas/resource.ResourceQualifier", "x-omitempty": true }, "nullable": true } } } ] }, "resource.AdaptorsRangeFilter": { "title": "Adaptors Range Over Value", "description": "Consist of two boundaries that define the range, namely the minimum and the maximum adaptors value.", "x-allOf-name": "resource.AdaptorsRangeFilter", "allOf": [ { "$ref": "#/components/schemas/resource.RangeFilter" }, { "type": "object", "description": "Definition of the list of properties defined in 'resource.AdaptorsRangeFilter', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "resource.AdaptorsRangeFilter" ], "default": "resource.AdaptorsRangeFilter", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "resource.AdaptorsRangeFilter" ], "default": "resource.AdaptorsRangeFilter", "x-enum-as-string": true }, "MaxValue": { "description": "Maximum value for the range limit. It should be greater than the minimum value.", "type": "integer", "format": "int64", "default": 0, "maximum": 16, "x-omitempty": true }, "MinValue": { "description": "Minimum value for the range limit.", "type": "integer", "format": "int64", "default": 0, "maximum": 16, "x-omitempty": true } } } ] }, "resource.AdvancedFilter": { "title": "Advanced Filter", "description": "Advanced filter property holder.", "x-allOf-name": "resource.AdvancedFilter", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'resource.AdvancedFilter', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "resource.AdaptorsRangeFilter", "resource.ChassisIdRangeFilter", "resource.CpuCoreRangeFilter", "resource.CpuSpeedRangeFilter", "resource.GpuControllersRangeFilter", "resource.MemoryCapacityRangeFilter", "resource.MemoryUnitsRangeFilter", "resource.RackIdRangeFilter", "resource.SlotIdRangeFilter" ], "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "resource.AdaptorsRangeFilter", "resource.ChassisIdRangeFilter", "resource.CpuCoreRangeFilter", "resource.CpuSpeedRangeFilter", "resource.GpuControllersRangeFilter", "resource.MemoryCapacityRangeFilter", "resource.MemoryUnitsRangeFilter", "resource.RackIdRangeFilter", "resource.SlotIdRangeFilter" ], "x-enum-as-string": true }, "ConditionType": { "description": "Filter condition to extract the resource.\n* `RANGE` - Condition matches with range over value.", "type": "string", "enum": [ "RANGE" ], "default": "RANGE", "x-omitempty": true } } } ] }, "resource.BladeQualifier": { "title": "Blade Qualifier", "description": "The BladeQualifier object is focused on qualifying blade servers based on various chassis and slot properties. It extends the ServerQualifier, offering detailed criteria for server selection within blade environments.\n#### Purpose\nBladeQualifier provides a comprehensive framework for assessing blade servers, using chassis IDs, slot IDs, and PID attributes. It ensures that blade resources align with operational requirements and optimizes server pool management.\n#### Key Concepts\n- **Chassis and Slot-Based Filtering:** Enables resource qualification based on specific physical attributes, enhancing resource allocation precision.\n- **PID Integration:** Incorporates PID criteria to improve qualification accuracy and streamline server management.\n- **Resource Optimization:** Promotes efficient blade server utilization by aligning resources with specified qualification parameters.", "x-allOf-name": "resource.BladeQualifier", "allOf": [ { "$ref": "#/components/schemas/resource.ServerQualifier" }, { "type": "object", "description": "Definition of the list of properties defined in 'resource.BladeQualifier', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "resource.BladeQualifier" ], "default": "resource.BladeQualifier", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "resource.BladeQualifier" ], "default": "resource.BladeQualifier", "x-enum-as-string": true }, "ChassisAndSlotIdRange": { "type": "array", "items": { "description": "The server is qualified based on the chassis ID and slot ID. For example, if the conditions are such that ChassisId is in the range of 1-4 and SlotIds are in the ranges of 1-3 and 4-6, then the server matches the ChassisId and SlotId conditions, making it eligible for the pool.", "$ref": "#/components/schemas/resource.ChassisAndSlotQualification", "x-omitempty": true }, "maxItems": 20, "nullable": true }, "ChassisPids": { "type": "array", "items": { "description": "The chassis and Unified Edge PID based condition qualifies the server into the pool.", "type": "string", "x-omitempty": true }, "maxItems": 20, "nullable": true } } } ] }, "resource.ChassisAndSlotQualification": { "title": "Chassis and Slot ID Qualification", "description": "The server is qualified based on the chassis ID and slot ID. For example, if the conditions are such that ChassisId is in the range of 1-4 and SlotIds are in the ranges of 1-3 and 4-6, then the server matches the ChassisId and SlotId conditions, making it eligible for the pool.", "x-allOf-name": "resource.ChassisAndSlotQualification", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'resource.ChassisAndSlotQualification', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "resource.ChassisAndSlotQualification" ], "default": "resource.ChassisAndSlotQualification", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "resource.ChassisAndSlotQualification" ], "default": "resource.ChassisAndSlotQualification", "x-enum-as-string": true }, "ChassisIdRange": { "description": "The server qualification condition based on the ChassisId range.", "$ref": "#/components/schemas/resource.ChassisIdRangeFilter", "x-omitempty": true }, "SlotIdRanges": { "type": "array", "items": { "description": "The server qualification condition based on the SlotId ranges.", "$ref": "#/components/schemas/resource.SlotIdRangeFilter", "x-omitempty": true }, "maxItems": 20, "nullable": true } } } ] }, "resource.ChassisIdRangeFilter": { "title": "Chassis ID Range Over Value", "description": "Consist of two boundaries that define the range, namely the minimum and the maximum value.", "x-allOf-name": "resource.ChassisIdRangeFilter", "allOf": [ { "$ref": "#/components/schemas/resource.RangeFilter" }, { "type": "object", "description": "Definition of the list of properties defined in 'resource.ChassisIdRangeFilter', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "resource.ChassisIdRangeFilter" ], "default": "resource.ChassisIdRangeFilter", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "resource.ChassisIdRangeFilter" ], "default": "resource.ChassisIdRangeFilter", "x-enum-as-string": true }, "MaxValue": { "description": "Maximum value for the range limit. It should be greater than the minimum value.", "type": "integer", "format": "int64", "default": 0, "maximum": 40, "x-omitempty": true }, "MinValue": { "description": "Minimum value for the range limit.", "type": "integer", "format": "int64", "default": 0, "maximum": 40, "x-omitempty": true } } } ] }, "resource.ChassisServersQualifier": { "title": "Resource:Chassis Servers Qualifier", "description": "Resources are added to the pool based on characteristics of servers like slotId of server connected to chassis.", "x-allOf-name": "resource.ChassisServersQualifier", "allOf": [ { "$ref": "#/components/schemas/resource.ResourceQualifier" }, { "type": "object", "description": "Definition of the list of properties defined in 'resource.ChassisServersQualifier', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "resource.ChassisServersQualifier" ], "default": "resource.ChassisServersQualifier", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "resource.ChassisServersQualifier" ], "default": "resource.ChassisServersQualifier", "x-enum-as-string": true }, "SlotIds": { "type": "array", "items": { "description": "Collection of slotId that server present in it.", "type": "integer", "format": "int64", "x-omitempty": true }, "nullable": true } } } ] }, "resource.CpuCoreRangeFilter": { "title": "CPU Core Range Over Value", "description": "Consist of two boundaries that define the range, namely the minimum and the maximum CPU core value.", "x-allOf-name": "resource.CpuCoreRangeFilter", "allOf": [ { "$ref": "#/components/schemas/resource.RangeFilter" }, { "type": "object", "description": "Definition of the list of properties defined in 'resource.CpuCoreRangeFilter', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "resource.CpuCoreRangeFilter" ], "default": "resource.CpuCoreRangeFilter", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "resource.CpuCoreRangeFilter" ], "default": "resource.CpuCoreRangeFilter", "x-enum-as-string": true }, "MaxValue": { "description": "Maximum value for the range limit. It should be greater than minimum value.", "type": "integer", "format": "int64", "default": 0, "maximum": 9999, "x-omitempty": true }, "MinValue": { "description": "Minimum value for the range limit.", "type": "integer", "format": "int64", "default": 0, "maximum": 9999, "x-omitempty": true } } } ] }, "resource.CpuSpeedRangeFilter": { "title": "CPU Speed Range Over Value", "description": "Consist of two boundaries that define the range, namely the minimum and the maximum CPU speed value.", "x-allOf-name": "resource.CpuSpeedRangeFilter", "allOf": [ { "$ref": "#/components/schemas/resource.RangeFilter" }, { "type": "object", "description": "Definition of the list of properties defined in 'resource.CpuSpeedRangeFilter', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "resource.CpuSpeedRangeFilter" ], "default": "resource.CpuSpeedRangeFilter", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "resource.CpuSpeedRangeFilter" ], "default": "resource.CpuSpeedRangeFilter", "x-enum-as-string": true }, "MaxValue": { "description": "Maximum value for the range limit. It should be greater than the minimum value.", "type": "integer", "format": "int64", "default": 0, "maximum": 99, "x-omitempty": true }, "MinValue": { "description": "Minimum value for the range limit.", "type": "integer", "format": "int64", "default": 0, "maximum": 99, "x-omitempty": true } } } ] }, "resource.DomainQualifier": { "title": "Network Qualifier", "description": "The DomainQualifier object is designed to qualify or filter servers based on domain-specific properties. It extends the ResourceQualifier, allowing more precise targeting and selection of resources within a network infrastructure.\n#### Purpose\nThe DomainQualifier serves to refine server selection by using domain-related attributes. This provides a mechanism to match resources based on domain names and fabric interconnect product IDs (PIDs), facilitating efficient resource allocation and management.\n#### Key Concepts\n- **Domain-Based Filtering:** Allows for resource selection based on domain properties, ensuring that servers meet specific domain criteria.\n- **Fabric Interconnect PIDs:** Utilizes PID attributes to enhance qualification, supporting targeted resource management.\n- **Extensibility:** As a concrete extension of ResourceQualifier, it integrates seamlessly with other resource qualification frameworks.", "x-allOf-name": "resource.DomainQualifier", "allOf": [ { "$ref": "#/components/schemas/resource.ResourceQualifier" }, { "type": "object", "description": "Definition of the list of properties defined in 'resource.DomainQualifier', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "resource.DomainQualifier" ], "default": "resource.DomainQualifier", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "resource.DomainQualifier" ], "default": "resource.DomainQualifier", "x-enum-as-string": true }, "DomainNames": { "type": "array", "items": { "description": "The resource is qualified based on the 'Host name' property.", "type": "string", "x-omitempty": true }, "maxItems": 100, "nullable": true }, "FabricInterConnectPids": { "type": "array", "items": { "description": "The resource is qualified based on the PID property of 'Fabric Interconnects' or Unified Edge. For example, the condition PID in ('UCS-FI-6536', 'UCS-FI-7888', 'UCSXE-ECMC-G1').", "type": "string", "x-omitempty": true }, "maxItems": 20, "nullable": true } } } ] }, "resource.GpuControllersRangeFilter": { "title": "GPU Controller Range Over Value", "description": "Consist of two boundaries that define the range, namely the minimum and the maximum GPU controller value.", "x-allOf-name": "resource.GpuControllersRangeFilter", "allOf": [ { "$ref": "#/components/schemas/resource.RangeFilter" }, { "type": "object", "description": "Definition of the list of properties defined in 'resource.GpuControllersRangeFilter', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "resource.GpuControllersRangeFilter" ], "default": "resource.GpuControllersRangeFilter", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "resource.GpuControllersRangeFilter" ], "default": "resource.GpuControllersRangeFilter", "x-enum-as-string": true }, "MaxValue": { "description": "Maximum value for the range limit. It should be greater than minimum value.", "type": "integer", "format": "int64", "default": 0, "maximum": 16, "x-omitempty": true }, "MinValue": { "description": "Minimum value for the range limit.", "type": "integer", "format": "int64", "default": 0, "maximum": 16, "x-omitempty": true } } } ] }, "resource.GpuQualifier": { "title": "GPU Qualification.", "description": "The GpuQualifier object focuses on qualifying resources based on GPU characteristics. It extends the HardwareQualifier, providing criteria for resource selection related to GPU capabilities, including adaptors, vendor, and evaluation type.\n#### Purpose\nGpuQualifier aids in the precise filtering of resources by evaluating GPU attributes. It ensures that resources meet GPU-related requirements, optimizing resource allocation and performance within environments requiring graphical processing capabilities.\n#### Key Concepts\n- **GPU-Based Qualification:** Concentrates on GPU controller range, adaptors, and vendor attributes for resource selection.\n- **Evaluation Type Integration:** Utilizes GPU evaluation type to refine qualification processes, enhancing resource management.\n- **Extensibility:** Seamlessly integrates with other hardware qualification objects for comprehensive resource management solutions.", "x-allOf-name": "resource.GpuQualifier", "allOf": [ { "$ref": "#/components/schemas/resource.HardwareQualifier" }, { "type": "object", "description": "Definition of the list of properties defined in 'resource.GpuQualifier', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "resource.GpuQualifier" ], "default": "resource.GpuQualifier", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "resource.GpuQualifier" ], "default": "resource.GpuQualifier", "x-enum-as-string": true }, "GpuControllersRange": { "description": "The qualification of resources is based on number of GPU controllers between the minimum and maximum value.", "$ref": "#/components/schemas/resource.GpuControllersRangeFilter", "x-omitempty": true }, "GpuEvaluationType": { "description": "The GPU qualifier used for resource qualification is based on gpuEvaluationType.\n* `ServerWithoutGpu` - It is used to specify the evaluation of a resource without a GPU.\n* `ServerWithGpu` - It is used to specify the evaluation of a resource with a GPU.\n* `Unspecified` - It is used to specify that the GPU qualifier should be ignored for the evaluation of a resource.", "type": "string", "enum": [ "ServerWithoutGpu", "ServerWithGpu", "Unspecified" ], "default": "ServerWithoutGpu", "x-omitempty": true }, "Pids": { "type": "array", "items": { "description": "The qualification of resources is based on PID of GPU that contains in it.", "type": "string", "x-omitempty": true }, "maxItems": 20, "nullable": true }, "Vendor": { "description": "The qualification of resources is based on vendor of GPU.", "type": "string", "x-omitempty": true } } } ] }, "resource.Group.Response": { "description": "The response body of a HTTP GET request for the 'resource.Group' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'resource.Group' resources.", "x-one-of-name": "resource.Group.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/resource.Group.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "resource.Group.Relationship": { "description": "A relationship to the 'resource.Group' resource, or the expanded 'resource.Group' resource, or the 'null' value.", "x-one-of-name": "resource.Group.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/resource.Group" } ], "discriminator": { "propertyName": "ClassId" } }, "resource.Group": { "title": "Resource:Group", "description": "The Group object represents a collection of REST resources within the system, designed to streamline resource management through organized groupings.\n#### Purpose\nA Group is intended to aggregate resources into a single entity, simplifying management tasks such as resource allocation, access control, and membership evaluation. It supports both static and dynamic resource memberships, allowing for flexible and efficient resource grouping.\n#### Key Concepts\n- **Dynamic Memberships:** Allows resources to be grouped dynamically using OData query filters, enhancing flexibility in resource management.\n- **Access Control:** Ensures only authorized users can view or perform actions on Group data.\n- **Resource Aggregation:** Supports the organization of resources into cohesive groups, aiding in resource management and allocation.", "x-allOf-name": "resource.Group", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'resource.Group', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "resource.Group" ], "default": "resource.Group", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "resource.Group" ], "default": "resource.Group", "x-enum-as-string": true }, "Description": { "description": "The informative description about the usage of this Resource Group.", "type": "string", "x-omitempty": true }, "ExportedSelectors": { "type": "array", "items": { "description": "A list of OData filters to select resources. The group selectors may include URLs of individual resources, or OData query with filters that match multiple queries. The URLs must be relative (i.e. do not include the host).", "$ref": "#/components/schemas/resource.Selector", "x-omitempty": true }, "nullable": true }, "Name": { "description": "The name of this resource group.", "type": "string", "pattern": "^[a-zA-Z0-9_.:-]{1,128}$", "minLength": 1, "maxLength": 128, "x-omitempty": true }, "PerTypeCombinedSelector": { "type": "array", "items": { "description": "A single filter expression created by OR'ing the $filter criteria of the 'selectors' of a given object type. Used to efficiently maintain the membership of the group. This filter is maintained per object type in this type.", "$ref": "#/components/schemas/resource.PerTypeCombinedSelector", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Qualifier": { "description": "Qualifier shall be used to specify if we want to organize resources using multiple resource group or single For an account, resource groups can be of only one of the above types. (Both the types are mutually exclusive for an account.).\n* `Allow-Selectors` - Resources will be added to resource groups based on ODATA filter. Multiple resource group can be created to organize resources.\n* `Allow-All` - All resources will become part of the Resource Group. Only one resource group can be created to organize resources.", "type": "string", "enum": [ "Allow-Selectors", "Allow-All" ], "default": "Allow-Selectors", "x-omitempty": true }, "Reevaluate": { "description": "Set Reevaluate to true to reevaluate the group members and memberships of this resource group.", "type": "boolean", "x-omitempty": true }, "Selectors": { "type": "array", "items": { "description": "A list of OData filters to select resources. The group selectors may be include URLs of individual resources, or OData query with filters that match multiple queries. The URLs must be relative (i.e. do not include the host).", "$ref": "#/components/schemas/resource.Selector", "x-omitempty": true }, "nullable": true }, "Type": { "description": "The type of this resource group. (Rbac, Licensing, solution).\n* `rbac` - These resource groups are used for multi-tenancy by assigning to organizations.\n* `licensing` - These resource groups are used to classify resources like servers to various groups which are associated to different license tiers.\n* `solution` - These resource groups are created for Flexpods.", "type": "string", "enum": [ "rbac", "licensing", "solution" ], "default": "rbac", "readOnly": true, "x-omitempty": true }, "Account": { "$ref": "#/components/schemas/iam.Account.Relationship", "description": "A reference to a iamAccount resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Organizations": { "description": "An array of relationships to organizationOrganization resources.", "type": "array", "items": { "$ref": "#/components/schemas/organization.Organization.Relationship" }, "nullable": true } } } ] }, "resource.Group.List": { "title": "List of 'resource.Group' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'resource.Group' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'resource.Group' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/resource.Group" }, "nullable": true } } } ] }, "resource.GroupMember.Response": { "description": "The response body of a HTTP GET request for the 'resource.GroupMember' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'resource.GroupMember' resources.", "x-one-of-name": "resource.GroupMember.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/resource.GroupMember.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "resource.GroupMember": { "title": "Resource:Group Member", "description": "The GroupMember object identifies resolved members within a resource group, providing clarity and organization to resource membership management.\n#### Purpose\nA GroupMember serves as the link between individual resources and their associated groups, ensuring that resources are accurately represented within the system. It simplifies membership management by providing a clear representation of resource-group associations.\n#### Key Concepts\n- **Membership Resolution:** Ensures that resource memberships are accurately resolved and maintained within the system.\n- **Resource References:** Facilitates easy access and management of resources within groups, supporting efficient resource handling.", "x-allOf-name": "resource.GroupMember", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'resource.GroupMember', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "resource.GroupMember" ], "default": "resource.GroupMember", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "resource.GroupMember" ], "default": "resource.GroupMember", "x-enum-as-string": true }, "Group": { "$ref": "#/components/schemas/resource.Group.Relationship", "description": "A reference to a resourceGroup resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Resource": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo.Relationship", "description": "A reference to a moBaseMo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "resource.GroupMember.List": { "title": "List of 'resource.GroupMember' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'resource.GroupMember' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'resource.GroupMember' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/resource.GroupMember" }, "nullable": true } } } ] }, "resource.HardwareQualifier": { "title": "Hardware Qualifier", "description": "The server is filtered into the pool based on specific conditions. The hardware qualifier serves as the base class for memory qualifier, processor qualifier, GPU qualifier and network adaptor qualifier which can be used for filtering resources based on hardware characteristics.", "x-allOf-name": "resource.HardwareQualifier", "allOf": [ { "$ref": "#/components/schemas/resource.ResourceQualifier" } ] }, "resource.LicenseResourceCount.Response": { "description": "The response body of a HTTP GET request for the 'resource.LicenseResourceCount' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'resource.LicenseResourceCount' resources.", "x-one-of-name": "resource.LicenseResourceCount.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/resource.LicenseResourceCount.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "resource.LicenseResourceCount": { "title": "Resource:License Resource Count", "description": "The LicenseResourceCount object tracks the number of resources associated with different licensing tiers, aiding in licensing management and resource allocation.\n#### Purpose\nLicenseResourceCount provides a structured approach to managing licensing information within the system, ensuring that resources are accurately accounted for and associated with appropriate licensing tiers. It supports efficient resource tracking and licensing compliance.\n#### Key Concepts\n- **Licensing Management:** Facilitates the tracking and management of resources based on licensing tiers, aiding in compliance and resource allocation.\n- **Resource Tracking:** Provides accurate counts of resources within each licensing tier, supporting efficient resource management.\n- **Integration:** Seamlessly integrates with resource groups to ensure that licensing information is properly managed and utilized.", "x-allOf-name": "resource.LicenseResourceCount", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'resource.LicenseResourceCount', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "resource.LicenseResourceCount" ], "default": "resource.LicenseResourceCount", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "resource.LicenseResourceCount" ], "default": "resource.LicenseResourceCount", "x-enum-as-string": true }, "LicenseType": { "description": "Type of licensing defined for this resource group. Used for licensing group.\n* `Base` - Base as a License type. It is default license type.\n* `Essential` - Essential as a License type.\n* `Standard` - Standard as a License type.\n* `Advantage` - Advantage as a License type.\n* `Premier` - Premier as a License type.\n* `IWO-Essential` - IWO-Essential as a License type.\n* `IWO-Advantage` - IWO-Advantage as a License type.\n* `IWO-Premier` - IWO-Premier as a License type.\n* `IKS-Advantage` - IKS-Advantage as a License type.\n* `INC-Premier-1GFixed` - Premier 1G Fixed license tier for Intersight Nexus Cloud.\n* `INC-Premier-10GFixed` - Premier 10G Fixed license tier for Intersight Nexus Cloud.\n* `INC-Premier-100GFixed` - Premier 100G Fixed license tier for Intersight Nexus Cloud.\n* `INC-Premier-Mod4Slot` - Premier Modular 4 slot license tier for Intersight Nexus Cloud.\n* `INC-Premier-Mod8Slot` - Premier Modular 8 slot license tier for Intersight Nexus Cloud.\n* `INC-Premier-D2OpsFixed` - Premier D2Ops fixed license tier for Intersight Nexus Cloud.\n* `INC-Premier-D2OpsMod` - Premier D2Ops modular license tier for Intersight Nexus Cloud.\n* `INC-Premier-CentralizedMod8Slot` - Premier modular license tier of switch type CentralizedMod8Slot for Intersight Nexus Cloud.\n* `INC-Premier-DistributedMod8Slot` - Premier modular license tier of switch type DistributedMod8Slot for Intersight Nexus Cloud.\n* `ERP-Advantage` - Advantage license tier for ERP workflows.\n* `IntersightTrial` - Virtual dummy license type to indicate trial. Used for UI display of trial mode Intersight tiers.\n* `IWOTrial` - Virtual dummy license type to indicate trial. Used for UI display of trial mode IKS tiers.\n* `IKSTrial` - Virtual dummy license type to indicate trial. Used for UI display of trial mode IWO tiers.\n* `INCTrial` - Virtual dummy license type to indicate trial. Used for UI display of trial mode Nexus tiers.", "type": "string", "enum": [ "Base", "Essential", "Standard", "Advantage", "Premier", "IWO-Essential", "IWO-Advantage", "IWO-Premier", "IKS-Advantage", "INC-Premier-1GFixed", "INC-Premier-10GFixed", "INC-Premier-100GFixed", "INC-Premier-Mod4Slot", "INC-Premier-Mod8Slot", "INC-Premier-D2OpsFixed", "INC-Premier-D2OpsMod", "INC-Premier-CentralizedMod8Slot", "INC-Premier-DistributedMod8Slot", "ERP-Advantage", "IntersightTrial", "IWOTrial", "IKSTrial", "INCTrial" ], "default": "Base", "readOnly": true, "x-omitempty": true }, "ResourceCount": { "description": "The number of resource belongs to this licensing tier.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Account": { "$ref": "#/components/schemas/iam.Account.Relationship", "description": "A reference to a iamAccount resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "LicenseGroups": { "description": "An array of relationships to resourceGroup resources.", "type": "array", "items": { "$ref": "#/components/schemas/resource.Group.Relationship" }, "nullable": true, "readOnly": true } } } ] }, "resource.LicenseResourceCount.List": { "title": "List of 'resource.LicenseResourceCount' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'resource.LicenseResourceCount' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'resource.LicenseResourceCount' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/resource.LicenseResourceCount" }, "nullable": true } } } ] }, "resource.Membership.Response": { "description": "The response body of a HTTP GET request for the 'resource.Membership' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'resource.Membership' resources.", "x-one-of-name": "resource.Membership.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/resource.Membership.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "resource.Membership": { "title": "Resource:Membership", "description": "ResourceMembership represents a resource's associated groups, organizations and the permissions associated to this resource via organizations.", "x-allOf-name": "resource.Membership", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'resource.Membership', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "resource.Membership" ], "default": "resource.Membership", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "resource.Membership" ], "default": "resource.Membership", "x-enum-as-string": true }, "GroupPermissionRoles": { "type": "array", "items": { "description": "Groups, organizations and their permissions to roles mapping.", "$ref": "#/components/schemas/iam.GroupPermissionToRoles", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Reevaluate": { "description": "Set Reevaluate to true to reevaluate the membership of a resource.", "type": "boolean", "x-omitempty": true }, "TargetApp": { "description": "Name of the Service owning the resource.", "type": "string", "readOnly": true, "x-omitempty": true }, "Holder": { "$ref": "#/components/schemas/resource.MembershipHolder.Relationship", "description": "A reference to a resourceMembershipHolder resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Resource": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo.Relationship", "description": "A reference to a moBaseMo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true }, "ResourceAncestors": { "description": "An array of relationships to moBaseMo resources.", "type": "array", "items": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo.Relationship" }, "nullable": true } } } ] }, "resource.Membership.List": { "title": "List of 'resource.Membership' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'resource.Membership' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'resource.Membership' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/resource.Membership" }, "nullable": true } } } ] }, "resource.MembershipHolder.Response": { "description": "The response body of a HTTP GET request for the 'resource.MembershipHolder' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'resource.MembershipHolder' resources.", "x-one-of-name": "resource.MembershipHolder.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/resource.MembershipHolder.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "resource.MembershipHolder.Relationship": { "description": "A relationship to the 'resource.MembershipHolder' resource, or the expanded 'resource.MembershipHolder' resource, or the 'null' value.", "x-one-of-name": "resource.MembershipHolder.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/resource.MembershipHolder" } ], "discriminator": { "propertyName": "ClassId" } }, "resource.MembershipHolder": { "title": "Resource:Membership Holder", "description": "The MembershipHolder object acts as a container for REST resources and their membership within the system. It plays a crucial role in managing and organizing resources by associating them with specific memberships.\n#### Purpose\nA MembershipHolder serves as the central entity for resource membership management, enabling efficient organization and retrieval of resources based on their membership status. This provides a structured approach to handling resource memberships, supporting multi-tenancy and resource classification.\n#### Key Concepts\n- **Resource Organization:** Facilitates the grouping and classification of resources according to membership criteria.\n- **Access Control:** Ensures that membership data is managed securely, with access restricted to authorized users.\n- **Relationship Management:** Maintains associations between resources and their respective accounts, ensuring consistent and organized membership handling.", "x-allOf-name": "resource.MembershipHolder", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'resource.MembershipHolder', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "resource.MembershipHolder" ], "default": "resource.MembershipHolder", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "resource.MembershipHolder" ], "default": "resource.MembershipHolder", "x-enum-as-string": true }, "Name": { "description": "The name of this resource membership holder.", "type": "string", "readOnly": true, "x-omitempty": true }, "Account": { "$ref": "#/components/schemas/iam.Account.Relationship", "description": "A reference to a iamAccount resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "resource.MembershipHolder.List": { "title": "List of 'resource.MembershipHolder' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'resource.MembershipHolder' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'resource.MembershipHolder' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/resource.MembershipHolder" }, "nullable": true } } } ] }, "resource.MemoryCapacityRangeFilter": { "title": "Memory Capacity Range Over Value", "description": "Consist of two boundaries that define the range, namely the minimum and the maximum memory capacity value.", "x-allOf-name": "resource.MemoryCapacityRangeFilter", "allOf": [ { "$ref": "#/components/schemas/resource.RangeFilter" }, { "type": "object", "description": "Definition of the list of properties defined in 'resource.MemoryCapacityRangeFilter', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "resource.MemoryCapacityRangeFilter" ], "default": "resource.MemoryCapacityRangeFilter", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "resource.MemoryCapacityRangeFilter" ], "default": "resource.MemoryCapacityRangeFilter", "x-enum-as-string": true }, "MaxValue": { "description": "Maximum value for the range limit. It should be greater than the minimum value.", "type": "integer", "format": "int64", "default": 0, "maximum": 999999, "x-omitempty": true }, "MinValue": { "description": "Minimum value for the range limit.", "type": "integer", "format": "int64", "default": 0, "maximum": 999999, "x-omitempty": true } } } ] }, "resource.MemoryQualifier": { "title": "Memory Qualification.", "description": "The MemoryQualifier object is dedicated to qualifying resources based on memory characteristics. It extends the HardwareQualifier, providing specialized criteria for resource selection related to memory capacity and units.\n#### Purpose\nMemoryQualifier aids in the precise filtering of resources by evaluating memory attributes. It ensures that resources meet memory-related requirements, optimizing resource allocation and performance within data center environments.\n#### Key Concepts\n- **Memory-Based Qualification:** Focuses on memory capacity and unit ranges to refine resource selection processes.\n- **Operational Efficiency:** Supports enhanced resource utilization by aligning memory parameters with operational needs.\n- **Extensibility:** Integrates seamlessly with other hardware qualification objects to provide comprehensive resource management solutions.", "x-allOf-name": "resource.MemoryQualifier", "allOf": [ { "$ref": "#/components/schemas/resource.HardwareQualifier" }, { "type": "object", "description": "Definition of the list of properties defined in 'resource.MemoryQualifier', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "resource.MemoryQualifier" ], "default": "resource.MemoryQualifier", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "resource.MemoryQualifier" ], "default": "resource.MemoryQualifier", "x-enum-as-string": true }, "MemoryCapacityRange": { "description": "The qualification of resources is based on memory range between minimum and maximum value.", "$ref": "#/components/schemas/resource.MemoryCapacityRangeFilter", "x-omitempty": true }, "MemoryUnitsRange": { "description": "The qualification of resources is based on the number of memory units between minimum and maximum value.", "$ref": "#/components/schemas/resource.MemoryUnitsRangeFilter", "x-omitempty": true } } } ] }, "resource.MemoryUnitsRangeFilter": { "title": "Memory Unit Range Over Value", "description": "Consist of two boundaries that define the range, namely the minimum and the maximum memory unit value.", "x-allOf-name": "resource.MemoryUnitsRangeFilter", "allOf": [ { "$ref": "#/components/schemas/resource.RangeFilter" }, { "type": "object", "description": "Definition of the list of properties defined in 'resource.MemoryUnitsRangeFilter', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "resource.MemoryUnitsRangeFilter" ], "default": "resource.MemoryUnitsRangeFilter", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "resource.MemoryUnitsRangeFilter" ], "default": "resource.MemoryUnitsRangeFilter", "x-enum-as-string": true }, "MaxValue": { "description": "Maximum value for the range limit. It should be greater than the minimum value.", "type": "integer", "format": "int64", "default": 0, "maximum": 99999, "x-omitempty": true }, "MinValue": { "description": "Minimum value for the range limit.", "type": "integer", "format": "int64", "default": 0, "maximum": 99999, "x-omitempty": true } } } ] }, "resource.NetworkAdaptorQualifier": { "title": "Network Adaptor Qualification", "description": "The NetworkAdaptorQualifier object is designed to qualify resources based on network adaptor characteristics. It extends the HardwareQualifier, providing specific criteria for resource selection related to network adaptors.\n#### Purpose\nNetworkAdaptorQualifier supports the classification of resources by evaluating network adaptor attributes. It ensures that resources meet network-related requirements, optimizing resource allocation and performance in network-intensive environments.\n#### Key Concepts\n- **Adaptor-Based Qualification:** Utilizes adaptor range attributes to enhance resource filtering precision.\n- **Operational Efficiency:** Promotes effective resource utilization by aligning network adaptor characteristics with operational needs.\n- **Integration Capability:** Functions cohesively with other hardware qualification objects to streamline resource management processes.", "x-allOf-name": "resource.NetworkAdaptorQualifier", "allOf": [ { "$ref": "#/components/schemas/resource.HardwareQualifier" }, { "type": "object", "description": "Definition of the list of properties defined in 'resource.NetworkAdaptorQualifier', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "resource.NetworkAdaptorQualifier" ], "default": "resource.NetworkAdaptorQualifier", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "resource.NetworkAdaptorQualifier" ], "default": "resource.NetworkAdaptorQualifier", "x-enum-as-string": true }, "AdaptorsRange": { "description": "The qualification of resources is based on number of adaptors between the minimum and maximum value.", "$ref": "#/components/schemas/resource.AdaptorsRangeFilter", "x-omitempty": true } } } ] }, "resource.OdataRuleSetQualifier": { "title": "Resource:Odata Rule Set Qualifier", "description": "Resources are added to the pool based on OData filter conditions.", "x-allOf-name": "resource.OdataRuleSetQualifier", "allOf": [ { "$ref": "#/components/schemas/resource.RuleSetQualifier" }, { "type": "object", "description": "Definition of the list of properties defined in 'resource.OdataRuleSetQualifier', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "resource.OdataRuleSetQualifier" ], "default": "resource.OdataRuleSetQualifier", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "resource.OdataRuleSetQualifier" ], "default": "resource.OdataRuleSetQualifier", "x-enum-as-string": true }, "Rules": { "type": "array", "items": { "description": "A collection of OData rules used to qualify resources.", "$ref": "#/components/schemas/resource.Selector", "x-omitempty": true }, "nullable": true } } } ] }, "resource.PerTypeCombinedSelector": { "title": "Resource:Per Type Combined Selector", "description": "Complex type representing an object type to associated filter by combining all selectors.", "x-allOf-name": "resource.PerTypeCombinedSelector", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'resource.PerTypeCombinedSelector', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "resource.PerTypeCombinedSelector" ], "default": "resource.PerTypeCombinedSelector", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "resource.PerTypeCombinedSelector" ], "default": "resource.PerTypeCombinedSelector", "x-enum-as-string": true }, "CombinedSelector": { "description": "A single filter expression created by OR'ing the $filter criteria of the 'selectors'. Used to efficiently maintain the membership of the Group.", "type": "string", "readOnly": true, "x-omitempty": true }, "EmptyFilter": { "description": "If true, then resources are added using just object type without filter.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "SelectorObjectType": { "description": "The ObjectType on which the selectors are defined. Used to efficiently query resource groups for a given ObjectType.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "resource.ProcessorQualifier": { "title": "Processor Qualification.", "description": "The ProcessorQualifier object is intended to qualify resources based on processor characteristics. It extends the HardwareQualifier, offering detailed criteria for evaluating processor speed, cores, PIDs, and vendor attributes.\n#### Purpose\nProcessorQualifier facilitates the assessment of resources according to processor specifications, ensuring that resources align with computational requirements. It enhances resource management by enabling targeted processor-based filtering.\n#### Key Concepts\n- **Processor-Based Filtering:** Utilizes speed, core count, and PID attributes to refine resource qualification.\n- **Vendor Integration:** Incorporates vendor criteria to ensure compatibility and enhance resource management.\n- **Resource Optimization:** Promotes effective resource utilization by aligning processor characteristics with operational demands.", "x-allOf-name": "resource.ProcessorQualifier", "allOf": [ { "$ref": "#/components/schemas/resource.HardwareQualifier" }, { "type": "object", "description": "Definition of the list of properties defined in 'resource.ProcessorQualifier', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "resource.ProcessorQualifier" ], "default": "resource.ProcessorQualifier", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "resource.ProcessorQualifier" ], "default": "resource.ProcessorQualifier", "x-enum-as-string": true }, "CpuCoresRange": { "description": "The qualification of resources is based on number of CPU cores between minimum and maximum value.", "$ref": "#/components/schemas/resource.CpuCoreRangeFilter", "x-omitempty": true }, "Pids": { "type": "array", "items": { "description": "The qualification of resources is based on the PID of the processor.", "type": "string", "x-omitempty": true }, "maxItems": 100, "nullable": true }, "SpeedRange": { "description": "The qualification of resources is based on speed of the processor between minimum and maximum value in GHz.", "$ref": "#/components/schemas/resource.CpuSpeedRangeFilter", "x-omitempty": true }, "Vendor": { "description": "The qualification of resources is based on the vendor of the processor.", "type": "string", "x-omitempty": true } } } ] }, "resource.RackIdRangeFilter": { "title": "RackId Range Over Value", "description": "The RackIdRangeFilter object is intended to define qualification criteria based on rack ID ranges. It is a concrete implementation of the RangeFilter, providing a structured approach to resource filtering in data center environments.\n#### Purpose\nRackIdRangeFilter facilitates the classification of resources within data centers by establishing boundaries for rack IDs. This enables administrators to efficiently manage and allocate resources according to specific rack configurations.\n#### Key Concepts\n- **Range-Based Qualification:** Utilizes minimum and maximum values to define rack ID limits, enabling precise resource filtering.\n- **Scalability:** Supports the inclusion of multiple rack ID ranges, enhancing flexibility in resource management.\n- **Integration:** Works in conjunction with other filtering mechanisms to streamline data center operations.", "x-allOf-name": "resource.RackIdRangeFilter", "allOf": [ { "$ref": "#/components/schemas/resource.RangeFilter" }, { "type": "object", "description": "Definition of the list of properties defined in 'resource.RackIdRangeFilter', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "resource.RackIdRangeFilter" ], "default": "resource.RackIdRangeFilter", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "resource.RackIdRangeFilter" ], "default": "resource.RackIdRangeFilter", "x-enum-as-string": true }, "MaxValue": { "description": "Maximum value for the range limit. It should be greater than the minimum value.", "type": "integer", "format": "int64", "default": 0, "maximum": 256, "x-omitempty": true }, "MinValue": { "description": "Minimum value for the range limit.", "type": "integer", "format": "int64", "default": 0, "maximum": 256, "x-omitempty": true } } } ] }, "resource.RackServerQualifier": { "title": "Rack Server Qualifier", "description": "The rack servers are qualified for the pool based on properties of RackServer, such as RackId, RackPID, etc., which are captured as part of the RackServerQualifier.", "x-allOf-name": "resource.RackServerQualifier", "allOf": [ { "$ref": "#/components/schemas/resource.ServerQualifier" }, { "type": "object", "description": "Definition of the list of properties defined in 'resource.RackServerQualifier', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "resource.RackServerQualifier" ], "default": "resource.RackServerQualifier", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "resource.RackServerQualifier" ], "default": "resource.RackServerQualifier", "x-enum-as-string": true }, "RackIdRange": { "type": "array", "items": { "description": "The rack servers are qualified for the pool based on the rack ID range. For instance, servers that fall within the rack ID range of 1-6 will be qualified for the pool.", "$ref": "#/components/schemas/resource.RackIdRangeFilter", "x-omitempty": true }, "maxItems": 20, "nullable": true } } } ] }, "resource.RangeFilter": { "title": "The Range Over Value", "description": "Consist of two boundaries that define the range, namely the minimum and the maximum value.", "x-allOf-name": "resource.RangeFilter", "allOf": [ { "$ref": "#/components/schemas/resource.AdvancedFilter" } ] }, "resource.Reservation.Response": { "description": "The response body of a HTTP GET request for the 'resource.Reservation' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'resource.Reservation' resources.", "x-one-of-name": "resource.Reservation.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/resource.Reservation.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "resource.Reservation.Relationship": { "description": "A relationship to the 'resource.Reservation' resource, or the expanded 'resource.Reservation' resource, or the 'null' value.", "x-one-of-name": "resource.Reservation.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/resource.Reservation" } ], "discriminator": { "propertyName": "ClassId" } }, "resource.Reservation": { "title": "Resource:Reservation", "description": "The Reservation object is responsible for reserving slots for new resources within resource groups, ensuring organized and planned resource allocation.\n#### Purpose\nA Reservation acts as a placeholder for resources that are yet to be added to the system, providing a structured approach to resource planning and allocation. It supports seamless integration with resource groups, facilitating efficient resource management.\n#### Key Concepts\n- **Resource Allocation:** Provides a mechanism for reserving space for new resources, aiding in planned resource allocation.\n- **Integration:** Seamlessly integrates with resource groups to ensure that reserved resources are properly managed and allocated.\n- **Access Control:** Implements privilege sets to manage access to reservation data, ensuring secure and controlled resource planning.", "x-allOf-name": "resource.Reservation", "allOf": [ { "$ref": "#/components/schemas/resource.AbstractReservation" }, { "type": "object", "description": "Definition of the list of properties defined in 'resource.Reservation', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "resource.Reservation" ], "default": "resource.Reservation", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "resource.Reservation" ], "default": "resource.Reservation", "x-enum-as-string": true }, "MarkFail": { "description": "MarkFail is used to set the reservation status to Failed.", "type": "boolean", "x-omitempty": true }, "ResourceMoids": { "type": "array", "items": { "description": "Moids of the resources which will be added to the resource groups.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "UserMoid": { "description": "Moid of the user who created the reservation.", "type": "string", "readOnly": true, "x-omitempty": true }, "Account": { "$ref": "#/components/schemas/iam.Account.Relationship", "description": "A reference to a iamAccount resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "CustomPermissionResources": { "description": "An array of relationships to moBaseMo resources.", "type": "array", "items": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo.Relationship" }, "nullable": true, "readOnly": true }, "Groups": { "description": "An array of relationships to resourceGroup resources.", "type": "array", "items": { "$ref": "#/components/schemas/resource.Group.Relationship" }, "nullable": true, "x-createOnly": true } } } ] }, "resource.Reservation.List": { "title": "List of 'resource.Reservation' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'resource.Reservation' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'resource.Reservation' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/resource.Reservation" }, "nullable": true } } } ] }, "resource.ResourceQualifier": { "title": "Resource Qualifier", "description": "The resources are matched with multiple qualifiers; ResourceQualifier is the base class for all qualifiers.", "x-allOf-name": "resource.ResourceQualifier", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" } ] }, "resource.RuleSetQualifier": { "title": "Resource:Rule Set Qualifier", "description": "Determines whether resources qualify for inclusion in a pool based on a set of rules.", "x-allOf-name": "resource.RuleSetQualifier", "allOf": [ { "$ref": "#/components/schemas/resource.ResourceQualifier" } ] }, "resource.SelectionCriteria.Response": { "description": "The response body of a HTTP GET request for the 'resource.SelectionCriteria' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'resource.SelectionCriteria' resources.", "x-one-of-name": "resource.SelectionCriteria.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/resource.SelectionCriteria.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "resource.SelectionCriteria": { "title": "Resource:Selection Criteria", "description": "The SelectionCriteria object enables the selection of resources based on specific criteria, providing flexibility and precision in resource management.\n#### Purpose\nSelectionCriteria serves as the mechanism for defining conditions that select resources within the system, offering a customizable and efficient approach to resource retrieval and management. It supports both static and dynamic resource selection methods.\n#### Key Concepts\n- **Dynamic Selection:** Allows for the use of OData query filters to dynamically select resources, enhancing flexibility in resource management.\n- **Customization:** Supports the definition of custom criteria for resource selection, providing tailored resource management solutions.\n- **Access Control:** Implements privilege sets to manage access to selection criteria data, ensuring secure and controlled resource selection.", "x-allOf-name": "resource.SelectionCriteria", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'resource.SelectionCriteria', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "resource.SelectionCriteria" ], "default": "resource.SelectionCriteria", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "resource.SelectionCriteria" ], "default": "resource.SelectionCriteria", "x-enum-as-string": true }, "Description": { "description": "The description of the Resource Selection Criteria.", "type": "string", "pattern": "^$|^[a-zA-Z0-9]+[\\x00-\\xFF]*$", "maxLength": 1024, "x-omitempty": true }, "Name": { "description": "Name of the Resource Selection Criteria.", "type": "string", "pattern": "^[a-zA-Z0-9_.:-]{1,128}$", "minLength": 1, "maxLength": 128, "x-omitempty": true }, "PlaceHolders": { "type": "array", "items": { "description": "The selector query can contain zero or more runtime parameters. The placeholders contains a collection of runtime parameters which are extracted from selector query.\nFor example, the OData filter condition for resource VmwareHost is \"MemoryConsumed gt {{.ResourceMemoryConsumed}} and ResourceConsumed.CpuConsumed gt {{.ResourceCpuConsumed}}\" is having ResourceMemoryConsumed and ResourceCpuConsumed are runtime properties which will be extracted as part of this collection.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Selectors": { "type": "array", "items": { "description": "The selectors may be include URLs of individual resources, or OData query with filters that match multiple resources. The URLs must be relative (i.e. do not include the host).\nThe resource selector can have runtime parameters through which value will be supplied by the consumer API. For example, the SelectionCriteria is to select the compute.RackUnit based CpuCore' and 'Available'.\nFor example, the OData filter condition for resource VmwareHost is \"ResourceConsumed.MemoryConsumed gt {{.ResourceMemoryConsumed}} and ResourceConsumed.CpuConsumed gt {{.ResourceCpuConsumed}}\"\nIn the above example, \"ResourceMemoryConsumed\" and \"ResourceCpuConsumed\" are placeholder properties.", "$ref": "#/components/schemas/resource.Selector", "x-omitempty": true }, "nullable": true }, "Organization": { "$ref": "#/components/schemas/organization.Organization.Relationship", "description": "A reference to a organizationOrganization resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true } } } ] }, "resource.SelectionCriteria.List": { "title": "List of 'resource.SelectionCriteria' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'resource.SelectionCriteria' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'resource.SelectionCriteria' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/resource.SelectionCriteria" }, "nullable": true } } } ] }, "resource.Selector": { "title": "Resource:Selector", "description": "Complex type representing the filter condition to extract the resources.", "x-allOf-name": "resource.Selector", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'resource.Selector', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "resource.Selector" ], "default": "resource.Selector", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "resource.Selector" ], "default": "resource.Selector", "x-enum-as-string": true }, "Selector": { "description": "ODATA filter to select resources. The group selector may include URLs of individual resource, or OData query with filters that match multiple queries. The URLs must be relative (i.e. do not include the host).", "type": "string", "pattern": "^$|/api/v1/.*", "x-createOnly": true, "x-omitempty": true } } } ] }, "resource.ServerQualifier": { "title": "Server Qualifier", "description": "The server is filtered into the pool based on specific conditions. The server qualifier serves as the base class for RackServer and BladeQualifier, holding common properties, such as 'AssetTag', 'UserLabel' etc., which can be used for filtering.", "x-allOf-name": "resource.ServerQualifier", "allOf": [ { "$ref": "#/components/schemas/resource.ResourceQualifier" }, { "type": "object", "description": "Definition of the list of properties defined in 'resource.ServerQualifier', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "resource.BladeQualifier", "resource.RackServerQualifier" ], "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "resource.BladeQualifier", "resource.RackServerQualifier" ], "x-enum-as-string": true }, "AssetTags": { "type": "array", "items": { "description": "The qualification is based on the 'AssetTag' property. For instance, the condition is AssetTag in 'ProdServer', 'StageServer'.", "type": "string", "x-omitempty": true }, "maxItems": 20, "nullable": true }, "Pids": { "type": "array", "items": { "description": "The Rack or Node Servers are qualified for the pool based on PIDs. For example, the conditions include PID in 'UCSB-B200-M5', 'UCSB-B200-M6'.", "type": "string", "x-omitempty": true }, "maxItems": 20, "nullable": true }, "UserLabels": { "type": "array", "items": { "description": "The qualification is based on the 'UserLabel' property. For instance, the condition is UserLabel in 'ProdServer', 'StageServer'.", "type": "string", "x-omitempty": true }, "maxItems": 20, "nullable": true } } } ] }, "resource.SharedResourcesInfoHolder.Response": { "description": "The response body of a HTTP GET request for the 'resource.SharedResourcesInfoHolder' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'resource.SharedResourcesInfoHolder' resources.", "x-one-of-name": "resource.SharedResourcesInfoHolder.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/resource.SharedResourcesInfoHolder.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "resource.SharedResourcesInfoHolder": { "title": "Resource:Shared Resources Info Holder", "description": "The SharedResourcesInfoHolder object manages holds shared resource configurations within the system, facilitating resource sharing and collaboration.\n#### Purpose\nSharedResourcesInfoHolder acts as the central entity for managing holding shared resources, this object provides a centralized view of all shared resource configurations between two organizations. It supports efficient resource management and organizational integration.\n#### Key Concepts\n- **Resource Sharing:** Facilitates the sharing of resources between different organizational units, aiding in collaboration and integration.\n- **Configuration Management:** Manages shared resource configurations, ensuring consistent and organized resource sharing.\n- **Access Control:** Integrates access restrictions to ensure secure and controlled management of shared resources.", "x-allOf-name": "resource.SharedResourcesInfoHolder", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'resource.SharedResourcesInfoHolder', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "resource.SharedResourcesInfoHolder" ], "default": "resource.SharedResourcesInfoHolder", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "resource.SharedResourcesInfoHolder" ], "default": "resource.SharedResourcesInfoHolder", "x-enum-as-string": true }, "Account": { "$ref": "#/components/schemas/iam.Account.Relationship", "description": "A reference to a iamAccount resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "PeerObjects": { "description": "An array of relationships to moBaseMo resources.", "type": "array", "items": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo.Relationship" }, "nullable": true, "readOnly": true }, "SharedResource": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo.Relationship", "description": "A reference to a moBaseMo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "SharedWithResource": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo.Relationship", "description": "A reference to a moBaseMo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "SharingRule": { "$ref": "#/components/schemas/iam.SharingRule.Relationship", "description": "A reference to a iamSharingRule resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "SourceObject": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo.Relationship", "description": "A reference to a moBaseMo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "resource.SharedResourcesInfoHolder.List": { "title": "List of 'resource.SharedResourcesInfoHolder' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'resource.SharedResourcesInfoHolder' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'resource.SharedResourcesInfoHolder' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/resource.SharedResourcesInfoHolder" }, "nullable": true } } } ] }, "resource.SlotIdRangeFilter": { "title": "Slot ID Range Over Value", "description": "Consist of two boundaries that define the range, namely the minimum and the maximum SlotId value.", "x-allOf-name": "resource.SlotIdRangeFilter", "allOf": [ { "$ref": "#/components/schemas/resource.RangeFilter" }, { "type": "object", "description": "Definition of the list of properties defined in 'resource.SlotIdRangeFilter', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "resource.SlotIdRangeFilter" ], "default": "resource.SlotIdRangeFilter", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "resource.SlotIdRangeFilter" ], "default": "resource.SlotIdRangeFilter", "x-enum-as-string": true }, "MaxValue": { "description": "Maximum value for the range limit. It should be greater than minimum value.", "type": "integer", "format": "int64", "default": 0, "maximum": 8, "x-omitempty": true }, "MinValue": { "description": "Minimum value for the range limit.", "type": "integer", "format": "int64", "default": 0, "maximum": 8, "x-omitempty": true } } } ] }, "resource.SourceToPermissionResources": { "title": "Resource:Source To Permission Resources", "description": "SourceToPermissionResources holds the source and the permissionResources belonging to them.", "x-allOf-name": "resource.SourceToPermissionResources", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'resource.SourceToPermissionResources', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "resource.SourceToPermissionResources" ], "default": "resource.SourceToPermissionResources", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "resource.SourceToPermissionResources" ], "default": "resource.SourceToPermissionResources", "x-enum-as-string": true }, "PermissionResources": { "type": "array", "items": { "description": "It holds the references of the permissionResources which belongs to the source object.", "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef", "readOnly": true, "x-omitempty": true }, "nullable": true }, "PropagateToTarget": { "description": "PropagateToTarget is a boolean value which indicates whether to propagate the PermissionResources of the \nsource object to the PermissionResources of the target object. If set to true, then PermissionResources of\nthe target object along with its children hierarchy gets updated with PermissionResources of the source \nobject. If set to false while propagating the PermissionResources from source object, PermissionResources \nagainst the Source in SourceToPermissionResourceHolder property of Target object will be set to \nPermissionResources of the source object. In this case, while evaluating access to an MO, we need to consider \nCustomPermissionResources for org user to get right access to the MO.", "type": "boolean", "default": true, "readOnly": true, "x-omitempty": true }, "SourceObject": { "description": "It holds the reference of the source object from which the permission \nis inherited.", "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef", "readOnly": true, "x-omitempty": true } } } ] }, "resource.SourceToPermissionResourcesHolder": { "title": "Resource:Source To Permission Resources Holder", "description": "The holder which holds the multiple custom permission sources and the permissionResources belonging to the sources.\nThese permissionResources are added to the permission resources of the objects which supports permission inherition\nfrom custom sources.", "x-allOf-name": "resource.SourceToPermissionResourcesHolder", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'resource.SourceToPermissionResourcesHolder', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "resource.SourceToPermissionResourcesHolder" ], "default": "resource.SourceToPermissionResourcesHolder", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "resource.SourceToPermissionResourcesHolder" ], "default": "resource.SourceToPermissionResourcesHolder", "x-enum-as-string": true }, "SourceToPermissionResources": { "type": "array", "items": { "description": "The collection of the sources and the permissionResources belonging to them.", "$ref": "#/components/schemas/resource.SourceToPermissionResources", "readOnly": true, "x-omitempty": true }, "nullable": true } } } ] }, "resource.Tag": { "title": "Tag key and value to filter the resource.", "description": "The Tag object represents a key-value pair used for resource filtering based on user-defined criteria. It functions as a concrete element within the qualification framework, supporting diverse tagging strategies.\n#### Purpose\nTag serves as a versatile tool for resource categorization and management. By enabling the application of custom tags, it facilitates dynamic resource filtering and enhances operational efficiency in complex environments.\n#### Key Concepts\n- **User-Defined Tagging:** Supports the creation of personalized tags to meet specific organizational needs.\n- **Flexible Filtering:** Allows for adaptable resource qualification, accommodating diverse operational scenarios.\n- **Integration Capability:** Works cohesively with other qualification objects to streamline resource management processes.", "x-allOf-name": "resource.Tag", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'resource.Tag', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "resource.Tag" ], "default": "resource.Tag", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "resource.Tag" ], "default": "resource.Tag", "x-enum-as-string": true }, "Key": { "description": "Key to match the resource's tag key.", "type": "string", "minLength": 1, "maxLength": 128, "x-omitempty": true }, "Value": { "description": "Value to match the resource's tag value.", "type": "string", "minLength": 1, "maxLength": 256, "x-omitempty": true } } } ] }, "resource.TagQualifier": { "title": "Tag Qualification.", "description": "The resource is qualified based on user tags at various types, such as Domain, Chassis, Blade, Rack, etc. The filtering of resources is determined by matching these tags with set conditions.", "x-allOf-name": "resource.TagQualifier", "allOf": [ { "$ref": "#/components/schemas/resource.ResourceQualifier" }, { "type": "object", "description": "Definition of the list of properties defined in 'resource.TagQualifier', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "resource.TagQualifier" ], "default": "resource.TagQualifier", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "resource.TagQualifier" ], "default": "resource.TagQualifier", "x-enum-as-string": true }, "ChassisTags": { "type": "array", "items": { "description": "The qualification of resources is based on the user tags defined at the chassis and unified edge level for the resource.", "$ref": "#/components/schemas/resource.Tag", "x-omitempty": true }, "maxItems": 20, "nullable": true }, "DomainProfileTags": { "type": "array", "items": { "description": "The qualification of resources is based on the user tags defined at the domain and unified edge profile level for the resource.", "$ref": "#/components/schemas/resource.Tag", "x-omitempty": true }, "maxItems": 20, "nullable": true }, "ServerTags": { "type": "array", "items": { "description": "The qualification of resources is based on the user tags defined at the rack or blade server level for the resource.", "$ref": "#/components/schemas/resource.Tag", "x-omitempty": true }, "maxItems": 20, "nullable": true } } } ] }, "servicenow.ChangeRequest.Response": { "description": "The response body of a HTTP GET request for the 'servicenow.ChangeRequest' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'servicenow.ChangeRequest' resources.", "x-one-of-name": "servicenow.ChangeRequest.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/servicenow.ChangeRequest.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "servicenow.ChangeRequest": { "title": "Servicenow:Change Request", "description": "The ChangeRequest object is a core component of the ServiceNow integration framework, designed to manage and document change requests within the ServiceNow system. It ensures organized tracking of changes, providing a systematic approach to change management.\n#### Purpose\nA ChangeRequest object encapsulates the details of a change request, including its identification, status, and associated metadata. It serves as the central point of reference for managing change requests, ensuring all change-related activities are documented and tracked effectively.\n#### Key Concepts\n- **Identification and Tracking:** Provides unique identifiers for change requests, facilitating easy reference and management.\n- **Metadata Management:** Stores detailed information about change requests, including descriptions, priorities, and impacts, ensuring comprehensive documentation.\n- **Integration with ServiceNow:** Seamlessly interacts with the ServiceNow platform, supporting efficient change management workflows.\n- **Access Control:** Ensures controlled access to change request information, maintaining security and privacy standards within the system.", "x-allOf-name": "servicenow.ChangeRequest", "allOf": [ { "$ref": "#/components/schemas/servicenow.InventoryEntity" }, { "type": "object", "description": "Definition of the list of properties defined in 'servicenow.ChangeRequest', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "servicenow.ChangeRequest" ], "default": "servicenow.ChangeRequest", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "servicenow.ChangeRequest" ], "default": "servicenow.ChangeRequest", "x-enum-as-string": true }, "Approval": { "description": "The approver of Change Request.", "type": "string", "x-omitempty": true }, "AssignedTo": { "description": "Assigned to value for Change Request.", "type": "string", "x-omitempty": true }, "AssignedToDisplayValue": { "description": "Assigned to display value for Change Request.", "type": "string", "x-omitempty": true }, "ChangeModel": { "description": "Change Model for Change Request.", "type": "string", "x-omitempty": true }, "ChangeModelDisplayValue": { "description": "Change Model display value for Change Request.", "type": "string", "x-omitempty": true }, "ChangeRequestNumber": { "description": "Number for Change Request.", "type": "string", "x-omitempty": true }, "Comments": { "description": "Comments on Change Request.", "type": "string", "x-omitempty": true }, "CreatedBy": { "description": "Creator of Change Request.", "type": "string", "x-omitempty": true }, "Description": { "description": "Description for Change Request.", "type": "string", "x-omitempty": true }, "DueDate": { "description": "Due date for Change Request.", "type": "string", "x-omitempty": true }, "EndDate": { "description": "End date for Change Request.", "type": "string", "x-omitempty": true }, "Impact": { "description": "Impact for Change Request.", "type": "string", "x-omitempty": true }, "ImpactDisplayValue": { "description": "Impact display value for Change Request.", "type": "string", "x-omitempty": true }, "Priority": { "description": "Priority for Change Request.", "type": "string", "x-omitempty": true }, "PriorityDisplayValue": { "description": "Priority display value for Change Request.", "type": "string", "x-omitempty": true }, "Risk": { "description": "The risk for Change Request.", "type": "string", "x-omitempty": true }, "ShortDescription": { "description": "Short Description for Change Request.", "type": "string", "x-omitempty": true }, "StartDate": { "description": "Start date for Change Request.", "type": "string", "x-omitempty": true }, "SysId": { "description": "Sys Id for Change Request.", "type": "string", "x-omitempty": true }, "Type": { "description": "The type for Change Request.", "type": "string", "x-omitempty": true }, "UpdatedBy": { "description": "Last update Change Request.", "type": "string", "x-omitempty": true } } } ] }, "servicenow.ChangeRequest.List": { "title": "List of 'servicenow.ChangeRequest' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'servicenow.ChangeRequest' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'servicenow.ChangeRequest' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/servicenow.ChangeRequest" }, "nullable": true } } } ] }, "servicenow.ChangeRequestDoc.Response": { "description": "The response body of a HTTP GET request for the 'servicenow.ChangeRequestDoc' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'servicenow.ChangeRequestDoc' resources.", "x-one-of-name": "servicenow.ChangeRequestDoc.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/servicenow.ChangeRequestDoc.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "servicenow.ChangeRequestDoc": { "title": "Servicenow:Change Request Doc", "description": "The ChangeRequestDoc object is part of the ServiceNow service, providing a schema for change request documentation. It offers a structured approach to documenting change-related information.\n#### Purpose\nChangeRequestDoc provides the schema necessary for capturing and managing change request data, ensuring consistent documentation and integration across systems. It supports the standardization of change information, facilitating efficient data handling.\n#### Key Concepts\n- **Schema Definition:** Establishes a clear schema for change request data, supporting standardized data entry and management.\n- **Integration:** Facilitates integration with other systems and processes, ensuring seamless interaction and data exchange.\n- **Consistency:** Promotes consistent documentation practices, enhancing data reliability and accessibility.\n- **Flexibility:** Allows customization to accommodate specific organizational needs and requirements.", "x-allOf-name": "servicenow.ChangeRequestDoc", "allOf": [ { "$ref": "#/components/schemas/servicenow.InventoryEntity" }, { "type": "object", "description": "Definition of the list of properties defined in 'servicenow.ChangeRequestDoc', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "servicenow.ChangeRequestDoc" ], "default": "servicenow.ChangeRequestDoc", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "servicenow.ChangeRequestDoc" ], "default": "servicenow.ChangeRequestDoc", "x-enum-as-string": true }, "ExampleValue": { "description": "Example value for Change request property.", "type": "string", "x-omitempty": true }, "InternalType": { "description": "Internal type for Change request property.", "type": "string", "x-omitempty": true }, "Label": { "description": "Label for Change request property.", "type": "string", "x-omitempty": true }, "PropertyName": { "description": "Name for Change request property.", "type": "string", "x-omitempty": true } } } ] }, "servicenow.ChangeRequestDoc.List": { "title": "List of 'servicenow.ChangeRequestDoc' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'servicenow.ChangeRequestDoc' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'servicenow.ChangeRequestDoc' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/servicenow.ChangeRequestDoc" }, "nullable": true } } } ] }, "servicenow.Incident.Response": { "description": "The response body of a HTTP GET request for the 'servicenow.Incident' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'servicenow.Incident' resources.", "x-one-of-name": "servicenow.Incident.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/servicenow.Incident.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "servicenow.Incident": { "title": "Servicenow:Incident", "description": "The Incident object is an integral part of the ServiceNow service, designed to manage incidents and ensure their timely resolution. This provides a standardized approach to recording, tracking, and resolving issues that disrupt normal operations.\n#### Purpose\nAn Incident captures and manages unexpected issues within an organization, offering a framework for efficient and effective resolution. It helps maintain service continuity by addressing problems swiftly and minimizing their impact.\n#### Key Concepts\n- **Incident Lifecycle:** Covers the entire lifecycle of an incident, from detection and reporting to resolution and closure.\n- **Prioritization and Urgency:** Facilitates the assessment of incident severity and urgency, ensuring that critical issues are prioritized.\n- **State Management:** Tracks the current state and progress of an incident, enabling effective management and monitoring.\n- **Communication and Documentation:** Ensures clear communication through comments and status updates, maintaining a detailed record for future reference.", "x-allOf-name": "servicenow.Incident", "allOf": [ { "$ref": "#/components/schemas/servicenow.InventoryEntity" }, { "type": "object", "description": "Definition of the list of properties defined in 'servicenow.Incident', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "servicenow.Incident" ], "default": "servicenow.Incident", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "servicenow.Incident" ], "default": "servicenow.Incident", "x-enum-as-string": true }, "Approval": { "description": "The approver property of Incident.", "type": "string", "x-omitempty": true }, "Category": { "description": "Category property for Incident.", "type": "string", "x-omitempty": true }, "Comments": { "description": "Comments property on Incident.", "type": "string", "x-omitempty": true }, "CreatedBy": { "description": "Creator property of Incident.", "type": "string", "x-omitempty": true }, "CreatedOn": { "description": "Incident create date property.", "type": "string", "x-omitempty": true }, "Description": { "description": "Description for Incident.", "type": "string", "x-omitempty": true }, "DueDate": { "description": "Due date property for Incident.", "type": "string", "x-omitempty": true }, "ExpectedStart": { "description": "Expected start date for Incident.", "type": "string", "x-omitempty": true }, "Impact": { "description": "Impact property for Incident.", "type": "string", "x-omitempty": true }, "IncidentState": { "description": "State property of the Incident.", "type": "string", "x-omitempty": true }, "OpenedBy": { "description": "Assigned to value for Incident.", "type": "string", "x-omitempty": true }, "Priority": { "description": "Priority property for Incident.", "type": "string", "x-omitempty": true }, "Risk": { "description": "The risk property for Incident.", "type": "string", "x-omitempty": true }, "Severity": { "description": "Severity property of the Incident.", "type": "string", "x-omitempty": true }, "ShortDescription": { "description": "Short Description for Incident.", "type": "string", "x-omitempty": true }, "SysId": { "description": "System Id property for Incident.", "type": "string", "x-omitempty": true }, "TaskEffectiveNumber": { "description": "Task Effective Number for Incident.", "type": "string", "x-omitempty": true }, "UpdatedBy": { "description": "Last update by on Incident.", "type": "string", "x-omitempty": true }, "Urgency": { "description": "Urgency property of the Incident.", "type": "string", "x-omitempty": true }, "WorkEnd": { "description": "Work end date for Incident.", "type": "string", "x-omitempty": true }, "WorkStart": { "description": "Work start date for Incident.", "type": "string", "x-omitempty": true } } } ] }, "servicenow.Incident.List": { "title": "List of 'servicenow.Incident' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'servicenow.Incident' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'servicenow.Incident' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/servicenow.Incident" }, "nullable": true } } } ] }, "servicenow.IncidentDoc.Response": { "description": "The response body of a HTTP GET request for the 'servicenow.IncidentDoc' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'servicenow.IncidentDoc' resources.", "x-one-of-name": "servicenow.IncidentDoc.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/servicenow.IncidentDoc.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "servicenow.IncidentDoc": { "title": "Servicenow:Incident Doc", "description": "The IncidentDoc object is part of the ServiceNow service, providing a schema for incident-related documentation. It serves as a foundational element for structuring and organizing incident data.\n#### Purpose\nIncidentDoc provides the structure necessary for recording and managing incident data, ensuring consistent documentation and integration across systems. It supports the standardization of incident information, facilitating efficient data handling.\n#### Key Concepts\n- **Schema Definition:** Establishes a clear schema for incident data, supporting standardized data entry and management.\n- **Integration:** Facilitates integration with other systems and processes, ensuring seamless interaction and data exchange.\n- **Consistency:** Promotes consistent documentation practices, enhancing data reliability and accessibility.\n- **Flexibility:** Allows customization to accommodate specific organizational needs and requirements.", "x-allOf-name": "servicenow.IncidentDoc", "allOf": [ { "$ref": "#/components/schemas/servicenow.InventoryEntity" }, { "type": "object", "description": "Definition of the list of properties defined in 'servicenow.IncidentDoc', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "servicenow.IncidentDoc" ], "default": "servicenow.IncidentDoc", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "servicenow.IncidentDoc" ], "default": "servicenow.IncidentDoc", "x-enum-as-string": true }, "ExampleValue": { "description": "Example value for Incident property.", "type": "string", "x-omitempty": true }, "InternalType": { "description": "Internal type for Incident property.", "type": "string", "x-omitempty": true }, "Label": { "description": "Label for Incident property.", "type": "string", "x-omitempty": true }, "PropertyName": { "description": "Name for Incident property.", "type": "string", "x-omitempty": true } } } ] }, "servicenow.IncidentDoc.List": { "title": "List of 'servicenow.IncidentDoc' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'servicenow.IncidentDoc' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'servicenow.IncidentDoc' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/servicenow.IncidentDoc" }, "nullable": true } } } ] }, "servicenow.InventoryEntity": { "title": "Servicenow:Inventory Entity", "description": "Base object type for all ServiceNow Inventory items.", "x-allOf-name": "servicenow.InventoryEntity", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'servicenow.InventoryEntity', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "servicenow.ChangeRequest", "servicenow.ChangeRequestDoc", "servicenow.Incident", "servicenow.IncidentDoc" ], "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "servicenow.ChangeRequest", "servicenow.ChangeRequestDoc", "servicenow.Incident", "servicenow.IncidentDoc" ], "x-enum-as-string": true }, "RegisteredDevice": { "$ref": "#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "task.CatalystSdwanScopedInventory": { "title": "Task:Catalyst Sdwan Scoped Inventory", "description": "CatalystSdwanScopedInventories represent an on-demand inventory trigger used to refresh inventory for a specific registered Catalyst SD-WAN device/connection. Creating one of these objects initiates a scoped discovery cycle to update modified objects in Intersight without waiting for the next scheduled inventory run.\n#### Purpose\nAllow administrators to manually trigger a targeted inventory refresh for a Catalyst SD-WAN registered device so Intersight reflects recent changes promptly.\n#### Key Concepts\n- **On-demand trigger (CREATE-only)**: The object is primarily an action/request used to start inventory, not a long-lived configuration resource.\n- **Scoped inventory behavior**: Extends `connector.ScopedInventory`, indicating the operation is limited to the specified device scope.\n- **Device targeting via registration**: `registeredDevice` (create-only) identifies the exact device registration to inventory.\n- **Permission inheritance**: Inherits permissions from `registeredDevice`, aligning access control with the underlying device registration.\n- **Lifecycle coupling**: `onpeerdelete: cascade` ties the trigger record to the device registration lifecycle.", "x-allOf-name": "task.CatalystSdwanScopedInventory", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/connector.ScopedInventory" }, { "type": "object", "description": "Definition of the list of properties defined in 'task.CatalystSdwanScopedInventory', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "task.CatalystSdwanScopedInventory" ], "default": "task.CatalystSdwanScopedInventory", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "task.CatalystSdwanScopedInventory" ], "default": "task.CatalystSdwanScopedInventory", "x-enum-as-string": true }, "RegisteredDevice": { "$ref": "#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true } } } ] }, "task.FabricMosScopedInventory": { "title": "Task:Fabric Mos Scoped Inventory", "description": "API to trigger on-demand inventory to update MDS objects in Intersight.", "x-allOf-name": "task.FabricMosScopedInventory", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/connector.ScopedInventory" }, { "type": "object", "description": "Definition of the list of properties defined in 'task.FabricMosScopedInventory', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "task.FabricMosScopedInventory" ], "default": "task.FabricMosScopedInventory", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "task.FabricMosScopedInventory" ], "default": "task.FabricMosScopedInventory", "x-enum-as-string": true }, "RegisteredDevice": { "$ref": "#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true } } } ] }, "task.HciScopedInventory": { "title": "Task:Hci Scoped Inventory", "description": "The HciScopedInventory object is a trigger for on-demand inventory collection for the specified set of managed objects.\n#### Purpose\nThe HciScopedInventory object facilitates the on-demand collection of inventory data from registered devices. It acts as a trigger for inventory updates, ensuring that the system reflects the current state of managed assets.\n#### Key Concepts\n- **Inventory Collection:** Initiates on-demand inventory collection processes to ensure data accuracy.", "x-allOf-name": "task.HciScopedInventory", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/connector.ScopedInventory" }, { "type": "object", "description": "Definition of the list of properties defined in 'task.HciScopedInventory', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "task.HciScopedInventory" ], "default": "task.HciScopedInventory", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "task.HciScopedInventory" ], "default": "task.HciScopedInventory", "x-enum-as-string": true }, "RegisteredDevice": { "$ref": "#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true } } } ] }, "task.HitachiScopedInventory": { "title": "Task:Hitachi Scoped Inventory", "description": "The HitachiScopedInventory object provides an API to trigger on-demand HitachiStorage FlashArray inventory updates, supporting effective storage system reporting.\n#### Purpose\nHitachiScopedInventory is fundamental to managing inventory updates within Hitachi arrays. It ensures accurate and timely reporting of modified objects, supporting efficient storage system operations.\n#### Key Concepts\n- **Inventory Management:** Facilitates on-demand inventory updates, ensuring accurate and current reporting of storage system changes.\n- **API Integration:** Provides a structured API for inventory updates, supporting seamless integration within the Intersight system.\n- **Device Registration:** Connects inventory updates to device registration objects, ensuring reliable communication and reporting.\n- **Access Control:** Utilizes privilege sets to ensure secure and authorized operations on inventory updates.", "x-allOf-name": "task.HitachiScopedInventory", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/connector.ScopedInventory" }, { "type": "object", "description": "Definition of the list of properties defined in 'task.HitachiScopedInventory', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "task.HitachiScopedInventory" ], "default": "task.HitachiScopedInventory", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "task.HitachiScopedInventory" ], "default": "task.HitachiScopedInventory", "x-enum-as-string": true }, "RegisteredDevice": { "$ref": "#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true } } } ] }, "task.HyperFlexManagementScopedInventory": { "title": "Task:Hyper Flex Management Scoped Inventory", "description": "HyperFlexManagementScopedInventories are task-trigger objects used to initiate an on-demand HyperFlex inventory collection for a specific registered HyperFlex endpoint. They are intended to refresh Intersight\u2019s reported state by collecting updated data for the associated device.\n#### Purpose\nProvide an API mechanism to manually trigger inventory collection so that recently changed HyperFlex-managed objects are re-discovered and reflected in Intersight reports without waiting for the next scheduled inventory cycle.\n#### Key Concepts\n- **On-demand inventory trigger:** Creating this object starts an immediate inventory refresh workflow for the target device.\n- **Device-scoped execution:** The operation is explicitly bound to a single `registeredDevice` (an `asset.DeviceRegistration`).\n- **Scoped inventory base:** Extends `connector.ScopedInventory`, aligning with the platform\u2019s standard pattern for inventory-trigger requests.\n- **Permission inheritance:** Inherits permissions from `registeredDevice`, ensuring only authorized users can trigger collection for that device.\n- **Lifecycle coupling:** Uses `onpeerdelete: cascade` so if the device registration is removed, the associated trigger object is cleaned up.", "x-allOf-name": "task.HyperFlexManagementScopedInventory", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/connector.ScopedInventory" }, { "type": "object", "description": "Definition of the list of properties defined in 'task.HyperFlexManagementScopedInventory', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "task.HyperFlexManagementScopedInventory" ], "default": "task.HyperFlexManagementScopedInventory", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "task.HyperFlexManagementScopedInventory" ], "default": "task.HyperFlexManagementScopedInventory", "x-enum-as-string": true }, "RegisteredDevice": { "$ref": "#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true } } } ] }, "task.HyperflexScopedInventory": { "title": "Task:Hyperflex Scoped Inventory", "description": "API to trigger on-demand Hyperflex Cluster inventory to update modified objects in Intersight report.", "x-allOf-name": "task.HyperflexScopedInventory", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/connector.ScopedInventory" }, { "type": "object", "description": "Definition of the list of properties defined in 'task.HyperflexScopedInventory', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "task.HyperflexScopedInventory" ], "default": "task.HyperflexScopedInventory", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "task.HyperflexScopedInventory" ], "default": "task.HyperflexScopedInventory", "x-enum-as-string": true }, "RegisteredDevice": { "$ref": "#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true } } } ] }, "task.MdsScopedInventory": { "title": "Task:Mds Scoped Inventory", "description": "API to trigger on-demand MDS inventory to update modified objects in Intersight report.", "x-allOf-name": "task.MdsScopedInventory", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/connector.ScopedInventory" }, { "type": "object", "description": "Definition of the list of properties defined in 'task.MdsScopedInventory', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "task.MdsScopedInventory" ], "default": "task.MdsScopedInventory", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "task.MdsScopedInventory" ], "default": "task.MdsScopedInventory", "x-enum-as-string": true }, "RegisteredDevice": { "$ref": "#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true } } } ] }, "task.MdsSystemScopedInventory": { "title": "Task:Mds System Scoped Inventory", "description": "API to trigger on-demand MDS System inventory after the workflow execution.", "x-allOf-name": "task.MdsSystemScopedInventory", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/connector.ScopedInventory" }, { "type": "object", "description": "Definition of the list of properties defined in 'task.MdsSystemScopedInventory', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "task.MdsSystemScopedInventory" ], "default": "task.MdsSystemScopedInventory", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "task.MdsSystemScopedInventory" ], "default": "task.MdsSystemScopedInventory", "x-enum-as-string": true }, "RegisteredDevice": { "$ref": "#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true } } } ] }, "task.MerakiScopedInventory": { "title": "Task:Meraki Scoped Inventory", "description": "API to trigger on-demand inventory to update modified objects.", "x-allOf-name": "task.MerakiScopedInventory", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/connector.ScopedInventory" }, { "type": "object", "description": "Definition of the list of properties defined in 'task.MerakiScopedInventory', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "task.MerakiScopedInventory" ], "default": "task.MerakiScopedInventory", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "task.MerakiScopedInventory" ], "default": "task.MerakiScopedInventory", "x-enum-as-string": true }, "RegisteredDevice": { "$ref": "#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true } } } ] }, "task.NetAppScopedInventory": { "title": "Task:Net App Scoped Inventory", "description": "API to trigger on-demand NetAppStorage inventory to update modified objects in Intersight report.", "x-allOf-name": "task.NetAppScopedInventory", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/connector.ScopedInventory" }, { "type": "object", "description": "Definition of the list of properties defined in 'task.NetAppScopedInventory', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "task.NetAppScopedInventory" ], "default": "task.NetAppScopedInventory", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "task.NetAppScopedInventory" ], "default": "task.NetAppScopedInventory", "x-enum-as-string": true }, "RegisteredDevice": { "$ref": "#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true } } } ] }, "task.NexusScopedInventory": { "title": "Task:Nexus Scoped Inventory", "description": "API to trigger on-demand Nexus inventory to update modified objects in Intersight report.", "x-allOf-name": "task.NexusScopedInventory", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/connector.ScopedInventory" }, { "type": "object", "description": "Definition of the list of properties defined in 'task.NexusScopedInventory', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "task.NexusScopedInventory" ], "default": "task.NexusScopedInventory", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "task.NexusScopedInventory" ], "default": "task.NexusScopedInventory", "x-enum-as-string": true }, "RegisteredDevice": { "$ref": "#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true } } } ] }, "task.NexusSystemScopedInventory": { "title": "Task:Nexus System Scoped Inventory", "description": "API to trigger on-demand Nexus SNMP inventory to update modified objects in Intersight report.", "x-allOf-name": "task.NexusSystemScopedInventory", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/connector.ScopedInventory" }, { "type": "object", "description": "Definition of the list of properties defined in 'task.NexusSystemScopedInventory', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "task.NexusSystemScopedInventory" ], "default": "task.NexusSystemScopedInventory", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "task.NexusSystemScopedInventory" ], "default": "task.NexusSystemScopedInventory", "x-enum-as-string": true }, "RegisteredDevice": { "$ref": "#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true } } } ] }, "task.NexusVlanScopedInventory": { "title": "Task:Nexus Vlan Scoped Inventory", "description": "API to trigger on-demand Nexus VLAN inventory to update modified objects in Intersight report.", "x-allOf-name": "task.NexusVlanScopedInventory", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/connector.ScopedInventory" }, { "type": "object", "description": "Definition of the list of properties defined in 'task.NexusVlanScopedInventory', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "task.NexusVlanScopedInventory" ], "default": "task.NexusVlanScopedInventory", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "task.NexusVlanScopedInventory" ], "default": "task.NexusVlanScopedInventory", "x-enum-as-string": true }, "RegisteredDevice": { "$ref": "#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true } } } ] }, "task.PureFlashBladeScopedInventory": { "title": "Task:Pure Flash Blade Scoped Inventory", "description": "The PureFlashBladeScopedInventory object provides on-demand inventory management for FlashBlade storage arrays, enabling dynamic updates to managed objects following operational changes.\n#### Purpose\nThis object is used to trigger inventory refreshes, ensuring that any modifications to the FlashBlade array are accurately reflected in management reports. It supports administrators in maintaining up-to-date information for audit, compliance, and operational efficiency.\n#### Key Concepts\n- **Inventory Refresh**: Allows for immediate updating of FlashBlade inventory post-operations, enhancing data accuracy.\n- **Automation Support**: Integrates with batch API executors, enabling automated inventory management workflows.\n- **Management Integration**: Works alongside device registration to ensure consistent reporting across management platforms.\n- **Privilege Control**: Access is restricted to authorized users, maintaining security and compliance.", "x-allOf-name": "task.PureFlashBladeScopedInventory", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/connector.ScopedInventory" }, { "type": "object", "description": "Definition of the list of properties defined in 'task.PureFlashBladeScopedInventory', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "task.PureFlashBladeScopedInventory" ], "default": "task.PureFlashBladeScopedInventory", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "task.PureFlashBladeScopedInventory" ], "default": "task.PureFlashBladeScopedInventory", "x-enum-as-string": true }, "RegisteredDevice": { "$ref": "#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true } } } ] }, "task.PureScopedInventory": { "title": "Task:Pure Scoped Inventory", "description": "API to trigger on-demand PureStorage FlashArray inventory to update modified objects in Intersight report.", "x-allOf-name": "task.PureScopedInventory", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/connector.ScopedInventory" }, { "type": "object", "description": "Definition of the list of properties defined in 'task.PureScopedInventory', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "task.PureScopedInventory" ], "default": "task.PureScopedInventory", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "task.PureScopedInventory" ], "default": "task.PureScopedInventory", "x-enum-as-string": true }, "RegisteredDevice": { "$ref": "#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true } } } ] }, "task.ServerScopedInventory": { "title": "Task:Server Scoped Inventory", "description": "API to trigger on-demand Server inventory to update modified objects in Intersight report.", "x-allOf-name": "task.ServerScopedInventory", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/connector.ScopedInventory" }, { "type": "object", "description": "Definition of the list of properties defined in 'task.ServerScopedInventory', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "task.ServerScopedInventory" ], "default": "task.ServerScopedInventory", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "task.ServerScopedInventory" ], "default": "task.ServerScopedInventory", "x-enum-as-string": true }, "RegisteredDevice": { "$ref": "#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true } } } ] }, "ucsd.BackupInfo.Response": { "description": "The response body of a HTTP GET request for the 'ucsd.BackupInfo' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'ucsd.BackupInfo' resources.", "x-one-of-name": "ucsd.BackupInfo.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/ucsd.BackupInfo.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "ucsd.BackupInfo": { "title": "Ucsd:Backup Info", "description": "The BackupInfo object provides detailed insights into backup images available for restoration on target endpoint (UCS Director) devices. It captures essential metadata and status information to support recovery operations.\n#### Purpose\nThe BackupInfo object provides comprehensive visibility into available backup images and real-time status updates on backup progress. It ensures that restoration processes rely on accurate, current data, enabling informed and efficient recovery operations.\n#### Key Concepts\n- **Transparency:** Delivers comprehensive metadata about backup images, including status, location, and completion percentage.\n- **Access Control:** Designed to allow authorized personnel to access backup information securely.\n- **Relationship Management:** Extends abstract backup information concepts to provide a detailed view of available resources.", "x-allOf-name": "ucsd.BackupInfo", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/recovery.AbstractBackupInfo" }, { "type": "object", "description": "Definition of the list of properties defined in 'ucsd.BackupInfo', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "ucsd.BackupInfo" ], "default": "ucsd.BackupInfo", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "ucsd.BackupInfo" ], "default": "ucsd.BackupInfo", "x-enum-as-string": true }, "BackupFileName": { "description": "Auto generated backup file name with user defined prefix and timestamp.", "type": "string", "readOnly": true, "x-omitempty": true }, "BackupLocation": { "description": "Backup location for restore operation.", "type": "string", "readOnly": true, "x-omitempty": true }, "BackupServerIp": { "description": "Backup server for storing backup images.", "type": "string", "readOnly": true, "x-omitempty": true }, "BackupSize": { "description": "Backup image size in bytes.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Connectors": { "type": "array", "items": { "description": "Connector pack versions active on UCS Director at the time of backup.", "$ref": "#/components/schemas/ucsd.ConnectorPack", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Duration": { "description": "Time taken to complete the backup.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "EncryptionKey": { "description": "Encryption key for backup file.", "type": "string", "writeOnly": true, "x-omitempty": true }, "FailureReason": { "description": "The cause of the backup failure.", "type": "string", "readOnly": true, "x-omitempty": true }, "IsPurged": { "description": "Backup image purge status based on retention policy.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "LastModified": { "description": "Backup record last modified time.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "PercentageCompletion": { "description": "Backup completion percentage status.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "ProductVersion": { "description": "End device product version at the backup time.", "type": "string", "x-omitempty": true }, "Protocol": { "description": "Supported remote backup protocol (FTP, SCP and SFTP); not applicable for localhost (127.0.0.1).", "type": "string", "readOnly": true, "x-omitempty": true }, "StageCompletion": { "description": "Backup status stage information.", "type": "string", "readOnly": true, "x-omitempty": true }, "StartTime": { "description": "Backup initiation start time.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "Status": { "description": "The current backup status.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "ucsd.BackupInfo.List": { "title": "List of 'ucsd.BackupInfo' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'ucsd.BackupInfo' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'ucsd.BackupInfo' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/ucsd.BackupInfo" }, "nullable": true } } } ] }, "ucsd.ConnectorPack": { "title": "Ucsd:Connector Pack", "description": "Connector pack details from the backup file.", "x-allOf-name": "ucsd.ConnectorPack", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'ucsd.ConnectorPack', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "ucsd.ConnectorPack" ], "default": "ucsd.ConnectorPack", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "ucsd.ConnectorPack" ], "default": "ucsd.ConnectorPack", "x-enum-as-string": true }, "ConnectorFeature": { "description": "State of connector pack (enabled/ disabled).", "type": "string", "readOnly": true, "x-omitempty": true }, "DependencyNames": { "type": "array", "items": { "description": "List of dependent connectors on UCS Director (e.g., BigData depends on UCS Connector).", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "DownloadedVersion": { "description": "Last successfully downloaded connector pack version successfully for UCS Director.", "type": "string", "readOnly": true, "x-omitempty": true }, "Name": { "description": "UCS Director connector pack name.", "type": "string", "readOnly": true, "x-omitempty": true }, "Services": { "type": "array", "items": { "description": "List of dependent connectors on UCS Director (e.g., BigData depends on UCS Connector).", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "State": { "description": "Connector pack state (enabled/disabled).", "type": "string", "readOnly": true, "x-omitempty": true }, "Version": { "description": "The connector pack version.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "ucsd.UcsdRestoreParameters": { "title": "Ucsd:Ucsd Restore Parameters", "description": "UCS director restore workflow configuration parameters.", "x-allOf-name": "ucsd.UcsdRestoreParameters", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/recovery.ConfigParams" }, { "type": "object", "description": "Definition of the list of properties defined in 'ucsd.UcsdRestoreParameters', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "ucsd.UcsdRestoreParameters" ], "default": "ucsd.UcsdRestoreParameters", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "ucsd.UcsdRestoreParameters" ], "default": "ucsd.UcsdRestoreParameters", "x-enum-as-string": true }, "IsPasswordSet": { "description": "Indicates whether the value of the 'password' property has been set.", "type": "boolean", "default": false, "readOnly": true, "x-omitempty": true }, "Location": { "description": "Full server path location in format - hostname-or-ipv4address<:port>/absolute-file-path.", "type": "string", "x-omitempty": true }, "Password": { "description": "Target backup server password for SFTP or SCP access.", "type": "string", "writeOnly": true, "x-omitempty": true }, "Protocol": { "description": "Backup protocol for UCS Director.", "type": "string", "x-omitempty": true }, "RestoreConfigurationFiles": { "description": "Decision on UCS Director property files restoration.", "type": "boolean", "x-omitempty": true }, "RestoreLicense": { "description": "Decision on license restoration.", "type": "boolean", "x-omitempty": true }, "Username": { "description": "Target backup server user name for SFTP or SCP access.", "type": "string", "x-omitempty": true } } } ] }, "webhook.Endpoint.Response": { "description": "The response body of a HTTP GET request for the 'webhook.Endpoint' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'webhook.Endpoint' resources.", "x-one-of-name": "webhook.Endpoint.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/webhook.Endpoint.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "webhook.Endpoint": { "title": "Webhook:Endpoint", "description": "The Endpoint object is a crucial component for managing webhook communications within the system. Endpoint provides a structured approach for controllers to forward events, enabling seamless integration with external systems.\n#### Purpose\nAn Endpoint serves as the conduit for event-driven interactions, allowing applications to communicate through predefined webhook routes. It ensures that events can be reliably received and processed by external systems.\n#### Key Concepts\n- **Webhook Integration:** Designed to facilitate the forwarding of events to external systems using webhooks, ensuring real-time communication and data exchange.\n- **Access Control:** Incorporates privilege sets to manage who can create, read, update, and delete endpoints, safeguarding against unauthorized access.\n- **Relationship Management:** Establishes connections with accounts and organizations, ensuring that each endpoint is associated with the relevant entities for efficient management and tracking.", "x-allOf-name": "webhook.Endpoint", "allOf": [ { "$ref": "#/components/schemas/iam.AbstractClientApplication" }, { "type": "object", "description": "Definition of the list of properties defined in 'webhook.Endpoint', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "webhook.Endpoint" ], "default": "webhook.Endpoint", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "webhook.Endpoint" ], "default": "webhook.Endpoint", "x-enum-as-string": true }, "Name": { "description": "The name of the Endpoint.", "type": "string", "minLength": 1, "maxLength": 128, "x-omitempty": true }, "Url": { "description": "The endpoint URL. The CREATE and UPDATE APIs can cause the change to the value.", "type": "string", "readOnly": true, "x-omitempty": true }, "Account": { "$ref": "#/components/schemas/iam.Account.Relationship", "description": "A reference to a iamAccount resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Organization": { "$ref": "#/components/schemas/organization.Organization.Relationship", "description": "A reference to a organizationOrganization resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true }, "Schemas": { "description": "An array of relationships to webhookSchema resources.", "type": "array", "items": { "$ref": "#/components/schemas/webhook.Schema.Relationship" }, "nullable": true } } } ] }, "webhook.Endpoint.List": { "title": "List of 'webhook.Endpoint' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'webhook.Endpoint' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'webhook.Endpoint' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/webhook.Endpoint" }, "nullable": true } } } ] }, "webhook.Schema.Response": { "description": "The response body of a HTTP GET request for the 'webhook.Schema' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'webhook.Schema' resources.", "x-one-of-name": "webhook.Schema.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/webhook.Schema.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "webhook.Schema.Relationship": { "description": "A relationship to the 'webhook.Schema' resource, or the expanded 'webhook.Schema' resource, or the 'null' value.", "x-one-of-name": "webhook.Schema.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/webhook.Schema" } ], "discriminator": { "propertyName": "ClassId" } }, "webhook.Schema": { "title": "Webhook:Schema", "description": "The Schema object is integral to event management, providing the framework that defines the structure of events. It ensures consistency and validity in the way events are described and handled across the system.\n#### Purpose\nA Schema outlines the format and content of events, acting as a template for event generation. It is essential for maintaining uniformity and accuracy in event data processing and interpretation.\n#### Key Concepts\n- **Event Definition:** Specifies the event type and source, ensuring each schema represents a unique event scenario within the system.\n- **Data Integrity:** Enforces constraints on event data, guaranteeing that events adhere to predefined standards and formats.\n- **Access Control:** Utilizes privilege sets to regulate schema creation, updates, and deletion, protecting the integrity of event definitions.", "x-allOf-name": "webhook.Schema", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'webhook.Schema', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "webhook.Schema" ], "default": "webhook.Schema", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "webhook.Schema" ], "default": "webhook.Schema", "x-enum-as-string": true }, "Data": { "description": "The actual JSON schema data. The data must be a valid JSON schema string.", "type": "string", "minLength": 1, "maxLength": 524288, "x-omitempty": true }, "Description": { "description": "The description of the schema.", "type": "string", "maxLength": 512, "x-omitempty": true }, "EventType": { "description": "The event type of the schema.", "type": "string", "minLength": 1, "maxLength": 128, "x-omitempty": true }, "Source": { "description": "The source of the schema.", "type": "string", "minLength": 1, "maxLength": 128, "x-omitempty": true }, "Account": { "$ref": "#/components/schemas/iam.Account.Relationship", "description": "A reference to a iamAccount resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "webhook.Schema.List": { "title": "List of 'webhook.Schema' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'webhook.Schema' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'webhook.Schema' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/webhook.Schema" }, "nullable": true } } } ] }, "workflow.AbstractLoopTask": { "title": "Workflow:Abstract Loop Task", "description": "An abstract loop task which is used to model different types of loops like serial and parallel.", "x-allOf-name": "workflow.AbstractLoopTask", "allOf": [ { "$ref": "#/components/schemas/workflow.ControlTask" }, { "type": "object", "description": "Definition of the list of properties defined in 'workflow.AbstractLoopTask', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "workflow.LoopTask", "workflow.SerialLoopTask" ], "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "workflow.LoopTask", "workflow.SerialLoopTask" ], "x-enum-as-string": true }, "Count": { "description": "Count value for the loop, this can be a static value defined as a constant at design time or can be a dynamic value defined as an expression that will evaluate to an integer value at execution time. Dynamic values for count must be specified as a template. For example, if a loop must run for a count which matches the length of a workflow input called StringArray, then the count must be specified using a template '{{ len .global.workflow.input.StringArray }}'. The count must be less than or equal to 100. If count is given as a dynamic value, and during execution time if count evaluates to be a value greater than 100, then the loop task will fail.", "type": "string", "x-omitempty": true }, "LoopStartTask": { "description": "Start task where the list of tasks will be executed multiple times based on the count or condition value.", "type": "string", "x-omitempty": true }, "OnFailure": { "description": "This specifies the name of the next task to run if all iterations of the loop task do not succeed. The unique name given to the task instance within the workflow must be provided here. In a graph model, denotes an edge to another Task Node.", "type": "string", "x-omitempty": true }, "OnSuccess": { "description": "This specifies the name of the next task to run if all iterations of the loop task succeeds. The unique name given to the task instance within the workflow must be provided here. In a graph model, denotes an edge to another Task Node.", "type": "string", "x-omitempty": true } } } ] }, "workflow.AbstractResourceSelector": { "title": "Workflow:Abstract Resource Selector", "description": "The abstract selector which can be used to create selection criteria for inputs.", "x-allOf-name": "workflow.AbstractResourceSelector", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" } ] }, "workflow.AbstractWorkerTask": { "title": "Workflow:Abstract Worker Task", "description": "An AbstractWorkerTask is used to model a task that does some end-user work. This can be another task or it can be another workflow.", "x-allOf-name": "workflow.AbstractWorkerTask", "allOf": [ { "$ref": "#/components/schemas/workflow.WorkflowTask" }, { "type": "object", "description": "Definition of the list of properties defined in 'workflow.AbstractWorkerTask', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "workflow.SubWorkflowTask", "workflow.WaitTask", "workflow.WorkerTask" ], "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "workflow.SubWorkflowTask", "workflow.WaitTask", "workflow.WorkerTask" ], "x-enum-as-string": true }, "InputParameters": { "description": "JSON formatted key-value pairs that define the inputs given to the task. Mapping for task inputs can be provided as either static values, direct mapping or advanced mapping using templates. The direct mapping can be specified as '${Source.< input | output | variable>.}'. 'Source' can be either workflow or the name of an earlier task within the workflow. You can map the task input to either a workflow input, a task output or a variable. Golang template syntax is supported for advanced mapping. A simple flattened example is \"InputParameters\":{ \"input1\":\"${workflow.variable.var1}\", \"input2\":\"prefixStr_{{.global.workflow.input.input1}}\" } where task input1 is mapped directly to variable var1 and task input2 is using a template to prefix a string to workflow input1 and then assign that value.", "x-omitempty": true }, "OnFailure": { "description": "This specifies the name of the next task to run if Task fails. This is the unique name given to the task instance within the workflow. In a graph model, denotes an edge to another Task Node.", "type": "string", "x-omitempty": true }, "OnSuccess": { "description": "This specifies the name of the next task to run if Task succeeds. This is the unique name given to the task instance within the workflow. In a graph model, denotes an edge to another Task Node.", "type": "string", "x-omitempty": true }, "RollbackDisabled": { "description": "The task is disabled/enabled for rollback operation in this workflow if the task has rollback support.", "type": "boolean", "default": false, "x-omitempty": true }, "VariableParameters": { "description": "JSON formatted key-value pairs that perform variable update at the end of the task execution. Mapping for variables can be provided as either static values, direct mapping or advanced mapping using templates. The direct mapping can be specified as '${Source.< input | output | variable>.}'. 'Source' can be either workflow or the name of the current or an earlier task within the workflow. You can map the variable to either a workflow input, a task output or another variable. Golang template syntax is supported for advanced mapping. A simple flattened example is \"VariableParameters\":{ \"var1\":\"${task1.output.output1}\", \"var2\":\"{{ Itoa .global.workflow.variable.varInt}}\" } where variable var1 is mapped directly to output1 of task1 and variable var2 is using a template to convert another variable varInt to string and assign that value.", "x-omitempty": true } } } ] }, "workflow.AnsibleBatchExecutor.Response": { "description": "The response body of a HTTP GET request for the 'workflow.AnsibleBatchExecutor' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'workflow.AnsibleBatchExecutor' resources.", "x-one-of-name": "workflow.AnsibleBatchExecutor.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/workflow.AnsibleBatchExecutor.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "workflow.AnsibleBatchExecutor": { "title": "Ansible Batch Executor", "description": "The AnsibleBatchExecutor object is a core component within Intersight's workflow framework, designed to facilitate the execution of Ansible commands in batch mode. By leveraging SSH requests, this object enables the execution of a series of Ansible playbooks as part of a single task, enhancing efficiency and automation capabilities.\n#### Purpose\nThe AnsibleBatchExecutor streamlines task execution by associating multiple Ansible commands with SSH requests, allowing for comprehensive task management within a unified framework. It integrates seamlessly with existing systems to support complex task orchestration.\n#### Key Concepts\n- **Batch Processing:** Allows multiple Ansible commands to be executed in a batch, reducing overhead and improving performance.\n- **Ansible Session:** Supports Ansible sessions, and in each session, a single Ansible playbook can be executed on the Ansible Control Node.", "x-allOf-name": "workflow.AnsibleBatchExecutor", "allOf": [ { "$ref": "#/components/schemas/workflow.BatchExecutor" }, { "type": "object", "description": "Definition of the list of properties defined in 'workflow.AnsibleBatchExecutor', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "workflow.AnsibleBatchExecutor" ], "default": "workflow.AnsibleBatchExecutor", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "workflow.AnsibleBatchExecutor" ], "default": "workflow.AnsibleBatchExecutor", "x-enum-as-string": true }, "TaskDefinition": { "$ref": "#/components/schemas/workflow.TaskDefinition.Relationship", "description": "A reference to a workflowTaskDefinition resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true } } } ] }, "workflow.AnsibleBatchExecutor.List": { "title": "List of 'workflow.AnsibleBatchExecutor' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'workflow.AnsibleBatchExecutor' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'workflow.AnsibleBatchExecutor' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/workflow.AnsibleBatchExecutor" }, "nullable": true } } } ] }, "workflow.AnsiblePlaySession": { "title": "Ansible Play Session", "description": "This models a single Ansible playbook execution session on the Ansible Control node. While execution of the respective Ansible task, the below provided property values are used to construct the SSH Batch executor, which gets executed on the endpoint.", "x-allOf-name": "workflow.AnsiblePlaySession", "allOf": [ { "$ref": "#/components/schemas/workflow.Api" }, { "type": "object", "description": "Definition of the list of properties defined in 'workflow.AnsiblePlaySession', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "workflow.AnsiblePlaySession" ], "default": "workflow.AnsiblePlaySession", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "workflow.AnsiblePlaySession" ], "default": "workflow.AnsiblePlaySession", "x-enum-as-string": true }, "CommandLineArguments": { "description": "The command line arguments for running the Ansible playbook against the given endpoint. Escape character backslash needs to be used when the command line arguments contain double quotes in them.", "type": "string", "x-omitempty": true }, "HostInventory": { "description": "The path of the host inventory file that resides on the Ansible Endpoint target or the comma separated list of hosts on which the Ansible playbook is to be run. Make sure to suffix a comma when the list of hosts is provided as input, even if the list has only one value.", "type": "string", "x-omitempty": true }, "PlaybookPath": { "description": "The path of the Ansible playbook that resides on the Ansible Endpoint target.", "type": "string", "x-omitempty": true }, "SshOpTimeout": { "description": "SSH operation timeout value in seconds. Value provided should be string representation of an interger.", "type": "string", "x-omitempty": true } } } ] }, "workflow.Api": { "title": "API", "description": "Intersight Orchestrator supports generic API workflow tasks that can execute\nan API given the request body and response parser specification.\nAPI type models a single API request within a batch of requests that get\nexecuted within a single workflow task.", "x-allOf-name": "workflow.Api", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'workflow.Api', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "workflow.AnsiblePlaySession", "workflow.CliCommand", "workflow.FileOperations", "workflow.PowerShellApi", "workflow.SshSession", "workflow.WebApi", "workflow.XmlApi" ], "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "workflow.AnsiblePlaySession", "workflow.CliCommand", "workflow.FileOperations", "workflow.PowerShellApi", "workflow.SshSession", "workflow.WebApi", "workflow.XmlApi" ], "x-enum-as-string": true }, "AssetTargetMoid": { "description": "Asset target defines the remote target endpoints which are either managed by\nIntersight or their service APIs are invoked from Intersight. Generic API executor\nservice Jasmine can invoke these remote APIs via its executors. Asset targets can be\naccessed directly for cloud targets or via an associated Intersight Assist. Prerequisite\nto use asset targets is to persist the target details.\nAsset target MoRef can be given as task input of type TargetDataType. Fusion determines\nand populates the target context with the Assist if associated with. It is set\ninternally at the API level.\nIn case of an associated assist, it is used by Assist to fetch the target details\nand form the API request to send to endpoints. In case of cloud asset targets, Jasmine\nfetched the target details from DB, forms the API request and sends it to the target.", "type": "string", "readOnly": true, "x-omitempty": true }, "Body": { "description": "The optional request body that is sent as part of this API request.\nThe request body can contain a golang template that can be populated with task input\nparameters and previous API output parameters.", "type": "string", "x-omitempty": true }, "ContentType": { "description": "Intersight Orchestrator, with the support of response parser specification,\ncan extract the values from API responses and map them to task output parameters.\nThe value extraction is supported for response content types XML, JSON and Text.\nThe type of the content that gets passed as payload and response in this\nAPI. The supported values are json, xml, text.", "type": "string", "x-omitempty": true }, "Description": { "description": "A description that task designer can add to individual API requests that explain \nwhat the API call is about.", "type": "string", "x-omitempty": true }, "ErrorContentType": { "description": "Intersight Orchestrator, with the support of response parser specification,\ncan extract the values from API responses and map them to task output parameters.\nThe value extraction is supported for response content types XML, JSON and Text.\nOptional input to specify the content type in case of error API response. This\nshould be used if the content type of error response is different from that of\nthe success response. If not specified, contentType input value is used to parse\nthe error response.", "type": "string", "x-omitempty": true }, "Label": { "description": "A user friendly label that task designers have given to the batch API request.", "type": "string", "x-omitempty": true }, "Name": { "description": "A reference name for this API request within the batch API request.\nThis name shall be used to map the API output parameters to subsequent\nAPI input parameters within a batch API task.", "type": "string", "x-omitempty": true }, "Outcomes": { "description": "All the possible outcomes of this API are captured here. Outcomes property\nis a collection property of type workflow.Outcome objects.\nThe outcomes can be mapped to the message to be shown. The outcomes are\nevaluated in the order they are given. At the end of the outcomes list,\nan catchall success/fail outcome can be added with condition as 'true'.\nThis is an optional\nproperty and if not specified the task will be marked as success.", "nullable": true, "x-omitempty": true }, "ResponseSpec": { "description": "The optional grammar specification for parsing the response to extract the\nrequired values.\nThe specification should have extraction specification specified for\nall the API output parameters.", "nullable": true, "x-omitempty": true }, "SkipOnCondition": { "description": "The skip expression, if provided, allows the batch API executor to skip the\napi execution when the given expression evaluates to true.\nThe expression is given as such a golang template that has to be\nevaluated to a final content true/false. The expression is an optional and in\ncase not provided, the API will always be executed.", "type": "string", "x-omitempty": true }, "StartDelay": { "description": "The delay in seconds after which the API needs to be executed.\nBy default, the given API is executed immediately. Specifying a start delay adds to the delay to execution.\nStart Delay is not supported for the first API in the Batch and cumulative delay of all the APIs in the Batch should not exceed the task time out.", "type": "integer", "format": "int64", "x-omitempty": true }, "Timeout": { "description": "The duration in seconds by which the API response is expected from the API target.\nIf the end point does not respond for the API request within this timeout\nduration, the task will be marked as failed.", "type": "integer", "format": "int64", "x-omitempty": true } } } ] }, "workflow.ArrayDataType": { "title": "Workflow:Array Data Type", "description": "This data type represents an array of a given type. It can be an array of primitive data or of custom data.", "x-allOf-name": "workflow.ArrayDataType", "allOf": [ { "$ref": "#/components/schemas/workflow.BaseDataType" }, { "type": "object", "description": "Definition of the list of properties defined in 'workflow.ArrayDataType', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "workflow.ArrayDataType" ], "default": "workflow.ArrayDataType", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "workflow.ArrayDataType" ], "default": "workflow.ArrayDataType", "x-enum-as-string": true }, "ArrayItemType": { "description": "Data item within the array data type.", "$ref": "#/components/schemas/workflow.ArrayItem", "x-omitempty": true }, "Max": { "description": "Specify the maximum value of the array.", "type": "integer", "format": "int64", "x-omitempty": true }, "Min": { "description": "Specify the minimum value of the array.", "type": "integer", "format": "int64", "x-omitempty": true } } } ] }, "workflow.ArrayItem": { "title": "Workflow:Array Item", "description": "ArrayItem represents an array item within the array.", "x-allOf-name": "workflow.ArrayItem", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" } ] }, "workflow.AssociatedRoles": { "title": "Workflow:Associated Roles", "description": "AssociatedRoles models the inferred tasks to the required roles mapping cached in the\nworkflow definition.", "x-allOf-name": "workflow.AssociatedRoles", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'workflow.AssociatedRoles', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "workflow.AssociatedRoles" ], "default": "workflow.AssociatedRoles", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "workflow.AssociatedRoles" ], "default": "workflow.AssociatedRoles", "x-enum-as-string": true }, "Moid": { "description": "Stores the identifier of the task definition for which the required roles are cached\nin the workflow definition.\nIn the case of sub workflow tasks, this property stores the identifier of the workflow\nthat is wrapped in the sub workflow task.", "type": "string", "readOnly": true, "x-omitempty": true }, "PrivilegeSets": { "type": "array", "items": { "description": "Stores the identifiers of the privilege sets that are required to execute the task.\nThis is applicable only for worker tasks.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "RequiredPrivilegeNames": { "type": "array", "items": { "description": "For tasks in this workflow that invoke Intersight APIs calls, the privileges required to invoke the APIs are collected in this property.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Roles": { "type": "array", "items": { "description": "Stores the identifiers of the required task roles in case of the worker task for which\nthe roles are cached.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "TaskNames": { "type": "array", "items": { "description": "Stores the task reference names used within the workflow that refer to the task definition.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "WorkflowRoles": { "type": "array", "items": { "description": "Stores the required roles of the workflow definition in case of a sub workflow task.", "$ref": "#/components/schemas/workflow.AssociatedRoles", "readOnly": true, "x-omitempty": true }, "nullable": true } } } ] }, "workflow.BaseDataType": { "title": "Workflow:Base Data Type", "description": "The base data type that is used to derive all the other data types for inputs and outputs.", "x-allOf-name": "workflow.BaseDataType", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'workflow.BaseDataType', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "workflow.ArrayDataType", "workflow.CustomDataType", "workflow.DynamicTemplateParserDataType", "workflow.MoInventoryDataType", "workflow.MoReferenceAutoDataType", "workflow.MoReferenceDataType", "workflow.MoReferenceForCloneDataType", "workflow.PrimitiveDataType", "workflow.TargetDataType" ], "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "workflow.ArrayDataType", "workflow.CustomDataType", "workflow.DynamicTemplateParserDataType", "workflow.MoInventoryDataType", "workflow.MoReferenceAutoDataType", "workflow.MoReferenceDataType", "workflow.MoReferenceForCloneDataType", "workflow.PrimitiveDataType", "workflow.TargetDataType" ], "x-enum-as-string": true }, "Default": { "description": "Default value for the data type. If default value was provided and the input was required the default value will be used as the input.", "$ref": "#/components/schemas/workflow.DefaultValue", "x-omitempty": true }, "Description": { "description": "Provide a detailed description of the data type.", "type": "string", "x-omitempty": true }, "DisplayMeta": { "description": "Captures the meta data needed for displaying workflow data types in Intersight User Interface.", "$ref": "#/components/schemas/workflow.DisplayMeta", "x-omitempty": true }, "InputParameters": { "description": "JSON formatted mapping from other property of the definition to the current property. Input parameter mapping is supported only for custom data type property in workflow definition and custom data type definition. The format to specify mapping ina workflow definition when source property is of scalar types is '${workflow.input.property}'. The format to specify mapping when the source property is of object reference and mapping needs to be made to the property of the object is '${workflow.input.property.subproperty}'. The format to specify mapping in a custom data type definition is '${datatype.type.property}'. When the current property is of non-scalar type like composite custom data type, then mapping can be provided to the individual property of the custom data type like 'cdt_property:${workflow.input.property}'.", "x-omitempty": true }, "Label": { "description": "Descriptive label for the data type. Label can only contain letters (a-z, A-Z), numbers (0-9), hyphen (-), space ( ), forward slash (/) or an underscore (_). The first and last character in label must be an alphanumeric character.", "type": "string", "pattern": "^[a-zA-Z0-9]+[\\sa-zA-Z0-9_'.:/-]{1,92}$", "minLength": 1, "maxLength": 92, "x-omitempty": true }, "Name": { "description": "Descriptive name for the data type. Name can only contain letters (a-z, A-Z), numbers (0-9), hyphen (-) or an underscore (_). The first and last character in name must be an alphanumeric character.", "type": "string", "pattern": "^[a-zA-Z0-9]+([a-zA-Z0-9-_]*[a-zA-Z0-9])*$", "minLength": 1, "maxLength": 92, "x-omitempty": true }, "Required": { "description": "Specifies whether this parameter is required. The field is applicable for task and workflow.", "type": "boolean", "x-omitempty": true } } } ] }, "workflow.BaseOperation": { "title": "Workflow:Base Operation", "description": "Specify operation type on a service item like deployment or post-deployment to be performed on catalog.", "x-allOf-name": "workflow.BaseOperation", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'workflow.BaseOperation', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "workflow.OperationTypeDecommission", "workflow.OperationTypeDeployment", "workflow.OperationTypePostDeployment" ], "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "workflow.OperationTypeDecommission", "workflow.OperationTypeDeployment", "workflow.OperationTypePostDeployment" ], "x-enum-as-string": true }, "OperationType": { "description": "Type of action operation to be performed on the service item.\n* `PostDeployment` - This represents the post-deployment actions for the resources created or defined through the deployment action. There can be more than one post-deployment operations associated with a service item.\n* `Deployment` - This represents the deploy action, for the service item action definition. This operation type is used to create or define resources that is managed by the service item. There can only be one Service Item Action Definition that can be marked with the operation type as Deployment and this is a mandatory operation type. All valid Service Items must have one and only one operation type marked as type Deployment.\n* `Decommission` - This represents the decommission action, used to decommission the created resources. All valid Service Items must have one and only one operation type marked as type Decommission. Once a decommission action is run on a Service Item, no further operations are allowed on that Service Item.\n* `Migration` - This represents the migration action, used to migrate service item instance from one service item definition version to another service item definition version. There can be more than one migration operations associated with a service item. Once a migration action is running on a service item instance, no further operations are allowed on that service item instance during the migration process.", "type": "string", "enum": [ "PostDeployment", "Deployment", "Decommission", "Migration" ], "default": "PostDeployment", "x-createOnly": true, "x-omitempty": true } } } ] }, "workflow.BaseServiceItemActionProperty": { "title": "Workflow:Base Service Item Action Property", "description": "BaseServiceItemActionProperty is the abstract definition to capture the properties in ServiceItemActionProperties.", "x-allOf-name": "workflow.BaseServiceItemActionProperty", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" } ] }, "workflow.BatchApiExecutor.Response": { "description": "The response body of a HTTP GET request for the 'workflow.BatchApiExecutor' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'workflow.BatchApiExecutor' resources.", "x-one-of-name": "workflow.BatchApiExecutor.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/workflow.BatchApiExecutor.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "workflow.BatchApiExecutor": { "title": "Batch API", "description": "The BatchApiExecutor object is a key component within the workflow system that facilitates the execution of multiple API requests as part of a single task execution. It is designed to handle batch operations efficiently, allowing users to define and execute a series of API calls in a cohesive manner.\n#### Purpose\nThe BatchApiExecutor serves as a mechanism to associate and manage a list of API requests that need to be executed together. This provides the ability to define API tasks using the API request body and a response parser specification, thus streamlining the execution process within a workflow.\n#### Key Concepts\n- **Batch Execution:** Enables the grouping and execution of multiple API requests as a single task, enhancing operational efficiency.\n- **Access Control:** Utilizes privilege sets to manage who can read, update, create, and delete batch API tasks, ensuring security and proper governance.\n- **Error Handling:** Integrates with error response handlers to provide robust mechanisms for parsing and managing error responses from API calls.", "x-allOf-name": "workflow.BatchApiExecutor", "allOf": [ { "$ref": "#/components/schemas/workflow.BatchExecutor" }, { "type": "object", "description": "Definition of the list of properties defined in 'workflow.BatchApiExecutor', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "workflow.BatchApiExecutor" ], "default": "workflow.BatchApiExecutor", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "workflow.BatchApiExecutor" ], "default": "workflow.BatchApiExecutor", "x-enum-as-string": true }, "ErrorResponseHandler": { "$ref": "#/components/schemas/workflow.ErrorResponseHandler.Relationship", "description": "A reference to a workflowErrorResponseHandler resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "TaskDefinition": { "$ref": "#/components/schemas/workflow.TaskDefinition.Relationship", "description": "A reference to a workflowTaskDefinition resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true } } } ] }, "workflow.BatchApiExecutor.List": { "title": "List of 'workflow.BatchApiExecutor' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'workflow.BatchApiExecutor' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'workflow.BatchApiExecutor' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/workflow.BatchApiExecutor" }, "nullable": true } } } ] }, "workflow.BatchExecutor": { "title": "Batch Executor", "description": "Intersight support for creating generic API tasks using the API request body and a response parser specification in the form of a content.Grammar object. \nThe Batch API associates a list of API requests to be executed as part of a single task, with each request containing a request body and a response parser specification.", "x-allOf-name": "workflow.BatchExecutor", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'workflow.BatchExecutor', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "workflow.AnsibleBatchExecutor", "workflow.BatchApiExecutor", "workflow.PowerShellBatchApiExecutor", "workflow.SshBatchExecutor" ], "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "workflow.AnsibleBatchExecutor", "workflow.BatchApiExecutor", "workflow.PowerShellBatchApiExecutor", "workflow.SshBatchExecutor" ], "x-enum-as-string": true }, "Batch": { "type": "array", "items": { "description": "Support for one or a batch of APIs to be executed as part of the task's execution, with the batch being non-empty.", "$ref": "#/components/schemas/workflow.Api", "x-omitempty": true }, "minItems": 1, "nullable": true }, "CancelAction": { "type": "array", "items": { "description": "Support for one or a batch of APIs to be executed as part of the task's cancel action, with the option for an empty cancel action.", "$ref": "#/components/schemas/workflow.Api", "x-omitempty": true }, "minItems": 0, "nullable": true }, "Constraints": { "description": "Constraints for matching this task against the task definition.", "$ref": "#/components/schemas/workflow.TaskConstraints", "x-omitempty": true }, "Description": { "description": "Detailed description of the batch APIs.", "type": "string", "x-omitempty": true }, "Name": { "description": "Name of the batch API task.", "type": "string", "x-omitempty": true }, "Outcomes": { "description": "Collection of possible task outcomes, represented as workflow.Outcome objects. Outcomes can be mapped to messages and are evaluated in the given order. \nA catch-all success or failure outcome with condition 'true' can be included at the end. Optional property; if not specified, the task defaults to success.", "nullable": true, "x-omitempty": true }, "Output": { "description": "JSON mapping of extracted API response values to task output parameters, using API response grammar defined in Intersight Orchestrator.", "nullable": true, "x-omitempty": true }, "RetryFromFailedApi": { "description": "Flag indicating if the retry task should from the failed API or the first API in the batch execution; default value is false.", "type": "boolean", "x-omitempty": true }, "SkipOnCondition": { "description": "Optional skip expression allowing the batch API executor to skip task execution when the provided Go template expression evaluates to true. \nIf not specified, the API will always be executed.", "type": "string", "x-omitempty": true }, "UiRenderingData": { "description": "Data required for rendering the task in the user interface.", "nullable": true, "x-omitempty": true } } } ] }, "workflow.CancelableType": { "title": "Workflow:Cancelable Type", "description": "Defines the conditions under which a workflow can be canceled.", "x-allOf-name": "workflow.CancelableType", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'workflow.CancelableType', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "workflow.CancelableType" ], "default": "workflow.CancelableType", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "workflow.CancelableType" ], "default": "workflow.CancelableType", "x-enum-as-string": true }, "CancelableStates": { "type": "array", "items": { "description": "List of workflow states at which the workflow is allowed to be canceled.", "type": "string", "x-omitempty": true }, "nullable": true }, "Enabled": { "description": "When true the workflow can be cancelled. The action can be further restricted by the mode and cancelableStates properties.", "type": "boolean", "default": true, "x-omitempty": true }, "Mode": { "description": "Mode controls how the workflow can be canceled.\n* `ApiOnly` - The workflow can only be canceled via API call.\n* `All` - The workflow can be canceled from API or from the user interface.", "type": "string", "enum": [ "ApiOnly", "All" ], "default": "ApiOnly", "x-omitempty": true } } } ] }, "workflow.Catalog.Response": { "description": "The response body of a HTTP GET request for the 'workflow.Catalog' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'workflow.Catalog' resources.", "x-one-of-name": "workflow.Catalog.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/workflow.Catalog.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "workflow.Catalog.Relationship": { "description": "A relationship to the 'workflow.Catalog' resource, or the expanded 'workflow.Catalog' resource, or the 'null' value.", "x-one-of-name": "workflow.Catalog.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/workflow.Catalog" } ], "discriminator": { "propertyName": "ClassId" } }, "workflow.Catalog": { "title": "Workflow:Catalog", "description": "The Catalog object serves as a container for organizing definitions related to orchestration, including both workflow, task definitions and more.\n#### Purpose\nIt provides a structured way to manage and isolate orchestration assets. Each user account has a local catalog for private definitions, while Cisco provides shared catalogs containing validated workflows and tasks for use within the account context.\n#### Key Concepts\n- **Asset Organization:** Groups workflow and task definitions for better discovery and management.\n- **Access Context:** Supports both private account-level catalogs and shared, Cisco-managed catalogs.\n- **Namespace Management:** Ensures unique identification of orchestration assets within the organizational context.", "x-allOf-name": "workflow.Catalog", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'workflow.Catalog', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "workflow.Catalog" ], "default": "workflow.Catalog", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "workflow.Catalog" ], "default": "workflow.Catalog", "x-enum-as-string": true }, "Name": { "description": "A unique name for the catalog.", "type": "string", "x-omitempty": true }, "Organization": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/organization.Organization.Relationship", "description": "A reference to a organizationOrganization resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true } } } ] }, "workflow.Catalog.List": { "title": "List of 'workflow.Catalog' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'workflow.Catalog' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'workflow.Catalog' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/workflow.Catalog" }, "nullable": true } } } ] }, "workflow.CatalogItemDefinition.Response": { "description": "The response body of a HTTP GET request for the 'workflow.CatalogItemDefinition' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'workflow.CatalogItemDefinition' resources.", "x-one-of-name": "workflow.CatalogItemDefinition.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/workflow.CatalogItemDefinition.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "workflow.CatalogItemDefinition.Relationship": { "description": "A relationship to the 'workflow.CatalogItemDefinition' resource, or the expanded 'workflow.CatalogItemDefinition' resource, or the 'null' value.", "x-one-of-name": "workflow.CatalogItemDefinition.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/workflow.CatalogItemDefinition" } ], "discriminator": { "propertyName": "ClassId" } }, "workflow.CatalogItemDefinition": { "title": "Catalog Item Definition", "description": "Catalog Item definition is a collection of Service items which are associated with workflow definition that can be used to deploy and manage service items.", "x-allOf-name": "workflow.CatalogItemDefinition", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'workflow.CatalogItemDefinition', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "workflow.CatalogItemDefinition" ], "default": "workflow.CatalogItemDefinition", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "workflow.CatalogItemDefinition" ], "default": "workflow.CatalogItemDefinition", "x-enum-as-string": true }, "Description": { "description": "The description for the catalog item which provides information on what are the pre-requisites to deploy the resource.", "type": "string", "x-omitempty": true }, "Label": { "description": "A user friendly short name to identify the catalog item. Name can only contain letters (a-z, A-Z), numbers (0-9), hyphen (-), period (.), colon (:), space ( ) or an underscore (_).", "type": "string", "pattern": "^[a-zA-Z0-9]+[\\sa-zA-Z0-9_.:-]{1,92}$", "x-omitempty": true }, "Name": { "description": "The name for this catalog item definition. You can have multiple versions of the catalog item with the same name. Name can only contain letters (a-z, A-Z), numbers (0-9), hyphen (-), period (.), colon (:) or an underscore (_).", "type": "string", "pattern": "^[a-zA-Z0-9_.:-]{1,64}$", "x-omitempty": true }, "PublishStatus": { "description": "Publish status of the catalog item.\n* `Draft` - The enum specifies the option as Draft which means the meta definition is being designed and tested.\n* `Published` - The enum specifies the option as Published which means the meta definition is ready for consumption.\n* `Archived` - The enum specifies the option as Archived which means the meta definition is archived and can no longer be consumed.", "type": "string", "enum": [ "Draft", "Published", "Archived" ], "default": "Draft", "x-omitempty": true }, "ServiceItems": { "type": "array", "items": { "description": "Service item types associated with this catalog item.", "$ref": "#/components/schemas/workflow.ServiceItemType", "x-omitempty": true }, "nullable": true }, "SupportStatus": { "description": "The CatalogItem Support depicts the support status of catalog, the values will be any of Supported or Deprecated state. The user can create a Catalog Service Request if the support status is supported, if its Deprecated then it cannot be instantiated.\n* `Supported` - The definition is a supported version and there will be no changes to the mandatory inputs or outputs.\n* `Beta` - The definition is a Beta version and this version can under go changes until the version is marked supported.\n* `Deprecated` - The version of definition is deprecated and typically there will be a higher version of the same definition that has been added.", "type": "string", "enum": [ "Supported", "Beta", "Deprecated" ], "default": "Supported", "x-omitempty": true }, "UserIdOrEmail": { "description": "The user identifier who created or updated the catalog item definition.", "type": "string", "readOnly": true, "x-omitempty": true }, "ValidationInformation": { "description": "The current validation state of catalog and associated validation errors when state is invalid.", "$ref": "#/components/schemas/workflow.ValidationInformation", "readOnly": true, "x-omitempty": true }, "Version": { "description": "The version of the catalog item to support multiple versions.", "type": "integer", "format": "int64", "default": 1, "minimum": 1, "x-createOnly": true, "x-omitempty": true }, "Organization": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/organization.Organization.Relationship", "description": "A reference to a organizationOrganization resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true } } } ] }, "workflow.CatalogItemDefinition.List": { "title": "List of 'workflow.CatalogItemDefinition' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'workflow.CatalogItemDefinition' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'workflow.CatalogItemDefinition' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/workflow.CatalogItemDefinition" }, "nullable": true } } } ] }, "workflow.CatalogServiceRequest.Response": { "description": "The response body of a HTTP GET request for the 'workflow.CatalogServiceRequest' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'workflow.CatalogServiceRequest' resources.", "x-one-of-name": "workflow.CatalogServiceRequest.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/workflow.CatalogServiceRequest.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "workflow.CatalogServiceRequest.Relationship": { "description": "A relationship to the 'workflow.CatalogServiceRequest' resource, or the expanded 'workflow.CatalogServiceRequest' resource, or the 'null' value.", "x-one-of-name": "workflow.CatalogServiceRequest.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/workflow.CatalogServiceRequest" } ], "discriminator": { "propertyName": "ClassId" } }, "workflow.CatalogServiceRequest": { "title": "Catalog Service Request", "description": "Catalog Service Request is one instance of a catalog item based on a catalog item definition.", "x-allOf-name": "workflow.CatalogServiceRequest", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'workflow.CatalogServiceRequest', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "workflow.CatalogServiceRequest" ], "default": "workflow.CatalogServiceRequest", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "workflow.CatalogServiceRequest" ], "default": "workflow.CatalogServiceRequest", "x-enum-as-string": true }, "Description": { "description": "The description for this catalog service request which provides information on request from the user.", "type": "string", "x-omitempty": true }, "EndTime": { "description": "The time at which the service request completed or stopped.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "Input": { "description": "Inputs for a catalog service request instance creation, format is specified by input definition of the catalog item definition.", "x-omitempty": true }, "Label": { "description": "A user friendly short name to identify the catalog service request instance. Name can only contain letters (a-z, A-Z), numbers (0-9), hyphen (-), period (.), colon (:), space ( ) or an underscore (_).", "type": "string", "pattern": "^$|^[a-zA-Z0-9]+[\\sa-zA-Z0-9_.:-]{1,92}$", "x-omitempty": true }, "Messages": { "type": "array", "items": { "description": "Captures log messages for each of the service item contained in the catalog service request.", "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/servicerequest.Message", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Name": { "description": "A name of the catalog service request instance.", "type": "string", "pattern": "^[a-zA-Z0-9]+[\\sa-zA-Z0-9_.:-]{1,92}$", "x-omitempty": true }, "Operation": { "description": "Captures the operation to be performed as part of catalog service request.", "$ref": "#/components/schemas/workflow.BaseOperation", "x-omitempty": true }, "SelectionCriteriaInputs": { "type": "array", "items": { "description": "Captures the policy input, value and filter conditions which are used for extracting the value.", "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/serviceitem.SelectionCriteriaInput", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Status": { "description": "Status of the catalog service request instance which determines the actions that are allowed on this instance.\n* `NotCreated` - The service item is not yet created and it is in a draft mode. A service item instance can be deleted in this state.\n* `InProgress` - An action is in progress and until that action has reached a final state, another action cannot be started.\n* `Failed` - The last action on the service item instance failed and corrective measures need to be taken to bring the service item instance back to valid state.\n* `Okay` - The last action on the service item instance completed and the service item instance is in Okay state.\n* `Decommissioned` - The service item is decommissioned and can be safely deleted. A service item instance in any other state after it has been created cannot be deleted until it has been decommissioned.", "type": "string", "enum": [ "NotCreated", "InProgress", "Failed", "Okay", "Decommissioned" ], "default": "NotCreated", "readOnly": true, "x-omitempty": true }, "UserIdOrEmail": { "description": "The user identifier who invoked the request to create the catalog service request.", "type": "string", "readOnly": true, "x-omitempty": true }, "CatalogItemDefinition": { "$ref": "#/components/schemas/workflow.CatalogItemDefinition.Relationship", "description": "A reference to a workflowCatalogItemDefinition resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true }, "Idp": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/iam.Idp.Relationship", "description": "A reference to a iamIdp resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "IdpReference": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/iam.IdpReference.Relationship", "description": "A reference to a iamIdpReference resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "Organization": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/organization.Organization.Relationship", "description": "A reference to a organizationOrganization resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "ServiceItemActionInstances": { "description": "An array of relationships to workflowServiceItemActionInstance resources.", "type": "array", "items": { "$ref": "#/components/schemas/workflow.ServiceItemActionInstance.Relationship" }, "nullable": true, "readOnly": true }, "ServiceItemInstances": { "description": "An array of relationships to workflowServiceItemInstance resources.", "type": "array", "items": { "$ref": "#/components/schemas/workflow.ServiceItemInstance.Relationship" }, "nullable": true, "readOnly": true }, "User": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/iam.User.Relationship", "description": "A reference to a iamUser resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." } } } ] }, "workflow.CatalogServiceRequest.List": { "title": "List of 'workflow.CatalogServiceRequest' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'workflow.CatalogServiceRequest' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'workflow.CatalogServiceRequest' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/workflow.CatalogServiceRequest" }, "nullable": true } } } ] }, "workflow.CliCommand": { "title": "CLI Command", "description": "This models a single CLI command that can be executed on the end point.", "x-allOf-name": "workflow.CliCommand", "allOf": [ { "$ref": "#/components/schemas/workflow.Api" }, { "type": "object", "description": "Definition of the list of properties defined in 'workflow.CliCommand', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "workflow.CliCommand" ], "default": "workflow.CliCommand", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "workflow.CliCommand" ], "default": "workflow.CliCommand", "x-enum-as-string": true }, "Command": { "description": "The command to run on the device connector.", "type": "string", "x-omitempty": true }, "EndPrompt": { "description": "The regex string that identifies the end of the command response.", "type": "string", "x-omitempty": true }, "ExpectPrompts": { "type": "array", "items": { "description": "Cli prompts required as part of interactive command execution. For e.g. login credentials will be part of prompts\nwhich are provided as list of expect prompt regex and corresponding answer string.", "$ref": "#/components/schemas/workflow.ExpectPrompt", "x-omitempty": true }, "nullable": true }, "ExpectedExitCodes": { "type": "array", "items": { "description": "Optional array of integer values to specify the expected exit codes of a CLI command. CLI command execution\nis marked success upon receiving any of the expected exit code from command execution. If not set, success\nexit code of 0 is expected from command execution.", "type": "integer", "format": "int64", "x-omitempty": true }, "nullable": true }, "SkipStatusCheck": { "description": "Skips the execution status check of the terminal command. One use case for this is while exiting the\nterminal session from esxi host.", "type": "boolean", "x-omitempty": true }, "TerminalEnd": { "description": "If this flag is set, it marks the end of the terminal session where the previous commands were executed.", "type": "boolean", "x-omitempty": true }, "TerminalStart": { "description": "If this flag is set, the execution of this command initiates a terminal session in which the subsequent\nCLI commands are executed until a command with terminalEnd flag is encountered or the end of the batch.", "type": "boolean", "x-omitempty": true }, "Type": { "description": "The type of the command - can be interactive or non-interactive.\n* `NonInteractive` - The CLI command is not an interactive command.\n* `Interactive` - The CLI command is executed in interactive mode and the command must provide the expects andanswers.", "type": "string", "enum": [ "NonInteractive", "Interactive" ], "default": "NonInteractive", "x-omitempty": true } } } ] }, "workflow.Comments": { "title": "Workflow:Comments", "description": "Contains detailed information about template function.", "x-allOf-name": "workflow.Comments", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'workflow.Comments', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "workflow.Comments" ], "default": "workflow.Comments", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "workflow.Comments" ], "default": "workflow.Comments", "x-enum-as-string": true }, "Description": { "description": "Description field provides comment about the template function.", "type": "string", "x-omitempty": true }, "Examples": { "type": "array", "items": { "description": "The example describes the invocation method for template API.", "type": "string", "x-omitempty": true }, "nullable": true } } } ] }, "workflow.Constraints": { "title": "Workflow:Constraints", "description": "Captures the constraints for valid parameter values.", "x-allOf-name": "workflow.Constraints", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'workflow.Constraints', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "workflow.Constraints" ], "default": "workflow.Constraints", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "workflow.Constraints" ], "default": "workflow.Constraints", "x-enum-as-string": true }, "EnumList": { "type": "array", "items": { "description": "When the parameter is a enum then this list of enum entry is used to validate the input belongs to one of items in the list.", "$ref": "#/components/schemas/workflow.EnumEntry", "x-omitempty": true }, "nullable": true }, "Max": { "description": "Allowed maximum value of the parameter if parameter is integer/float or maximum length of the parameter if the parameter is string. When max and min are set to 0, then the limits are not checked. If parameter is integer/float, then maximum number supported is 1.797693134862315708145274237317043567981e+308 or (2**1023 * (2**53 - 1) / 2**52). When a number bigger than this is given as Maximum value, the constraints will not be enforced.", "type": "number", "format": "double", "x-omitempty": true }, "Min": { "description": "Allowed minimum value of the parameter if parameter is integer/float or minimum length of the parameter if the parameter is string. When max and min are set to 0, then the limits are not checked. If parameter is integer/float, then minimum number supported is 4.940656458412465441765687928682213723651e-324 or (1 / 2 ** (1023 - 1 + 52)). When a number smaller than this is given as minimum value, the constraints will not be enforced.", "type": "number", "format": "double", "x-omitempty": true }, "Regex": { "description": "When the parameter is a string this regular expression is used to ensure the value is valid.", "type": "string", "x-omitempty": true } } } ] }, "workflow.ControlTask": { "title": "Workflow:Control Task", "description": "Control tasks run within the workflow engine and are not executed by remote worker microservices. They are used to modify flow of control within a workflow.", "x-allOf-name": "workflow.ControlTask", "allOf": [ { "$ref": "#/components/schemas/workflow.WorkflowTask" } ] }, "workflow.CustomArrayItem": { "title": "Workflow:Custom Array Item", "description": "Captures an array of custom datatype items.", "x-allOf-name": "workflow.CustomArrayItem", "allOf": [ { "$ref": "#/components/schemas/workflow.ArrayItem" }, { "type": "object", "description": "Definition of the list of properties defined in 'workflow.CustomArrayItem', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "workflow.CustomArrayItem" ], "default": "workflow.CustomArrayItem", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "workflow.CustomArrayItem" ], "default": "workflow.CustomArrayItem", "x-enum-as-string": true }, "Properties": { "description": "Captures an array item which is of custom data type.", "$ref": "#/components/schemas/workflow.CustomDataProperty", "x-omitempty": true } } } ] }, "workflow.CustomDataProperty": { "title": "Workflow:Custom Data Property", "description": "Capture all the properties for Custom data type.", "x-allOf-name": "workflow.CustomDataProperty", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'workflow.CustomDataProperty', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "workflow.CustomDataProperty" ], "default": "workflow.CustomDataProperty", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "workflow.CustomDataProperty" ], "default": "workflow.CustomDataProperty", "x-enum-as-string": true }, "CatalogMoid": { "description": "Specify the catalog moid that this custom data type belongs.", "type": "string", "x-omitempty": true }, "CustomDataTypeId": { "description": "The resolved custom data type definition managed object.", "type": "string", "readOnly": true, "x-omitempty": true }, "CustomDataTypeName": { "description": "Name of the custom data type for this input.", "type": "string", "x-omitempty": true } } } ] }, "workflow.CustomDataType": { "title": "Workflow:Custom Data Type", "description": "This data type represents a custom data object.", "x-allOf-name": "workflow.CustomDataType", "allOf": [ { "$ref": "#/components/schemas/workflow.BaseDataType" }, { "type": "object", "description": "Definition of the list of properties defined in 'workflow.CustomDataType', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "workflow.CustomDataType" ], "default": "workflow.CustomDataType", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "workflow.CustomDataType" ], "default": "workflow.CustomDataType", "x-enum-as-string": true }, "Properties": { "description": "Captures the custom data type properties.", "$ref": "#/components/schemas/workflow.CustomDataProperty", "x-omitempty": true } } } ] }, "workflow.CustomDataTypeDefinition.Response": { "description": "The response body of a HTTP GET request for the 'workflow.CustomDataTypeDefinition' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'workflow.CustomDataTypeDefinition' resources.", "x-one-of-name": "workflow.CustomDataTypeDefinition.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/workflow.CustomDataTypeDefinition.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "workflow.CustomDataTypeDefinition.Relationship": { "description": "A relationship to the 'workflow.CustomDataTypeDefinition' resource, or the expanded 'workflow.CustomDataTypeDefinition' resource, or the 'null' value.", "x-one-of-name": "workflow.CustomDataTypeDefinition.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/workflow.CustomDataTypeDefinition" } ], "discriminator": { "propertyName": "ClassId" } }, "workflow.CustomDataTypeDefinition": { "title": "Custom Datatype", "description": "The CustomDataTypeDefinition object provides a framework for defining customized data types used within workflows, enhancing flexibility and reusability.\n#### Purpose\nCustomDataTypeDefinition allows users to create and manage data types that can be used as inputs or outputs in workflows, tailoring data handling to specific use cases and requirements.\n#### Key Concepts\n- **Flexibility:** Supports the creation of complex data structures that can be reused across multiple workflows.\n- **Type Management:** Provides capabilities to define properties, constraints, and relationships for custom data types.", "x-allOf-name": "workflow.CustomDataTypeDefinition", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'workflow.CustomDataTypeDefinition', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "workflow.CustomDataTypeDefinition" ], "default": "workflow.CustomDataTypeDefinition", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "workflow.CustomDataTypeDefinition" ], "default": "workflow.CustomDataTypeDefinition", "x-enum-as-string": true }, "CompositeType": { "description": "When true this data type definition is a collection of type definitions to represent composite data like JSON.", "type": "boolean", "default": false, "x-omitempty": true }, "Description": { "description": "A human-friendly description of this custom data type indicating it's domain and usage.", "type": "string", "x-omitempty": true }, "Label": { "description": "A user friendly short name to identify the custom data type definition. Label can only contain letters (a-z, A-Z), numbers (0-9), hyphen (-), period (.), colon (:), space ( ), single quote ('), or an underscore (_) and must be at least 2 characters.", "type": "string", "pattern": "^[a-zA-Z0-9]+[\\sa-zA-Z0-9_'.:-]{1,92}$", "x-omitempty": true }, "Name": { "description": "The name of custom data type definition. The valid name can contain lower case and upper case alphabetic characters, digits and special characters '-' and '_'.", "type": "string", "pattern": "^[a-zA-Z0-9_-]{1,64}$", "x-createOnly": true, "x-omitempty": true }, "ParameterSet": { "type": "array", "items": { "description": "Parameter set rules that will govern the applicability of parameters.", "$ref": "#/components/schemas/workflow.ParameterSet", "x-omitempty": true }, "nullable": true }, "Properties": { "description": "Type to capture all the properties for the custom data type definition.", "$ref": "#/components/schemas/workflow.CustomDataTypeProperties", "x-omitempty": true }, "TypeDefinition": { "type": "array", "items": { "description": "The properties of this custom data type definition.", "$ref": "#/components/schemas/workflow.BaseDataType", "x-omitempty": true }, "nullable": true }, "Catalog": { "$ref": "#/components/schemas/workflow.Catalog.Relationship", "description": "A reference to a workflowCatalog resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true }, "ClonedFrom": { "$ref": "#/components/schemas/workflow.CustomDataTypeDefinition.Relationship", "description": "A reference to a workflowCustomDataTypeDefinition resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "workflow.CustomDataTypeDefinition.List": { "title": "List of 'workflow.CustomDataTypeDefinition' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'workflow.CustomDataTypeDefinition' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'workflow.CustomDataTypeDefinition' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/workflow.CustomDataTypeDefinition" }, "nullable": true } } } ] }, "workflow.CustomDataTypeProperties": { "title": "Workflow:Custom Data Type Properties", "description": "Properties for a custom data type definition.", "x-allOf-name": "workflow.CustomDataTypeProperties", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'workflow.CustomDataTypeProperties', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "workflow.CustomDataTypeProperties" ], "default": "workflow.CustomDataTypeProperties", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "workflow.CustomDataTypeProperties" ], "default": "workflow.CustomDataTypeProperties", "x-enum-as-string": true }, "Cloneable": { "description": "When set to false custom data type is not cloneable. It is set to true only if data type is not internal and it is not using any internal custom data type.", "type": "boolean", "default": true, "readOnly": true, "x-omitempty": true }, "ExternalMeta": { "description": "When set to false the custom data type is owned by the system and used for internal services. Such custom data type cannot be directly used by external entities.", "type": "boolean", "default": false, "readOnly": true, "x-omitempty": true }, "SupportStatus": { "description": "Supported status of the definition.\n* `Supported` - The definition is a supported version and there will be no changes to the mandatory inputs or outputs.\n* `Beta` - The definition is a Beta version and this version can under go changes until the version is marked supported.\n* `Deprecated` - The version of definition is deprecated and typically there will be a higher version of the same definition that has been added.", "type": "string", "enum": [ "Supported", "Beta", "Deprecated" ], "default": "Supported", "x-omitempty": true } } } ] }, "workflow.DataSourceSelector": { "title": "Workflow:Data Source Selector", "description": "An alternative selector to MoReferenceProperty that serves as a data source for PrimitiveDataTypes. It supports selecting data from workflow execution sources, including workflow inputs and outputs from previous tasks.", "x-allOf-name": "workflow.DataSourceSelector", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'workflow.DataSourceSelector', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "workflow.DataSourceSelector" ], "default": "workflow.DataSourceSelector", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "workflow.DataSourceSelector" ], "default": "workflow.DataSourceSelector", "x-enum-as-string": true }, "DisplayAttributes": { "type": "array", "items": { "description": "List of properties from the mapped parameter.", "type": "string", "x-omitempty": true }, "minItems": 1, "nullable": true }, "Selector": { "description": "This field holds mapping information used to provide suggestions to the user. The mapping should be in the '${workflow.input.property}' format. It supports workflow input mapping for workflows, and for User Actions, it supports workflow inputs, workflow outputs, workflow variables, and outputs from previous tasks.", "type": "string", "x-omitempty": true }, "ValueAttribute": { "description": "A property from the mapped parameter, value of which can be used as value for referenced input definition.", "type": "string", "x-omitempty": true } } } ] }, "workflow.DecisionCase": { "title": "Workflow:Decision Case", "description": "A Decision Case is a condition for a Decision Task. It is the equivalent of case statement in the programming language paradigm of switch and case.", "x-allOf-name": "workflow.DecisionCase", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'workflow.DecisionCase', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "workflow.DecisionCase" ], "default": "workflow.DecisionCase", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "workflow.DecisionCase" ], "default": "workflow.DecisionCase", "x-enum-as-string": true }, "Description": { "description": "Description of this decision case.", "type": "string", "x-omitempty": true }, "NextTask": { "description": "The name of the next task (Task names unique within workflow) to run. In a graph model, denotes an edge to another Task Node.", "type": "string", "x-omitempty": true }, "Value": { "description": "Value for the decision case.", "type": "string", "x-omitempty": true } } } ] }, "workflow.DecisionTask": { "title": "Workflow:Decision Task", "description": "A DecisionTask is a control task that executes a sequence of WorkflowTasks based off decision provided and evaluated by this task.", "x-allOf-name": "workflow.DecisionTask", "allOf": [ { "$ref": "#/components/schemas/workflow.ControlTask" }, { "type": "object", "description": "Definition of the list of properties defined in 'workflow.DecisionTask', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "workflow.DecisionTask" ], "default": "workflow.DecisionTask", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "workflow.DecisionTask" ], "default": "workflow.DecisionTask", "x-enum-as-string": true }, "Condition": { "description": "The condition to evaluate for this decision task. The condition can be a workflow or task variable or an JavaScript expression. Example value for condition could be a variable like \"${task1.output.var1} or ${workflow.input.var2}\" which evaluates to a value matching any of the decision case values. Example value for condition if it's an expression - \"if ( ${task1.output.var1} ! = null && ${task1.output.var1} > 0 ) 'true'; else 'false'; \" which evaluates to 'true' or 'false' and will match one of the decision case values. You can also use JavaScript functions like indexOf, toUpperCase in the expression which will be evaluated by the expression evaluator.", "type": "string", "x-omitempty": true }, "DecisionCases": { "type": "array", "items": { "description": "A list of potential decision task flows based off a condition.", "$ref": "#/components/schemas/workflow.DecisionCase", "x-omitempty": true }, "nullable": true }, "DefaultTask": { "description": "The default next Task to execute if the decision cannot be evaluated to any of the DecisionCases.", "type": "string", "x-omitempty": true }, "InputParameters": { "description": "This field is deprecated. Decision case conditions can be added using the workflow input or task output variables in the Condition field. Refer to Condition field for more details.", "deprecated": true, "x-sunset": "2027-03-01", "x-omitempty": true } } } ] }, "workflow.DefaultValue": { "title": "Workflow:Default Value", "description": "Captures default vales for a data type.", "x-allOf-name": "workflow.DefaultValue", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'workflow.DefaultValue', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "workflow.DefaultValue" ], "default": "workflow.DefaultValue", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "workflow.DefaultValue" ], "default": "workflow.DefaultValue", "x-enum-as-string": true }, "IsValueSet": { "description": "A flag that indicates whether a default value is given or not. This flag will be useful in case of the secure parameter where the value will be filtered out in API responses.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "Override": { "description": "Override the default value provided for the data type. When true, allow the user to enter value for the data type.", "type": "boolean", "x-omitempty": true }, "Value": { "description": "Default value for the data type. If default value was provided and the input was required the default value will be used as the input.", "nullable": true, "x-omitempty": true } } } ] }, "workflow.DisplayMeta": { "title": "Workflow:Display Meta", "description": "Captures the meta data needed for displaying workflow data types in Intersight User Interface.", "x-allOf-name": "workflow.DisplayMeta", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'workflow.DisplayMeta', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "workflow.DisplayMeta" ], "default": "workflow.DisplayMeta", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "workflow.DisplayMeta" ], "default": "workflow.DisplayMeta", "x-enum-as-string": true }, "InventorySelector": { "description": "Inventory selector specified for primitive data property should be used in Intersight User Interface.", "type": "boolean", "default": true, "x-omitempty": true }, "WidgetType": { "description": "Specify the widget type for data display.\n* `None` - Display none of the widget types.\n* `Radio` - Display the widget as a radio button.\n* `Dropdown` - Display the widget as a dropdown.\n* `GridSelector` - Display the widget as a selector.\n* `DrawerSelector` - Display the widget as a selector.\n* `MultiSelect` - Display the widget as a multi-select.\n* `Switcher` - Display the widget as a switcher.", "type": "string", "enum": [ "None", "Radio", "Dropdown", "GridSelector", "DrawerSelector", "MultiSelect", "Switcher" ], "default": "None", "x-omitempty": true } } } ] }, "workflow.DynamicTemplateParserDataType": { "title": "Workflow:Dynamic Template Parser Data Type", "description": "Data type to fetch a generic template from given selector and parse it using an api to give an array of secure and non-secure keys for form generation. URL used to fetch the template object is based on the templateType. Final input passed to the workflow using this data type is a JSON containing {'Template':'