Jump to Content

Home Guides API Reference

Guides API Reference GitHub Airheads Developer Community Log In

API Reference

Guides API Reference GitHub Airheads Developer Community Log In

API Operations

TokenEndpoint
- Obtain an OAuth2 access token for making API callspost
TokenInfo
- Returns OAuth2 authenticated client or user informationget
- Returns OAuth2 authenticated client or user informationpost
TokenPrivileges
- Returns a list of privileges available to the userget

Certificate Authority

Certificate
CertificateChain
- Get a certificate and its trust chainget
CertificateExport
- Export a certificate or certificate signing requestpost
CertificateImport
- Import a code-signing, trusted, or CA certificatepost
CertificateNew
- Create a new certificate signing request and private keypost
CertificateReject
- Reject a certificate signing requestpost
CertificateRequest
- Import a certificate signing requestpost
CertificateRevoke
- Revoke a certificatepost
CertificateSignRequest
- Sign a certificate signing requestpost
OnboardDevice
OnboardUser

Guest Configuration

DigitalPassTemplate
GuestAuthenticationConfiguration
GuestManager
PrintTemplate
WebLogin

Guest Actions

GenerateGuestDigitalPass
- Generate digital pass for guest account based on template specified by IDget
GenerateGuestReceipt
- Generate print template for guest account, using specified template IDget
SendSmsReceipt
- Resend guest receipt for guest account, via SMSpost
SendSmtpReceipt
- Resend guest receipt for guest account, via SMTPpost
SponsorshipApproval
- Accept or reject a guest sponsorship requestpost

Tools And Utilities

EmailSend
- Send an Emailpost
RandomMpskGenerator
- GET_for_RandomMpskGeneratorget
- POST_for_RandomMpskGeneratorpost
RandomPasswordGenerator
- GET_for_RandomPasswordGeneratorget
- POST_for_RandomPasswordGeneratorpost
SmsSend
- Send an SMS messagepost

Platform Certificates

CertSignRequest
- Post a certificate sign requestpost
CertTrustList
CertTrustListDetails
- Get a list of certificate trust list detailsget
- Get a certificate trust list detailsget
ClientCert
RevocationList
SelfSignedCert
- Create a Self-Signed Certificatepost
ServerCert
ServiceCert

Logs

EndpointInfo
LoginAudit
- Get previous login details for an admin userget
SystemEvents
- Get a list of system eventsget
- Create a new system eventpost

Integrations

ContextServerAction
DeviceInsight
- Get Device Insight Integration detailsget
- Update Device Insight Integration valuespost
EndpointContextServer
EventSources
ExtensionInstance
ExtensionInstanceConfig
- Get the configuration of an installed extensionget
- Set the configuration of an installed extensionput
ExtensionInstanceLog
- Get the log output from an installed extensionget
ExtensionInstanceReinstall
- Reinstall an extensionpost
ExtensionInstanceRestart
- Restart an installed extensionpost
ExtensionInstanceStart
- Start an installed extensionpost
ExtensionInstanceStop
- Stop an installed extensionpost
ExtensionInstanceUpgrade
- Get information on an extension's available upgradeget
- Upgrade an extensionpost
ExtensionStore
- Find a extension in the storeget
- Get details of an extension in the storeget
IngressEventDictionary
SyslogExportFilter
SyslogTarget

Global Server Configuration

AdminPrivilege
AdminUser
AdminUserPasswordPolicy
ApplicationLicense
Attribute
ClearPassPortal
- Get ClearPass Portalget
- Change ClearPass Portalpost
ClusterDbSync
- Synchronize subscriber with the publisherpost
ClusterWideParameter
DataFilter
FileBackupServer
ListAllPrivileges
- Returns the list of system-defined privilegesget
LocalUserPasswordPolicy
MessagingSetup
OperatorProfile
PolicyManagerZone
SnmpTrapReceiver

Identities

ApiClient
DenyListedUsers
Device
Endpoint
ExternalAccount
GuestUser
LocalUser
StaticHostList

Policy Elements

ApplicationDictionary
AuthMethod
AuthSource
EnforcementPolicy
NetworkDevice
NetworkDeviceGroup
PosturePolicy
RADIUSDictionary
RADIUSDynamicAuthorizationTemplate
RADIUSProxyTarget
Role
RoleMapping
Service
TACACSServiceDictionary

Local Server Configuration

ADDomain
AccessControl
CppmVersion
- Get Cppm versionget
ServerConfiguration
ServerFips
- Get server FIPS mode informationget
ServerSnmp
ServerVersion
- Get server version informationget
ServiceParameter
- Get service parameter detailsget
- Update service parameter valuespatch
SystemServiceControl

Endpoint Visibility

AgentlessOnGuardSettings
AgentlessOnGuardSubnetMapping
DeviceFingerprint
FingerprintDictionary
NetworkScan
OnGuardActivity
OnGuardCustomScript
OnGuardGlobalSettings
- Get OnGuard global settingsget
- Update OnGuard global settingspost
OnGuardSettings
- Get OnGuard settingsget
- Update OnGuard settingspost
OnGuardZoneMapping
ProfilerSubnetMapping
WindowsHotfix

Session Control

ActiveSession
- Get a list of active sessionsget
- Get an active sessionget
ActiveSessionDisconnect
- Disconnect active sessionpost
ActiveSessionReauthorize
- Get reauthorization profile(s) for an active sessionget
- Reauthorize active sessionpost
SessionAction

Get a Snmp Trap Receiver

get https://clearpass-hostname/api/snmp-trap-receiver/{snmp_trap_receiver_id}

Get a Snmp Trap Receiver

Language

Click Try It! to start a request and see the response here!

Terms of Service

© Copyright 2024 Hewlett Packard Enterprise Development LP