The identity and technical contract details declared by the specification.
hcl.Product
Model giving the details of product.
hcl.DriverImage.Response
The response body of a HTTP GET request for the 'hcl.DriverImage' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL…
pkix.KeyGenerationSpec
The key generation spec provides the algorithm and the parameters required for this algorithm to generate a key.
policy.AbstractPolicy.Relationship
A relationship to the 'policy.AbstractPolicy' resource, or the expanded 'policy.AbstractPolicy' resource, or the 'null' value.
iam.System.Relationship
A relationship to the 'iam.System' resource, or the expanded 'iam.System' resource, or the 'null' value.
mo.BaseMo.Relationship
A relationship to the 'mo.BaseMo' resource, or the expanded 'mo.BaseMo' resource, or the 'null' value.
iam.ResourceRoles.Relationship
A relationship to the 'iam.ResourceRoles' resource, or the expanded 'iam.ResourceRoles' resource, or the 'null' value.
iam.SwitchAccountPermission
SwitchScope parameters related to the Account to/from which user switched.
iam.EndPointPrivilege
EndPointPrivilege models privileges defined on managed endpoints (e.g., UCS, IMC), enabling cross-launch or delegated actions. Purpose It exposes endpoint-side…
iam.LdapPolicy
Overview The LDAP Policy object is a reusable policy for configuring Lightweight Directory Access Protocol (LDAP) settings, enabling remote user authentication…
iam.ApiKey.Relationship
A relationship to the 'iam.ApiKey' resource, or the expanded 'iam.ApiKey' resource, or the 'null' value.
iam.IpAccessManagement.Relationship
A relationship to the 'iam.IpAccessManagement' resource, or the expanded 'iam.IpAccessManagement' resource, or the 'null' value.
policy.ReportedPolicyChange
A policy change that has been reported to a profile.
hcl.ServerConfiguration
Changes to the server configuration that occurred during the most recent incremental import of HCL data.
Error
object
4 properties
2 required
iam.DefaultPermissionInfo
Contains information about a stored default permission and its shared login interface coverage for product-facing default role selection.
iam.UserSetting.Relationship
A relationship to the 'iam.UserSetting' resource, or the expanded 'iam.UserSetting' resource, or the 'null' value.
policy.AbstractConfigProfile.Relationship
A relationship to the 'policy.AbstractConfigProfile' resource, or the expanded 'policy.AbstractConfigProfile' resource, or the 'null' value.
iam.AppCredentials
Contains credentials information for a particular client application.
resource.Selector
Complex type representing the filter condition to extract the resources.
hcl.DriverImage.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
policy.ActionParam
An action parameter setting as a key/value pair.
iam.UserPreference
UserPreference captures user interface preferences—such as layout, view state, or theme—persisted per user and identity context. Purpose It enables consistent,…
iam.ResourcePermission
ResourcePermission represents the permissions defined on a resource like organization.
iam.LdapMeta
LdapMeta stores metadata for internal LDAP connectors created to support an appliance LDAP cluster configuration. Purpose It provides system-managed insight in…
mo.VersionContext
VersionContext contains the versioning info for an object.
hcl.HyperflexSoftwareCompatibilityInfo.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
iam.SessionLimits.Relationship
A relationship to the 'iam.SessionLimits' resource, or the expanded 'iam.SessionLimits' resource, or the 'null' value.
iam.Privilege.Relationship
A relationship to the 'iam.Privilege' resource, or the expanded 'iam.Privilege' resource, or the 'null' value.
iam.ClientMeta
Contains meta information of the client. Currently it is used only within OAuth clients.
hcl.OperatingSystem.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
policy.AbstractProfile.Relationship
A relationship to the 'policy.AbstractProfile' resource, or the expanded 'policy.AbstractProfile' resource, or the 'null' value.
iam.UserGroup
UserGroup provides a policy mechanism to assign permissions to cohorts of users based on identity attributes or explicit guest inclusion. Purpose UserGroup sim…
iam.IpAccessManagement
IpAccessManagement governs IP-based access restrictions for an account, enabling administrators to allowlist trusted ranges and recover from misconfiguration.…
hcl.HwCatalogInfo.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
iam.UserPreference.Relationship
A relationship to the 'iam.UserPreference' resource, or the expanded 'iam.UserPreference' resource, or the 'null' value.
iam.Permission
Permission provides a way to assign roles to a user or user group to perform operations on object hierarchy.
iam.Idp.Relationship
A relationship to the 'iam.Idp' resource, or the expanded 'iam.Idp' resource, or the 'null' value.
hcl.ExemptedCatalog.Response
The response body of a HTTP GET request for the 'hcl.ExemptedCatalog' resource. The value may be one of the following types. 1. When 'tag' is specified in the…
policy.ConfigChangeDetailType
Defines the details of a configuration change including change type, disruption and description of the change.
iam.Role
A role is a collection of privilege sets that are assigned to a user using a permission object.
organization.Organization.Relationship
A relationship to the 'organization.Organization' resource, or the expanded 'organization.Organization' resource, or the 'null' value.
hcl.Firmware
Model which holds the details of firmware version and driver version.
iam.IpAddress
IpAddress represents a single allowlisted IP, CIDR block, or range used by IpAccessManagement. Purpose It models an individual entry in the IP access policy to…
mo.BaseComplexType
object
BaseComplexType is a base abstract class for all complex types. All complex types inherit from this base type.
2 properties
3 required
hcl.ServerCatalog.Response
The response body of a HTTP GET request for the 'hcl.ServerCatalog' resource. The value may be one of the following types. 1. When 'tag' is specified in the UR…
iam.Account
The Account object defines the organizational framework within which users and resources are managed, serving as the central hub for access and permissions. Pu…
hcl.ServerCatalog
Collection used to store the server catalog information. This contails details about all the supported cpu models for the selected Server model.
hcl.ServerHwCatalogInfo.Response
The response body of a HTTP GET request for the 'hcl.ServerHwCatalogInfo' resource. The value may be one of the following types. 1. When 'tag' is specified in…
iam.PrivilegeSet
A collection of privileges.
CsvFile
string
The content is a comma-separated list of values.
resource.Group.Relationship
A relationship to the 'resource.Group' resource, or the expanded 'resource.Group' resource, or the 'null' value.
session.AbstractSession
A base abstract class for all sessions.
iam.Permission.Relationship
A relationship to the 'iam.Permission' resource, or the expanded 'iam.Permission' resource, or the 'null' value.
iam.AbstractQualifier.Relationship
A relationship to the 'iam.AbstractQualifier' resource, or the expanded 'iam.AbstractQualifier' resource, or the 'null' value.
iam.SecurityHolder.Relationship
A relationship to the 'iam.SecurityHolder' resource, or the expanded 'iam.SecurityHolder' resource, or the 'null' value.
policy.ActionQualifier
Action qualifiers can be used to control actions that are performed on a profile object. For example - perform a 'Deploy' action only for specific policies.
hcl.ExemptedCatalog
Collection used to store exempted products (ie. adapters, storage controllers, etc). These products should be ignored for HCL validation purposes.
hcl.OperatingSystem.Response
The response body of a HTTP GET request for the 'hcl.OperatingSystem' resource. The value may be one of the following types. 1. When 'tag' is specified in the…
iam.Idp
The SAML identity provider such as Cisco, that has been used to log in to Intersight.
iam.OAuthToken
The meta data for generating OAuth2 token of a user. It is created when user logged in via OAuth2 using Authorization Code grant and deleted upon logout, expir…
iam.AbstractClientApplication.Relationship
A relationship to the 'iam.AbstractClientApplication' resource, or the expanded 'iam.AbstractClientApplication' resource, or the 'null' value.
iam.ResourceRoles
ResourceRoles maps roles to a specific resource (e.g., an organization) within a permission, shaping the effective access model. Purpose It provides fine-grain…
iam.DomainGroup.Relationship
A relationship to the 'iam.DomainGroup' resource, or the expanded 'iam.DomainGroup' resource, or the 'null' value.
hcl.OperatingSystemVendor.Response
The response body of a HTTP GET request for the 'hcl.OperatingSystemVendor' resource. The value may be one of the following types. 1. When 'tag' is specified i…
mo.DocumentCount
A document returned in a response body when the HTTP GET request specifies the '$count' query parameter.
iam.LocalUserPassword.Relationship
A relationship to the 'iam.LocalUserPassword' resource, or the expanded 'iam.LocalUserPassword' resource, or the 'null' value.
policy.AbstractPolicy
A base abstract class for all configuration policies that can be applied to service profiles.
hcl.DriverImage
Collection used to store the driver ISO urls for each server based on how it is managed.
mo.TagKeySummary
object
A summary of the Tag usage for an API resource. Tags are Key, Value pairs that can be assigned to API resources.
3 properties
policy.AbstractConfigurationObject
Abstract base type for all configuration objects. All logical objects like profiles, policies, policy items like vnic, vhba and templates extend from this type…
iam.SwitchScopePermissions
SwitchScope parameters related to the Account to which user switched to.
iam.ResourceLimits
ResourceLimits establishes account-level limits and policies for identity-related resources and credentials. Purpose It ensures controlled growth and predictab…
iam.ServiceProvider
ServiceProvider encapsulates the platforms SAML Service Provider (SP) identity and metadata, used to integrate with external IdPs. Purpose It provides SP metad…
iam.AbstractQualifier
Placeholder for different types of qualifiers.
iam.PermissionToRoles
Complex type representing a permission and its associated roles.
iam.SessionLimits
The session related configuration limits.
iam.LdapDnsParameters
DNS settings used to access LDAP Providers.
iam.IdpReference
The IdpReference object represents the system-provided Cisco IdP association within an account, acting as the default reference for user and group assignments.…
iam.LdapGroup
The LDAP Group object creates a mapping between a group in a remote LDAP directory and a set of local roles on an endpoint. Purpose The purpose is to grant per…
mo.AggregateTransform
The output of a request that includes the $apply query parameter. The schema of an aggregation query is dynamically determined based on the request query param…
iam.DomainGroup
Intersight services are mapped to three different categories of services for scaling purpose. Three categories are defined: Partition1/Partition2/Partition3. T…
iam.UserGroup.Relationship
A relationship to the 'iam.UserGroup' resource, or the expanded 'iam.UserGroup' resource, or the 'null' value.
iam.AppRegistration.Relationship
A relationship to the 'iam.AppRegistration' resource, or the expanded 'iam.AppRegistration' resource, or the 'null' value.
iam.Session.Relationship
A relationship to the 'iam.Session' resource, or the expanded 'iam.Session' resource, or the 'null' value.
iam.ApiKey
The ApiKey object is a critical component for secure authentication and authorization within the system. It allows clients to make API requests programmaticall…
organization.Organization
Organization provides multi-tenancy within an account. Multiple organizations can be present under an account. Resources are associated to organization using r…
hcl.HardwareCompatibilityProfile
Profile giving server hardware details, OS details and UCS Version details.
iam.SecurityHolder
SecurityHolder aggregates account-wide and organization-scoped permissions, serving as the nexus for effective authorization state across the accounts resource…
hcl.ExemptedCatalog.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
iam.ResourcePermission.Relationship
A relationship to the 'iam.ResourcePermission' resource, or the expanded 'iam.ResourcePermission' resource, or the 'null' value.
policy.PolicyContextHolder
To store the policy details along with the context for which the entry is established.
iam.Session
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,…
iam.EndPointRole
EndPointRole represents roles defined on managed endpoints that encapsulate one or more endpoint privileges. Purpose It allows administrators to assign endpoin…
iam.AbstractClientApplication
Describes an internal application registered against an endpoint in Intersight. The application receives requests specific to its use case and these requests r…
iam.User.Relationship
A relationship to the 'iam.User' resource, or the expanded 'iam.User' resource, or the 'null' value.
iam.UserSetting
UserSetting stores specific UI-related settings that are not part of general preferences, such as session recording opt-in status. Purpose It allows storing di…
policy.AbstractProfile
Abstract base type for all profiles.
hcl.SupportedDriverName
The SupportedDriverName object facilitates the identification and management of driver names supported for specific products and operating systems. It plays a…
hcl.ServerHwCatalogInfo
Server hardware catalog information for a particular server model, used for server BOM validation.
DisplayNames
objectnull
A set of display names for the MO resource. These names are calculated based on other properties of the MO and potentially properties of Ancestor MOs. Displayn…
iam.LdapMeta.Relationship
A relationship to the 'iam.LdapMeta' resource, or the expanded 'iam.LdapMeta' resource, or the 'null' value.
hcl.ServerCatalog.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
iam.Role.Relationship
A relationship to the 'iam.Role' resource, or the expanded 'iam.Role' resource, or the 'null' value.
iam.User
The User object represents individual users within the system, encompassing their identity, permissions, and roles. Purpose A User is a central entity within t…
iam.AccountTags
An arbitrary key and value pair that can be used to tag REST resources and organize managed objects by assigning meta-data tags to any object.
iam.PrivilegeSet.Relationship
A relationship to the 'iam.PrivilegeSet' resource, or the expanded 'iam.PrivilegeSet' resource, or the 'null' value.
iam.ServiceProvider.Relationship
A relationship to the 'iam.ServiceProvider' resource, or the expanded 'iam.ServiceProvider' resource, or the 'null' value.
iam.LdapProvider
Overview The LDAP Provider object represents a single LDAP server that an endpoint will use for authentication. It is a component of an LdapPolicy. Purpose The…
iam.TestIdpConfiguration
TestIdpConfiguration supports validating an IdP setup by performing a controlled authentication, currently supported only for testing LDAP configurations. test…
hcl.OperatingSystemVendor
Collection used to store operating system vendors details.
resource.Group
The Group object represents a collection of REST resources within the system, designed to streamline resource management through organized groupings. Purpose A…
iam.AppRegistration
The AppRegistration object facilitates the registration of OAuth2 client applications, enabling secure access to APIs using OAuth2 credentials. Purpose An AppR…
iam.LdapProvider.Relationship
A relationship to the 'iam.LdapProvider' resource, or the expanded 'iam.LdapProvider' resource, or the 'null' value.
iam.LdapPolicy.Relationship
A relationship to the 'iam.LdapPolicy' resource, or the expanded 'iam.LdapPolicy' resource, or the 'null' value.
iam.System
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…
iam.IpAddress.Relationship
A relationship to the 'iam.IpAddress' resource, or the expanded 'iam.IpAddress' resource, or the 'null' value.
hcl.ServerHwCatalogInfo.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
policy.ConfigContext
Configuration related state and results.
hcl.DataImportLog.Response
The response body of a HTTP GET request for the 'hcl.DataImportLog' resource. The value may be one of the following types. 1. When 'tag' is specified in the UR…
mo.Tag
object
An arbitrary key and value pair that can be used to tag REST resources and organize managed objects by assigning meta-data tags to any object.
7 properties
iam.IdpReference.Relationship
A relationship to the 'iam.IdpReference' resource, or the expanded 'iam.IdpReference' resource, or the 'null' value.
hcl.HwCatalogInfo.Response
The response body of a HTTP GET request for the 'hcl.HwCatalogInfo' resource. The value may be one of the following types. 1. When 'tag' is specified in the UR…
hcl.HyperflexSoftwareCompatibilityInfo
Lists software compatibility information between different HperFlex component versions like HyperFlex Data Platform, Hypervisor, Drive Firmware, etc.
iam.Account.Relationship
A relationship to the 'iam.Account' resource, or the expanded 'iam.Account' resource, or the 'null' value.
iam.EndPointPrivilege.Relationship
A relationship to the 'iam.EndPointPrivilege' resource, or the expanded 'iam.EndPointPrivilege' resource, or the 'null' value.
iam.ResourceLimits.Relationship
A relationship to the 'iam.ResourceLimits' resource, or the expanded 'iam.ResourceLimits' resource, or the 'null' value.
hcl.ServerHwCatalogInfo.Relationship
A relationship to the 'hcl.ServerHwCatalogInfo' resource, or the expanded 'hcl.ServerHwCatalogInfo' resource, or the 'null' value.
iam.Privilege
Privilege represents an action which can be performed in Intersight such as creating server profile, deleting a user etc.
hcl.CompatibilityStatus
The CompatibilityStatus object evaluates the compatibility of hardware and software configurations within the system. This provides insights into the compatibi…
iam.LocalUserPassword
LocalUserPassword provides the mechanism for a local user to change their own password within the platform appliance context. This model is applicable only to…
iam.TestIdpConfiguration.Relationship
A relationship to the 'iam.TestIdpConfiguration' resource, or the expanded 'iam.TestIdpConfiguration' resource, or the 'null' value.
hcl.DataImportLog.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
hcl.DataImportLog
The DataImportLog object serves as a record-keeping tool for tracking the data import processes from the HCL tool. This provides transparency and accountabilit…
iam.LdapGroup.Relationship
A relationship to the 'iam.LdapGroup' resource, or the expanded 'iam.LdapGroup' resource, or the 'null' value.
iam.LdapBaseProperties
Base settings of LDAP required while configuring LDAP policy.
hcl.OperatingSystemVendor.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
mo.BaseMo
object
The base abstract class for all Cisco Intersight managed objects.
15 properties
3 required
hcl.OperatingSystem
Collection used to store operating system details.
policy.ScheduledAction
Scheduled Action enables the queuing of multiple profile actions to be executed sequentially. Each action in the sequence is executed only after the successful…
hcl.OperatingSystemVendor.Relationship
A relationship to the 'hcl.OperatingSystemVendor' resource, or the expanded 'hcl.OperatingSystemVendor' resource, or the 'null' value.
hcl.HwCatalogInfo
Hardware catalog information for HyperFlex Data Platform, required for BOM validation.
policy.ConfigResultContext
The context for a validation/config result such as the related entity's name, type, MOID etc.
policy.AbstractConfigProfile
AbstractConfigProfile is an abstract base type for all config actions on a profile.
iam.OAuthToken.Relationship
A relationship to the 'iam.OAuthToken' resource, or the expanded 'iam.OAuthToken' resource, or the 'null' value.
iam.AccountPermissions
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 iden…
resource.PerTypeCombinedSelector
Complex type representing an object type to associated filter by combining all selectors.
hcl.HyperflexSoftwareCompatibilityInfo.Response
The response body of a HTTP GET request for the 'hcl.HyperflexSoftwareCompatibilityInfo' resource. The value may be one of the following types. 1. When 'tag' i…
mo.MoRef
object
A reference to a REST resource, uniquely identified by object type and Moid.
5 properties
3 required
mo.TagSummary
A document returned in a response body when the HTTP GET request specifies the 'tag' query parameter.
iam.PermissionReference
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 iden…
hcl.Constraint
A key value pair, determining a compatibility constraint for the matching version combinations.
iam.EndPointRole.Relationship
A relationship to the 'iam.EndPointRole' resource, or the expanded 'iam.EndPointRole' resource, or the 'null' value.
ExcelFile
string
The content is an Excel spreadsheet.
mo.BaseResponse
object
The base response schema.
1 property
1 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Cisco Intersight publishes across the network.