The identity and technical contract details declared by the specification.
pkix.KeyGenerationSpec
The key generation spec provides the algorithm and the parameters required for this algorithm to generate a key.
x509.Certificate
The representation of an X.509 certificate.
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.
asset.GeoLocation.Response
The response body of a HTTP GET request for the 'asset.GeoLocation' resource. The value may be one of the following types. 1. When 'tag' is specified in the UR…
asset.DeploymentAlarmInfo
Persists the different alarm type flags.
asset.GeoLocation.Relationship
A relationship to the 'asset.GeoLocation' resource, or the expanded 'asset.GeoLocation' resource, or the 'null' value.
iam.SwitchAccountPermission
SwitchScope parameters related to the Account to/from which user switched.
asset.DeviceContractInformation.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
iam.EndPointPrivilege
EndPointPrivilege models privileges defined on managed endpoints (e.g., UCS, IMC), enabling cross-launch or delegated actions. Purpose It exposes endpoint-side…
asset.DeviceTransaction
Type for saving the device transaction history. It is used in asset.DeploymentDeviceInformation object to save the device transactions.
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.
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.TrustPoint.Relationship
A relationship to the 'iam.TrustPoint' resource, or the expanded 'iam.TrustPoint' resource, or the 'null' value.
asset.Target.Response
The response body of a HTTP GET request for the 'asset.Target' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL que…
asset.AlarmSummary
The summary of alarm counts based on alarm serverity.
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.
asset.Subscription.Response
The response body of a HTTP GET request for the 'asset.Subscription' resource. The value may be one of the following types. 1. When 'tag' is specified in the U…
asset.SubscriptionAccount.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,…
asset.PreClaim
The PreClaim object is a specialized component of the device management system designed to facilitate the completion of the claim process for pre-provisioned a…
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.
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.
asset.ServiceOptions
ServiceOptions captures configuration that is specific to a target type for a specific service.
asset.DeviceConnectorManager.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
iam.IpAccessManagement
IpAccessManagement governs IP-based access restrictions for an account, enabling administrators to allowlist trusted ranges and recover from misconfiguration.…
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…
asset.Credential
A credential which can be used to authenticate with a managed target.
asset.AddressInformation
Type for saving the address information. It is used in asset.DeviceContractInformation object to save customer address.
pkix.DistinguishedName
The identifier for the owner of an X.509 certificate and the authority that issued the certificate.
iam.UserPreference.Relationship
A relationship to the 'iam.UserPreference' resource, or the expanded 'iam.UserPreference' resource, or the 'null' value.
asset.SubscriptionDeviceContractInformation.Response
The response body of a HTTP GET request for the 'asset.SubscriptionDeviceContractInformation' resource. The value may be one of the following types. 1. When 't…
asset.DeviceRegistration.Response
The response body of a HTTP GET request for the 'asset.DeviceRegistration' resource. The value may be one of the following types. 1. When 'tag' is specified in…
iam.Permission
Permission provides a way to assign roles to a user or user group to perform operations on object hierarchy.
resource.Reservation
The Reservation object is responsible for reserving slots for new resources within resource groups, ensuring organized and planned resource allocation. Purpose…
iam.TrustPoint
The TrustPoint object represents a trusted source of certificates within the system, enabling secure communication and authentication. Purpose A TrustPoint ser…
asset.GeoLocation
The geographic location of a managed target.
iam.Idp.Relationship
A relationship to the 'iam.Idp' resource, or the expanded 'iam.Idp' resource, or the 'null' value.
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.
asset.SudiInfo
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 pub…
asset.DeviceConnection
An abstract class that holds the details of a device connectors connection to Intersight.
asset.DeviceStatistics
Type for saving device statistics related information for HyperFlex and UCS devices. It is used in asset.DeploymentDevice object to save the current device sta…
organization.Organization.Relationship
A relationship to the 'organization.Organization' resource, or the expanded 'organization.Organization' resource, or the 'null' value.
asset.SubscriptionDeviceContractInformation
The SubscriptionDeviceContractInformation object is a crucial component of asset management within the Cisco ecosystem, designed to encapsulate information reg…
asset.DeviceConnectorManager
The DeviceConnectorManager object is a central component in managing registered Intersight Assist Appliance Devices within the Intersight ecosystem. This provi…
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…
asset.ClaimToken.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
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
asset.DeviceConfiguration.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
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…
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.
asset.ClaimToken
The ClaimToken object serves as a secure mechanism for onboarding and registering devices to an Intersight user account. It facilitates a streamlined connectio…
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.
asset.DeploymentDevice
The DeploymentDevice object is pivotal in managing device information within consumption-based subscriptions. This provides a detailed view of device installat…
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.Idp
The SAML identity provider such as Cisco, that has been used to log in to Intersight.
iam.AbstractClientApplication.Relationship
A relationship to the 'iam.AbstractClientApplication' resource, or the expanded 'iam.AbstractClientApplication' resource, or the 'null' value.
asset.DeviceClaim
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 pe…
resource.Reservation.Relationship
A relationship to the 'resource.Reservation' resource, or the expanded 'resource.Reservation' 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.
asset.SubscriptionAccount.Response
The response body of a HTTP GET request for the 'asset.SubscriptionAccount' 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.
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
asset.DeploymentDevice.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
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…
resource.AbstractReservation
You can reserve resources for use cases related to Pools or Groups. For example, resources that are decommissioned or reserved for future allocation are mainta…
asset.DeviceRegistration
The DeviceRegistration object represents a device connector-enabled endpoint that has registered with Intersight. It is a concrete object central to the manage…
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…
asset.Subscription
The Subscription object is central to managing consumption-based subscriptions within the Cisco technology ecosystem. It encapsulates details about the subscri…
asset.Deployment.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
asset.DeviceRegistration.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
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.
asset.DeploymentDeviceAlarmInfo
Persists the different alarm type flags.
asset.Deployment.Response
The response body of a HTTP GET request for the 'asset.Deployment' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL…
asset.Subscription.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
asset.CustomerInformation
Type for saving contract information.
iam.SessionLimits
The session related configuration limits.
asset.DeviceContractInformation.Relationship
A relationship to the 'asset.DeviceContractInformation' resource, or the expanded 'asset.DeviceContractInformation' resource, or the 'null' value.
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.…
asset.ProductInformation
Type for saving the product information.
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…
asset.SubscriptionAccount
The SubscriptionAccount object is a foundational element within the subscription management framework, acting as a placeholder for the account collection. Its…
asset.DeploymentDevice.Relationship
A relationship to the 'asset.DeploymentDevice' resource, or the expanded 'asset.DeploymentDevice' resource, or the 'null' value.
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.
PatchDocument
object
A JSONPatch document as defined by RFC 6902. A JSONPatch document can be used in a request body when the 'Content-Type' HTTP header is set to 'application/json…
4 properties
2 required
iam.Session.Relationship
A relationship to the 'iam.Session' resource, or the expanded 'iam.Session' resource, or the 'null' value.
asset.DeviceContractInformation.Response
The response body of a HTTP GET request for the 'asset.DeviceContractInformation' resource. The value may be one of the following types. 1. When 'tag' is speci…
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…
asset.DeviceClaim.Relationship
A relationship to the 'asset.DeviceClaim' resource, or the expanded 'asset.DeviceClaim' resource, or the 'null' value.
asset.Deployment.Relationship
A relationship to the 'asset.Deployment' resource, or the expanded 'asset.Deployment' resource, or the 'null' value.
iam.SecurityHolder
SecurityHolder aggregates account-wide and organization-scoped permissions, serving as the nexus for effective authorization state across the accounts resource…
asset.Target.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.
asset.DeviceConfiguration
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 ex…
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…
asset.SubscriptionDeviceContractInformation.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
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…
asset.DeploymentDeviceInformation
Type for saving the device information reported by Cisco Install Base. It is used in asset.DeploymentDevice object to save the device information.
policy.AbstractProfile
Abstract base type for all profiles.
asset.ClusterMember.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
asset.DeviceConfiguration.Relationship
A relationship to the 'asset.DeviceConfiguration' resource, or the expanded 'asset.DeviceConfiguration' resource, or the 'null' value.
asset.DeviceInformation
Type for saving the device information reported by Cisco Install Base. It is used in asset.SubscriptionDeviceInformation object to save the device information.
asset.Connection
A method for Intersight to connect to a managed target, including network connectivity and authentication details.
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.
asset.DeviceContractInformation
The DeviceContractInformation object provides a comprehensive structure for managing contract-related information of Cisco devices identified by unique identif…
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.
asset.DeviceRegistration.Relationship
A relationship to the 'asset.DeviceRegistration' resource, or the expanded 'asset.DeviceRegistration' 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…
iam.ServiceProvider.Relationship
A relationship to the 'iam.ServiceProvider' resource, or the expanded 'iam.ServiceProvider' resource, or the 'null' value.
asset.ClusterMember
The ClusterMember object represents a node within a cluster of device connectors. This provides detailed insights into the individual members of a device clust…
asset.ContractInformation
Type for saving contract information.
resource.Group
The Group object represents a collection of REST resources within the system, designed to streamline resource management through organized groupings. Purpose A…
asset.ClaimToken.Response
The response body of a HTTP GET request for the 'asset.ClaimToken' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL…
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.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.LdapPolicy.Relationship
A relationship to the 'iam.LdapPolicy' resource, or the expanded 'iam.LdapPolicy' resource, or the 'null' value.
asset.MeteringType
Type for saving Metering details.
iam.IpAddress.Relationship
A relationship to the 'iam.IpAddress' resource, or the expanded 'iam.IpAddress' resource, or the 'null' value.
policy.ConfigContext
Configuration related state and results.
asset.DeploymentDevice.Response
The response body of a HTTP GET request for the 'asset.DeploymentDevice' resource. The value may be one of the following types. 1. When 'tag' is specified in t…
asset.Subscription.Relationship
A relationship to the 'asset.Subscription' resource, or the expanded 'asset.Subscription' resource, or the 'null' value.
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
asset.GlobalUltimate
Type for customer information of the BillToGlobal.
asset.GeoLocation.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
iam.IdpReference.Relationship
A relationship to the 'iam.IdpReference' resource, or the expanded 'iam.IdpReference' resource, or the 'null' value.
iam.Account.Relationship
A relationship to the 'iam.Account' resource, or the expanded 'iam.Account' resource, or the 'null' value.
asset.VmHost
Type for saving VM host details.
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.
iam.Privilege
Privilege represents an action which can be performed in Intersight such as creating server profile, deleting a user etc.
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.
asset.DeviceConfiguration.Response
The response body of a HTTP GET request for the 'asset.DeviceConfiguration' resource. The value may be one of the following types. 1. When 'tag' is specified i…
asset.ClaimSignature
A cryptographic signature that can be used to auto-claim a device connector into a user's account.
asset.DeviceContractNotification
The DeviceContractNotification object facilitates communication between appliances and cloud systems, supporting contract status computations. It acts as an in…
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.
mo.BaseMo
object
The base abstract class for all Cisco Intersight managed objects.
15 properties
3 required
asset.DeviceConnectorManager.Response
The response body of a HTTP GET request for the 'asset.DeviceConnectorManager' resource. The value may be one of the following types. 1. When 'tag' is specifie…
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…
asset.Deployment
The Deployment object is an essential element of the Cisco consumption-based subscription ecosystem, providing detailed information about deployments associate…
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.
asset.ClusterMember.Response
The response body of a HTTP GET request for the 'asset.ClusterMember' resource. The value may be one of the following types. 1. When 'tag' is specified in the…
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.
mo.MoRef
object
A reference to a REST resource, uniquely identified by object type and Moid.
5 properties
3 required
asset.Service
A service that is enabled on a managed target. For example, Intersight Orchestration or Intersight Workload Optimizer.
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…
mo.TagSummary
A document returned in a response body when the HTTP GET request specifies the 'tag' query parameter.
asset.ClusterMember.Relationship
A relationship to the 'asset.ClusterMember' resource, or the expanded 'asset.ClusterMember' resource, or the 'null' value.
iam.EndPointRole.Relationship
A relationship to the 'iam.EndPointRole' resource, or the expanded 'iam.EndPointRole' resource, or the 'null' value.
asset.ConnectionFlapStatus
Encapsulates key details used to identify devices experiencing connection flapping.
asset.SubscriptionAccount.Relationship
A relationship to the 'asset.SubscriptionAccount' resource, or the expanded 'asset.SubscriptionAccount' resource, or the 'null' value.
ExcelFile
string
The content is an Excel spreadsheet.
mo.BaseResponse
object
The base response schema.
1 property
1 required
asset.Target.Relationship
A relationship to the 'asset.Target' resource, or the expanded 'asset.Target' resource, or the 'null' value.
asset.Target
The Target object represents an entity managed by Intersight. It encompasses both physical and software entities, such as UCS servers or cloud accounts, and se…
iam.System.Relationship_2
A relationship to the 'iam.System' resource, or the expanded 'iam.System' resource, or the 'null' value.
iam.ResourceRoles.Relationship_2
A relationship to the 'iam.ResourceRoles' resource, or the expanded 'iam.ResourceRoles' resource, or the 'null' value.
asset.GeoLocation.Response_2
The response body of a HTTP GET request for the 'asset.GeoLocation' resource. The value may be one of the following types. 1. When 'tag' is specified in the UR…
asset.DeploymentAlarmInfo_2
Persists the different alarm type flags.
asset.GeoLocation.Relationship_2
A relationship to the 'asset.GeoLocation' resource, or the expanded 'asset.GeoLocation' resource, or the 'null' value.
iam.SwitchAccountPermission_2
SwitchScope parameters related to the Account to/from which user switched.
asset.DeviceContractInformation.List_2
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
iam.EndPointPrivilege_2
EndPointPrivilege models privileges defined on managed endpoints (e.g., UCS, IMC), enabling cross-launch or delegated actions. Purpose It exposes endpoint-side…
asset.DeviceTransaction_2
Type for saving the device transaction history. It is used in asset.DeploymentDeviceInformation object to save the device transactions.
iam.LdapPolicy_2
Overview The LDAP Policy object is a reusable policy for configuring Lightweight Directory Access Protocol (LDAP) settings, enabling remote user authentication…
iam.ApiKey.Relationship_2
A relationship to the 'iam.ApiKey' resource, or the expanded 'iam.ApiKey' resource, or the 'null' value.
iam.IpAccessManagement.Relationship_2
A relationship to the 'iam.IpAccessManagement' resource, or the expanded 'iam.IpAccessManagement' resource, or the 'null' value.
iam.DefaultPermissionInfo_2
Contains information about a stored default permission and its shared login interface coverage for product-facing default role selection.
iam.TrustPoint.Relationship_2
A relationship to the 'iam.TrustPoint' resource, or the expanded 'iam.TrustPoint' resource, or the 'null' value.
asset.Target.Response_2
The response body of a HTTP GET request for the 'asset.Target' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL que…
asset.AlarmSummary_2
The summary of alarm counts based on alarm serverity.
iam.AppCredentials_2
Contains credentials information for a particular client application.
iam.UserSetting.Relationship_2
A relationship to the 'iam.UserSetting' resource, or the expanded 'iam.UserSetting' resource, or the 'null' value.
asset.Subscription.Response_2
The response body of a HTTP GET request for the 'asset.Subscription' resource. The value may be one of the following types. 1. When 'tag' is specified in the U…
resource.Selector_2
Complex type representing the filter condition to extract the resources.
asset.SubscriptionAccount.List_2
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
iam.UserPreference_2
UserPreference captures user interface preferences—such as layout, view state, or theme—persisted per user and identity context. Purpose It enables consistent,…
asset.PreClaim_2
The PreClaim object is a specialized component of the device management system designed to facilitate the completion of the claim process for pre-provisioned a…
iam.ResourcePermission_2
ResourcePermission represents the permissions defined on a resource like organization.
iam.LdapMeta_2
LdapMeta stores metadata for internal LDAP connectors created to support an appliance LDAP cluster configuration. Purpose It provides system-managed insight in…
iam.SessionLimits.Relationship_2
A relationship to the 'iam.SessionLimits' resource, or the expanded 'iam.SessionLimits' resource, or the 'null' value.
iam.Privilege.Relationship_2
A relationship to the 'iam.Privilege' resource, or the expanded 'iam.Privilege' resource, or the 'null' value.
iam.ClientMeta_2
Contains meta information of the client. Currently it is used only within OAuth clients.
asset.ServiceOptions_2
ServiceOptions captures configuration that is specific to a target type for a specific service.
asset.DeviceConnectorManager.List_2
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
iam.IpAccessManagement_2
IpAccessManagement governs IP-based access restrictions for an account, enabling administrators to allowlist trusted ranges and recover from misconfiguration.…
iam.UserGroup_2
UserGroup provides a policy mechanism to assign permissions to cohorts of users based on identity attributes or explicit guest inclusion. Purpose UserGroup sim…
asset.Credential_2
A credential which can be used to authenticate with a managed target.
asset.AddressInformation_2
Type for saving the address information. It is used in asset.DeviceContractInformation object to save customer address.
iam.UserPreference.Relationship_2
A relationship to the 'iam.UserPreference' resource, or the expanded 'iam.UserPreference' resource, or the 'null' value.
asset.SubscriptionDeviceContractInformation.Response_2
The response body of a HTTP GET request for the 'asset.SubscriptionDeviceContractInformation' resource. The value may be one of the following types. 1. When 't…
asset.DeviceRegistration.Response_2
The response body of a HTTP GET request for the 'asset.DeviceRegistration' resource. The value may be one of the following types. 1. When 'tag' is specified in…
iam.Permission_2
Permission provides a way to assign roles to a user or user group to perform operations on object hierarchy.
resource.Reservation_2
The Reservation object is responsible for reserving slots for new resources within resource groups, ensuring organized and planned resource allocation. Purpose…
iam.TrustPoint_2
The TrustPoint object represents a trusted source of certificates within the system, enabling secure communication and authentication. Purpose A TrustPoint ser…
asset.GeoLocation_2
The geographic location of a managed target.
iam.Idp.Relationship_2
A relationship to the 'iam.Idp' resource, or the expanded 'iam.Idp' resource, or the 'null' value.
iam.Role_2
A role is a collection of privilege sets that are assigned to a user using a permission object.
asset.SudiInfo_2
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 pub…
asset.DeviceConnection_2
An abstract class that holds the details of a device connectors connection to Intersight.
asset.DeviceStatistics_2
Type for saving device statistics related information for HyperFlex and UCS devices. It is used in asset.DeploymentDevice object to save the current device sta…
organization.Organization.Relationship_2
A relationship to the 'organization.Organization' resource, or the expanded 'organization.Organization' resource, or the 'null' value.
asset.SubscriptionDeviceContractInformation_2
The SubscriptionDeviceContractInformation object is a crucial component of asset management within the Cisco ecosystem, designed to encapsulate information reg…
asset.DeviceConnectorManager_2
The DeviceConnectorManager object is a central component in managing registered Intersight Assist Appliance Devices within the Intersight ecosystem. This provi…
iam.IpAddress_2
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…
asset.ClaimToken.List_2
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
asset.DeviceConfiguration.List_2
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
iam.Account_2
The Account object defines the organizational framework within which users and resources are managed, serving as the central hub for access and permissions. Pu…
iam.PrivilegeSet_2
A collection of privileges.
resource.Group.Relationship_2
A relationship to the 'resource.Group' resource, or the expanded 'resource.Group' resource, or the 'null' value.
asset.ClaimToken_2
The ClaimToken object serves as a secure mechanism for onboarding and registering devices to an Intersight user account. It facilitates a streamlined connectio…
iam.Permission.Relationship_2
A relationship to the 'iam.Permission' resource, or the expanded 'iam.Permission' resource, or the 'null' value.
iam.AbstractQualifier.Relationship_2
A relationship to the 'iam.AbstractQualifier' resource, or the expanded 'iam.AbstractQualifier' resource, or the 'null' value.
iam.SecurityHolder.Relationship_2
A relationship to the 'iam.SecurityHolder' resource, or the expanded 'iam.SecurityHolder' resource, or the 'null' value.
asset.DeploymentDevice_2
The DeploymentDevice object is pivotal in managing device information within consumption-based subscriptions. This provides a detailed view of device installat…
iam.OAuthToken_2
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.Idp_2
The SAML identity provider such as Cisco, that has been used to log in to Intersight.
iam.AbstractClientApplication.Relationship_2
A relationship to the 'iam.AbstractClientApplication' resource, or the expanded 'iam.AbstractClientApplication' resource, or the 'null' value.
asset.DeviceClaim_2
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 pe…
resource.Reservation.Relationship_2
A relationship to the 'resource.Reservation' resource, or the expanded 'resource.Reservation' resource, or the 'null' value.
iam.ResourceRoles_2
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_2
A relationship to the 'iam.DomainGroup' resource, or the expanded 'iam.DomainGroup' resource, or the 'null' value.
asset.SubscriptionAccount.Response_2
The response body of a HTTP GET request for the 'asset.SubscriptionAccount' resource. The value may be one of the following types. 1. When 'tag' is specified i…
iam.LocalUserPassword.Relationship_2
A relationship to the 'iam.LocalUserPassword' resource, or the expanded 'iam.LocalUserPassword' resource, or the 'null' value.
asset.DeploymentDevice.List_2
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
resource.AbstractReservation_2
You can reserve resources for use cases related to Pools or Groups. For example, resources that are decommissioned or reserved for future allocation are mainta…
asset.DeviceRegistration_2
The DeviceRegistration object represents a device connector-enabled endpoint that has registered with Intersight. It is a concrete object central to the manage…
iam.SwitchScopePermissions_2
SwitchScope parameters related to the Account to which user switched to.
iam.ResourceLimits_2
ResourceLimits establishes account-level limits and policies for identity-related resources and credentials. Purpose It ensures controlled growth and predictab…
asset.Subscription_2
The Subscription object is central to managing consumption-based subscriptions within the Cisco technology ecosystem. It encapsulates details about the subscri…
asset.Deployment.List_2
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
asset.DeviceRegistration.List_2
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
iam.ServiceProvider_2
ServiceProvider encapsulates the platforms SAML Service Provider (SP) identity and metadata, used to integrate with external IdPs. Purpose It provides SP metad…
iam.AbstractQualifier_2
Placeholder for different types of qualifiers.
iam.PermissionToRoles_2
Complex type representing a permission and its associated roles.
asset.DeploymentDeviceAlarmInfo_2
Persists the different alarm type flags.
asset.Deployment.Response_2
The response body of a HTTP GET request for the 'asset.Deployment' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL…
asset.Subscription.List_2
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
asset.CustomerInformation_2
Type for saving contract information.
iam.SessionLimits_2
The session related configuration limits.
asset.DeviceContractInformation.Relationship_2
A relationship to the 'asset.DeviceContractInformation' resource, or the expanded 'asset.DeviceContractInformation' resource, or the 'null' value.
iam.LdapDnsParameters_2
DNS settings used to access LDAP Providers.
iam.IdpReference_2
The IdpReference object represents the system-provided Cisco IdP association within an account, acting as the default reference for user and group assignments.…
asset.ProductInformation_2
Type for saving the product information.
iam.LdapGroup_2
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…
asset.SubscriptionAccount_2
The SubscriptionAccount object is a foundational element within the subscription management framework, acting as a placeholder for the account collection. Its…
asset.DeploymentDevice.Relationship_2
A relationship to the 'asset.DeploymentDevice' resource, or the expanded 'asset.DeploymentDevice' resource, or the 'null' value.
iam.DomainGroup_2
Intersight services are mapped to three different categories of services for scaling purpose. Three categories are defined: Partition1/Partition2/Partition3. T…
iam.AppRegistration.Relationship_2
A relationship to the 'iam.AppRegistration' resource, or the expanded 'iam.AppRegistration' resource, or the 'null' value.
iam.UserGroup.Relationship_2
A relationship to the 'iam.UserGroup' resource, or the expanded 'iam.UserGroup' resource, or the 'null' value.
iam.Session.Relationship_2
A relationship to the 'iam.Session' resource, or the expanded 'iam.Session' resource, or the 'null' value.
asset.DeviceContractInformation.Response_2
The response body of a HTTP GET request for the 'asset.DeviceContractInformation' resource. The value may be one of the following types. 1. When 'tag' is speci…
iam.ApiKey_2
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_2
Organization provides multi-tenancy within an account. Multiple organizations can be present under an account. Resources are associated to organization using r…
asset.DeviceClaim.Relationship_2
A relationship to the 'asset.DeviceClaim' resource, or the expanded 'asset.DeviceClaim' resource, or the 'null' value.
asset.Deployment.Relationship_2
A relationship to the 'asset.Deployment' resource, or the expanded 'asset.Deployment' resource, or the 'null' value.
iam.SecurityHolder_2
SecurityHolder aggregates account-wide and organization-scoped permissions, serving as the nexus for effective authorization state across the accounts resource…
asset.Target.List_2
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
iam.ResourcePermission.Relationship_2
A relationship to the 'iam.ResourcePermission' resource, or the expanded 'iam.ResourcePermission' resource, or the 'null' value.
asset.DeviceConfiguration_2
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 ex…
iam.Session_2
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_2
EndPointRole represents roles defined on managed endpoints that encapsulate one or more endpoint privileges. Purpose It allows administrators to assign endpoin…
iam.AbstractClientApplication_2
Describes an internal application registered against an endpoint in Intersight. The application receives requests specific to its use case and these requests r…
asset.SubscriptionDeviceContractInformation.List_2
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
iam.User.Relationship_2
A relationship to the 'iam.User' resource, or the expanded 'iam.User' resource, or the 'null' value.
iam.UserSetting_2
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…
asset.DeploymentDeviceInformation_2
Type for saving the device information reported by Cisco Install Base. It is used in asset.DeploymentDevice object to save the device information.
asset.ClusterMember.List_2
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
asset.DeviceConfiguration.Relationship_2
A relationship to the 'asset.DeviceConfiguration' resource, or the expanded 'asset.DeviceConfiguration' resource, or the 'null' value.
asset.DeviceInformation_2
Type for saving the device information reported by Cisco Install Base. It is used in asset.SubscriptionDeviceInformation object to save the device information.
asset.Connection_2
A method for Intersight to connect to a managed target, including network connectivity and authentication details.
iam.LdapMeta.Relationship_2
A relationship to the 'iam.LdapMeta' resource, or the expanded 'iam.LdapMeta' resource, or the 'null' value.
asset.DeviceContractInformation_2
The DeviceContractInformation object provides a comprehensive structure for managing contract-related information of Cisco devices identified by unique identif…
iam.Role.Relationship_2
A relationship to the 'iam.Role' resource, or the expanded 'iam.Role' resource, or the 'null' value.
iam.User_2
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_2
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_2
A relationship to the 'iam.PrivilegeSet' resource, or the expanded 'iam.PrivilegeSet' resource, or the 'null' value.
asset.DeviceRegistration.Relationship_2
A relationship to the 'asset.DeviceRegistration' resource, or the expanded 'asset.DeviceRegistration' resource, or the 'null' value.
iam.LdapProvider_2
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_2
TestIdpConfiguration supports validating an IdP setup by performing a controlled authentication, currently supported only for testing LDAP configurations. test…
iam.ServiceProvider.Relationship_2
A relationship to the 'iam.ServiceProvider' resource, or the expanded 'iam.ServiceProvider' resource, or the 'null' value.
asset.ContractInformation_2
Type for saving contract information.
resource.Group_2
The Group object represents a collection of REST resources within the system, designed to streamline resource management through organized groupings. Purpose A…
asset.ClaimToken.Response_2
The response body of a HTTP GET request for the 'asset.ClaimToken' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL…
iam.AppRegistration_2
The AppRegistration object facilitates the registration of OAuth2 client applications, enabling secure access to APIs using OAuth2 credentials. Purpose An AppR…
iam.LdapProvider.Relationship_2
A relationship to the 'iam.LdapProvider' resource, or the expanded 'iam.LdapProvider' resource, or the 'null' value.
iam.System_2
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.LdapPolicy.Relationship_2
A relationship to the 'iam.LdapPolicy' resource, or the expanded 'iam.LdapPolicy' resource, or the 'null' value.
asset.MeteringType_2
Type for saving Metering details.
iam.IpAddress.Relationship_2
A relationship to the 'iam.IpAddress' resource, or the expanded 'iam.IpAddress' resource, or the 'null' value.
asset.DeploymentDevice.Response_2
The response body of a HTTP GET request for the 'asset.DeploymentDevice' resource. The value may be one of the following types. 1. When 'tag' is specified in t…
asset.Subscription.Relationship_2
A relationship to the 'asset.Subscription' resource, or the expanded 'asset.Subscription' resource, or the 'null' value.
asset.GlobalUltimate_2
Type for customer information of the BillToGlobal.
asset.GeoLocation.List_2
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
iam.IdpReference.Relationship_2
A relationship to the 'iam.IdpReference' resource, or the expanded 'iam.IdpReference' resource, or the 'null' value.
iam.Account.Relationship_2
A relationship to the 'iam.Account' resource, or the expanded 'iam.Account' resource, or the 'null' value.
asset.VmHost_2
Type for saving VM host details.
iam.EndPointPrivilege.Relationship_2
A relationship to the 'iam.EndPointPrivilege' resource, or the expanded 'iam.EndPointPrivilege' resource, or the 'null' value.
iam.ResourceLimits.Relationship_2
A relationship to the 'iam.ResourceLimits' resource, or the expanded 'iam.ResourceLimits' resource, or the 'null' value.
iam.Privilege_2
Privilege represents an action which can be performed in Intersight such as creating server profile, deleting a user etc.
iam.LocalUserPassword_2
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_2
A relationship to the 'iam.TestIdpConfiguration' resource, or the expanded 'iam.TestIdpConfiguration' resource, or the 'null' value.
asset.DeviceConfiguration.Response_2
The response body of a HTTP GET request for the 'asset.DeviceConfiguration' resource. The value may be one of the following types. 1. When 'tag' is specified i…
asset.ClaimSignature_2
A cryptographic signature that can be used to auto-claim a device connector into a user's account.
asset.DeviceContractNotification_2
The DeviceContractNotification object facilitates communication between appliances and cloud systems, supporting contract status computations. It acts as an in…
iam.LdapGroup.Relationship_2
A relationship to the 'iam.LdapGroup' resource, or the expanded 'iam.LdapGroup' resource, or the 'null' value.
iam.LdapBaseProperties_2
Base settings of LDAP required while configuring LDAP policy.
asset.DeviceConnectorManager.Response_2
The response body of a HTTP GET request for the 'asset.DeviceConnectorManager' resource. The value may be one of the following types. 1. When 'tag' is specifie…
asset.Deployment_2
The Deployment object is an essential element of the Cisco consumption-based subscription ecosystem, providing detailed information about deployments associate…
asset.ClusterMember.Response_2
The response body of a HTTP GET request for the 'asset.ClusterMember' resource. The value may be one of the following types. 1. When 'tag' is specified in the…
iam.OAuthToken.Relationship_2
A relationship to the 'iam.OAuthToken' resource, or the expanded 'iam.OAuthToken' resource, or the 'null' value.
iam.AccountPermissions_2
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_2
Complex type representing an object type to associated filter by combining all selectors.
asset.Service_2
A service that is enabled on a managed target. For example, Intersight Orchestration or Intersight Workload Optimizer.
iam.PermissionReference_2
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…
asset.ClusterMember.Relationship_2
A relationship to the 'asset.ClusterMember' resource, or the expanded 'asset.ClusterMember' resource, or the 'null' value.
iam.EndPointRole.Relationship_2
A relationship to the 'iam.EndPointRole' resource, or the expanded 'iam.EndPointRole' resource, or the 'null' value.
asset.ConnectionFlapStatus_2
Encapsulates key details used to identify devices experiencing connection flapping.
asset.SubscriptionAccount.Relationship_2
A relationship to the 'asset.SubscriptionAccount' resource, or the expanded 'asset.SubscriptionAccount' resource, or the 'null' value.
asset.Target.Relationship_2
A relationship to the 'asset.Target' resource, or the expanded 'asset.Target' resource, or the 'null' value.
asset.Target_2
The Target object represents an entity managed by Intersight. It encompasses both physical and software entities, such as UCS servers or cloud accounts, and se…
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Cisco Intersight publishes across the network.