The identity and technical contract details declared by the specification.
catalystsdwan.VedgeDevice.Response
The response body of a HTTP GET request for the 'catalystsdwan.VedgeDevice' resource. The value may be one of the following types. 1. When 'tag' is specified i…
iam.System.Relationship
A relationship to the 'iam.System' resource, or the expanded 'iam.System' resource, or the 'null' value.
catalystsdwan.Vlan
Details for the WAN Edge Device VLAN entities.
iam.ResourceRoles.Relationship
A relationship to the 'iam.ResourceRoles' resource, or the expanded 'iam.ResourceRoles' resource, or the 'null' value.
catalystsdwan.VedgeDevice.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
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.
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.
catalystsdwan.ConfigGroup.Response
The response body of a HTTP GET request for the 'catalystsdwan.ConfigGroup' resource. The value may be one of the following types. 1. When 'tag' is specified i…
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.AlarmSummary
The summary of alarm counts based on alarm serverity.
iam.AppCredentials
Contains credentials information for a particular client application.
iam.UserSetting.Relationship
A relationship to the 'iam.UserSetting' resource, or the expanded 'iam.UserSetting' resource, or the 'null' value.
resource.Selector
Complex type representing the filter condition to extract the resources.
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…
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.
catalystsdwan.InventoryEntity
Base object type for all Catalyst SDWAN WAN Edge inventory items.
iam.IpAccessManagement
IpAccessManagement governs IP-based access restrictions for an account, enabling administrators to allowlist trusted ranges and recover from misconfiguration.…
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…
catalystsdwan.WanEdgeDevice.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
asset.Credential
A credential which can be used to authenticate with a managed target.
iam.UserPreference.Relationship
A relationship to the 'iam.UserPreference' resource, or the expanded 'iam.UserPreference' resource, or the 'null' value.
catalystsdwan.PhysicalPort
Physical ports belonging to a WAN Edge Device.
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.
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.
catalystsdwan.Vlan.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
organization.Organization.Relationship
A relationship to the 'organization.Organization' resource, or the expanded 'organization.Organization' resource, or the 'null' value.
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…
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.
resource.Group.Relationship
A relationship to the 'resource.Group' resource, or the expanded 'resource.Group' resource, or the 'null' value.
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.
catalystsdwan.PolicyGroup.Response
The response body of a HTTP GET request for the 'catalystsdwan.PolicyGroup' resource. The value may be one of the following types. 1. When 'tag' is specified i…
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…
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.
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.
catalystsdwan.PolicyGroup
Details for the Catalyst SDWAN policy groups.
catalystsdwan.PhysicalPort.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
iam.LocalUserPassword.Relationship
A relationship to the 'iam.LocalUserPassword' resource, or the expanded 'iam.LocalUserPassword' resource, or the 'null' value.
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…
catalystsdwan.PolicyGroup.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
catalystsdwan.VedgeDevice
VedgeDevice is deprecated. Going forward WanEdgeDevice will be used to store details for the Catalyst SDWAN Vedge entities.
catalystsdwan.Vlan.Response
The response body of a HTTP GET request for the 'catalystsdwan.Vlan' resource. The value may be one of the following types. 1. When 'tag' is specified in the U…
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.
catalystsdwan.Interface
Details for the WAN Edge Device L3 interfaces (Portchannel, sub-interfaces, tunnels, SVIs, Routed ports).
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…
iam.DomainGroup
Intersight services are mapped to three different categories of services for scaling purpose. Three categories are defined: Partition1/Partition2/Partition3. T…
iam.AppRegistration.Relationship
A relationship to the 'iam.AppRegistration' resource, or the expanded 'iam.AppRegistration' resource, or the 'null' value.
iam.UserGroup.Relationship
A relationship to the 'iam.UserGroup' resource, or the expanded 'iam.UserGroup' resource, or the 'null' value.
catalystsdwan.WanEdgeDevice
Details for the Catalyst SDWAN WAN Edge entities.
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…
asset.DeviceClaim.Relationship
A relationship to the 'asset.DeviceClaim' resource, or the expanded 'asset.DeviceClaim' 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…
catalystsdwan.Interface.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…
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…
catalystsdwan.ConfigGroup.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.
catalystsdwan.PortChannel
Details for the WAN Edge Device port channels.
asset.Connection
A method for Intersight to connect to a managed target, including network connectivity and authentication details.
catalystsdwan.PortChannel.Response
The response body of a HTTP GET request for the 'catalystsdwan.PortChannel' resource. The value may be one of the following types. 1. When 'tag' is specified i…
iam.LdapMeta.Relationship
A relationship to the 'iam.LdapMeta' resource, or the expanded 'iam.LdapMeta' resource, or the 'null' value.
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.
catalystsdwan.ConfigGroup
Details for the Catalyst SDWAN config groups.
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…
resource.Group
The Group object represents a collection of REST resources within the system, designed to streamline resource management through organized groupings. Purpose A…
catalystsdwan.WanEdgeDevice.Response
The response body of a HTTP GET request for the 'catalystsdwan.WanEdgeDevice' resource. The value may be one of the following types. 1. When 'tag' is specified…
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.
iam.IpAddress.Relationship
A relationship to the 'iam.IpAddress' resource, or the expanded 'iam.IpAddress' resource, or the 'null' value.
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.
catalystsdwan.PhysicalPort.Response
The response body of a HTTP GET request for the 'catalystsdwan.PhysicalPort' resource. The value may be one of the following types. 1. When 'tag' is specified…
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.
catalystsdwan.WanEdgeDevice.Relationship
A relationship to the 'catalystsdwan.WanEdgeDevice' resource, or the expanded 'catalystsdwan.WanEdgeDevice' resource, or the 'null' value.
asset.ClaimSignature
A cryptographic signature that can be used to auto-claim a device connector into a user's account.
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.
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…
catalystsdwan.Interface.Response
The response body of a HTTP GET request for the 'catalystsdwan.Interface' resource. The value may be one of the following types. 1. When 'tag' is specified in…
resource.PerTypeCombinedSelector
Complex type representing an object type to associated filter by combining all selectors.
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…
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.
catalystsdwan.PortChannel.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
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…
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Cisco Intersight publishes across the network.