ClearPass Policy Manager

Guides
API Reference
GitHub
Airheads Dev Community

{{user.name}}Log In

The ClearPass Policy Manager Developer Hub

Welcome to the ClearPass Policy Manager developer hub. You'll find comprehensive guides and documentation to help you start working with ClearPass Policy Manager as quickly as possible, as well as support if you get stuck. Let's jump right in!

ClearPass Policy Manager

AOS 8
AOS-CX
Central
ClearPass Policy Manager
User Experience Insight

v6.9.0HomeGuidesRecipesAPI ReferenceReferenceChangelogDiscussionsPage Not FoundSearch{{ state.current().meta.title }}API Logs

Introduction

Introduction and Overview
Getting Started with the ClearPass Policy Manager API

Documentation

API Versioning
HTTP Based APIs
REST API filtering

Legacy API

Introduction

Introduction

Introduction and Overview
Getting Started with the ClearPass Policy Manager API

Documentation

API Versioning
HTTP Based APIs
REST API filtering

Legacy API

Introduction

API Operations

TokenEndpoint
- post
  Obtain an OAuth2 access token for making API calls
TokenInfo
- get
  Returns OAuth2 authenticated client or user information
- post
  Returns OAuth2 authenticated client or user information
TokenPrivileges
- get
  Returns a list of privileges available to the user

Certificate Authority

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

Guest Actions

GenerateGuestDigitalPass
- get
  Generate digital pass for guest account based on template specified by ID
GenerateGuestReceipt
- get
  Generate print template for guest account, using specified template ID
SendSmsReceipt
- post
  Resend guest receipt for guest account, via SMS
SendSmtpReceipt
- post
  Resend guest receipt for guest account, via SMTP
SponsorshipApproval
- post
  Accept or reject a guest sponsorship request

Guest Configuration

DigitalPassTemplate
GuestAuthenticationConfiguration
GuestManager
PrintTemplate
WebLogin

Tools And Utilities

EmailSend
- post
  Send an Email
RandomMpskGenerator
- get
  GET_for_RandomMpskGenerator
- post
  POST_for_RandomMpskGenerator
RandomPasswordGenerator
- get
  GET_for_RandomPasswordGenerator
- post
  POST_for_RandomPasswordGenerator
SmsSend
- post
  Send an SMS message

Platform Certificates

CertSignRequest
- post
  Post a certificate sign request
CertTrustList
CertTrustListDetails
- get
  Get a list of certificate trust list details
- get
  Get a certificate trust list details
ClientCert
RevocationList
SelfSignedCert
- post
  Create a Self-Signed Certificate
ServerCert
ServiceCert

Identities

ApiClient
Device
Endpoint
ExternalAccount
GuestUser
LocalUser
StaticHostList

Logs

EndpointInfo
LoginAudit
- get
  Get previous login details for an admin user
SystemEvents
- get
  Get a list of system events

Local Server Configuration

AccessControl
CppmVersion
- get
  Get Cppm version
ServerConfiguration
ServerFips
- get
  Get server FIPS mode information
ServerSnmp
ServerVersion
- get
  Get server version information
ServiceParameter
- get
  Get service parameter details
- patch
  Update service parameter values
SystemServiceControl

Global Server Configuration

AdminPrivilege
AdminUser
AdminUserPasswordPolicy
ApplicationLicense
Attribute
ClearPassPortal
- get
  Get ClearPass Portal
- post
  Change ClearPass Portal
ClusterDbSync
- post
  Synchronize subscriber with the publisher
ClusterWideParameter
FileBackupServer
ListAllPrivileges
- get
  Returns the list of system-defined privileges
LocalUserPasswordPolicy
MessagingSetup
OperatorProfile
PolicyManagerZone
SnmpTrapReceiver

Integrations

ContextServerAction
DeviceInsight
- get
  Get Device Insight Integration details
- post
  Update Device Insight Integration values
EndpointContextServer
EventSources
ExtensionInstance
ExtensionInstanceConfig
- get
  Get the configuration of an installed extension
- put
  Set the configuration of an installed extension
ExtensionInstanceLog
- get
  Get the log output from an installed extension
ExtensionInstanceReinstall
- post
  Reinstall an extension
ExtensionInstanceRestart
- post
  Restart an installed extension
ExtensionInstanceStart
- post
  Start an installed extension
ExtensionInstanceStop
- post
  Stop an installed extension
ExtensionStore
- get
  Find a extension in the store
- get
  Get details of an extension in the store
SyslogExportFilter
SyslogTarget

Policy Elements

AuthMethod
AuthSource
NetworkDevice
NetworkDeviceGroup
RADIUSProxyTarget
Role
RoleMapping
Service

Endpoint Visibility

AgentlessOnGuardSettings
AgentlessOnGuardSubnetMapping
DeviceFingerprint
- post
  Post device fingerprint attributes for profiling
- get
  Get profiled device
FingerprintDictionary
NetworkScan
OnGuardCustomScript
OnGuardGlobalSettings
- get
  Get OnGuard global settings
- post
  Update OnGuard global settings
OnGuardSettings
- get
  Get OnGuard settings
- post
  Update OnGuard settings
OnGuardZoneMapping
ProfilerSubnetMapping

Session Control

ActiveSession
- get
  Get a list of active sessions
- get
  Get an active session
ActiveSessionDisconnect
- post
  Disconnect active session
ActiveSessionReauthorize
- get
  Get reauthorization profile(s) for an active session
- post
  Reauthorize active session
SessionAction

Introduction

Introduction and Overview
Getting Started with the ClearPass Policy Manager API

Documentation

API Versioning
HTTP Based APIs
REST API filtering

Legacy API

Introduction

Privacy policy
Terms of service
Legal
Do Not Sell My Personal Information

© Copyright 2021 Hewlett Packard Enterprise Development LP