EverTrust Logo
Products
Cloud Horizon Horizon Client OCSPd (legacy) Product lifecycle Stream WinHorizon
Support

Horizon

  • Installation
    • Introduction
    • Installing on CentOS/RHEL
      • Pre-requisites
      • Installation
        • Install MongoDB
        • Install NGINX
        • Install Horizon
        • Configure the Firewall
      • Configuration
        • Initial Configuration
        • Server Authentication Certificate
      • Startup & login
      • Upgrade
        • Standard Upgrade
        • Upgrading from a version prior to 2.1.0
      • Backup and Restore
      • Uninstallation
    • Installing on Kubernetes
      • Installation
      • Production checklist
      • Startup & login
      • Upgrade
      • Uninstallation
      • Advanced usage
    • Installing on Openshift
    • Running with Docker/Compose
    • Troubleshooting
  • Admin guide
    • Introduction
    • User Information
    • Certification Authorities
    • PKIs
      • PKI Queue
      • PKI Connectors
        • General Information
        • AWS
        • CertEurope
        • CS-Novidy’s TrustKey
        • Digicert CertCentral
        • EJBCA
        • Entrust Certificates Services
        • Eviden IDCA
        • EverTrust Integrated CA
        • EverTrust Stream CA
        • FISId
        • GlobalSign Atlas
        • GlobalSign MSSL
        • MetaPKI
        • MSAD Certificate Services
        • Nexus Certificate Manager
        • OpenTrust PKI
        • Sectigo CMS
    • Security
      • Local Accounts
      • Authorization
      • Roles
      • Teams
      • Identity Providers Configuration
      • Credentials
      • Password Policies
    • Notifications
      • Email
      • Groupware
      • REST
    • Discovery
    • Automation
      • Automation Introduction
      • Execution Policy
      • Automation Policy
    • Protocols
      • ACME
        • ACME Introduction
        • ACME Profile
        • ACME client usages
      • CRMP
        • CRMP Introduction
        • CRMP Profile
        • Enroll your first card with OpenTrust CMS
      • EST
        • EST Introduction
        • EST Profile
      • SCEP
        • SCEP Introduction
        • SCEP Profile
      • WCCE
        • WCCE Introduction
        • WCCE Forest
        • WCCE Profile
        • WCCE Template Mapping
        • WCCE Test enrollment
        • WCCE MSAD Connector
        • WCCE Scheduled Tasks
      • WebRA
        • WebRA Introduction
        • WebRA Profile
        • WebRA Scheduled Tasks
    • Third parties
      • AWS
        • AWS Introduction
        • AWS Connector
        • AWS Trigger
      • AKV
        • AKV Introduction
        • Azure AKV Connector
        • AKV Trigger
      • F5
        • F5 Introduction
        • F5 Connector
        • F5 Trigger
      • GCM
        • GCM Introduction
        • GCM Connector
        • GCM Trigger
      • LDAP
        • LDAP Introduction
        • LDAP Connector
        • LDAP Triggers
    • MDM
      • Intune
        • Intune Introduction
        • Intune Connector
        • Intune Profile
        • Intune Scheduled Tasks
      • Intune PKCS
        • Intune PKCS Introduction
        • Intune PKCS Connector
        • Intune PKCS Profile
        • Intune PKCS Scheduled Tasks
        • Intune PKCS Trigger
      • Jamf
        • Jamf Introduction
        • Jamf Connector
        • Jamf Profile
        • Jamf Scheduled Tasks
    • System configuration
      • Labels
      • HTTP Proxy
      • Grading Rules
      • Global configuration
    • Common configuration elements
      • Cron Expression
      • Finite Duration
      • Regex
      • Dictionaries
      • Computation rule
    • Reports
    • Overridable configuration parameters
    • Logging
    • Event Codes
    • API guide
      • Lifecycle APIs
        • Certificates
          • List certificates
          • Retrieve a certificate
          • Retrieve a certificate by PEM
          • Run a certificate trigger
          • Retrieve the certificate search dictionary
          • Search certificates
          • Certificate aggregation
          • Export certificates
        • Requests
          • List profiles
          • Retrieve a request template
          • Submit a request
          • Retrieve a request
          • Cancel a request
          • Approve a request
          • Deny a request
          • Retrieve the request search dictionary
          • Search requests
          • Export requests
          • Request aggregation
      • Identity management
        • Local Identities
          • List local identities
          • Create a local identity
          • Update a local identity
          • Set the password for a local identity
          • Retrieve a local identity
          • Delete a local identity
          • Request a password reset
          • Reset a password
        • Identity Providers
          • List the enabled identity provider(s)
          • List all the identity provider(s)
          • Create a new identity provider
          • Update an existing identity provider
          • Retrieve a existing identity provider
          • Delete an identity provider
          • Retrieve the provider of a principal
        • Password Policies
          • List password policies
          • Create a password policy
          • Update a password policy
          • Retrieve a password policy
          • Delete a password policy
          • Generate a password with a password policy
        • Principals
          • Return the authenticated principal
          • Log out an authenticated principal and flush any cached authorization(s)
          • Authenticate a principal and redirect to the specified redirect URL
        • Principal Information
          • Create a new principal
          • Update a principal's information
          • Retrieve a principal information
          • Delete a principal
          • Search for principal information
        • Roles
          • List roles
          • Create a new role
          • Update a role
          • Retrieve a role
          • Delete a role
        • Teams
          • List the team(s)
          • Create a new team
          • Update a team
          • Retrieve a team
          • Delete a team
          • Transfer objects from a team to another
      • Discovery APIs
        • Discovery Campaigns
          • List discovery campaign(s)
          • Create a new discovery campaign
          • Update a discovery campaign
          • Retrieve a discovery campaign
          • Delete a discovery campaign
          • Flush a discovery campaign
        • Discovery Feed
          • Create a new discovery feed session
          • Feed a discovered certificate into a discovery campaign
          • Push a new discovery event
          • End a discovery session
      • Configuration APIs
        • Certificate Authorities
          • List the existing certificate authorities
          • Register a new certificate authority
          • Update an existing certificate authority
          • Delete an existing certificate authority
          • Retrieve an existing certificate authority
        • Trust Chains
          • List the public trust chains
          • Retrieve the trust chain for a specific public Certificate Authority
        • Cache CRL
          • List the CRL cache info
          • Retrieve the CRL cache info for a specific certificate authority
        • PKI Queues
          • List the existing pki queue(s)
          • Register a new pki queue
          • Update an existing pki queue
          • Delete an existing pki queue
          • Retrieve an existing pki queue
        • PKI Connectors
          • List the existing PKI connector(s)
          • Register a new PKI connector
          • Update an existing PKI connector
          • Retrieve an existing PKI connector
          • Delete an existing PKI connector
        • Credentials
          • List credentials
          • Create new credentials
          • Update credentials
          • Retrieve credentials
          • Delete credentials
        • Triggers
          • List the existing trigger(s)
          • Register a new trigger
          • Update an existing trigger
          • Retrieve an existing trigger
          • Delete an existing trigger
        • Certificate Profiles
          • List the existing certificate profiles
          • Register a new certificate profile
          • Update an existing certificate profile
          • Retrieve a specific certificate profile
          • Delete a certificate profile
        • Third Party Connectors
          • List the existing third party connector(s)
          • Register a new third party connector
          • Update an existing third party connector
          • Retrieve an existing third party connector
          • Delete an existing third party connector
        • WCCE
          • Perform a WCCE certificate enrollment
          • Retrieve the WCCE exchange certificate on a given profile
          • List the existing WCCE forest mapping(s)
          • Register a new WCCE forest mapping
          • Update an existing WCCE forest mapping
          • Retrieve an existing WCCE forest mapping
          • Delete an existing WCCE forest mapping
        • HTTP Proxies
          • List the existing HTTP proxy(ies)
          • Register a new HTTP proxy
          • Update an existing HTTP proxy
          • Retrieve an existing HTTP proxy
          • Delete an existing HTTP proxy
        • System configuration
          • List the existing system configurations
          • Upsert a system configuration
          • Upsert a system configuration
        • Events
          • Event search
          • Event verify
          • Retrieved an existing Event
        • Discovery Events
          • Discovery event search
          • Discovery event search
          • Retrieve a specific discovery event
        • Certificate Labels
          • List the existing labels
          • Register a new label
          • Update an existing label
          • Retrieve an existing label
          • Delete an existing label
        • Certificate Grading Policies
          • Retrieve an existing grading policy
          • Explain a Grading Policy
          • Explain a Grading Policy
          • Run a grading policy
          • List the existing grading policies
        • Certificate Grading Rulesets
          • Retrieve an existing grading ruleset
          • Explain a Grading Ruleset
          • Explain a Grading Ruleset
          • List the existing grading rulesets
        • Configuration cookbook
          • Generate the configuration cookbook in adoc format
        • License
          • Retrieve the license entitled modules
          • Retrieve the license information
      • Utility APIs
        • Computation rules
          • Evaluate a computation rule and its dictionary
        • Decoding API (RFC5280)
          • Detect and parse a RFC 5280 related file
          • Decode a pkcs#10 (url encoded)
          • Decode a pkcs#10 (file)
          • Extract the certificate and associated private key from a pkcs#12 (file)
          • Retrieve the Trust chain from a x509 certificate (url encoded)
          • Retrieve the Trust chain from a x509 certificate (file)
          • Decode a x509 certificate (url encoded)
          • Decode a x509 certificate (file)
  • User guide
    • Introduction
    • Managing requests on the WebRA
      • How to enroll a certificate using the WebRA
      • How to request a certificate revocation
      • How to request a certificate update
      • How to request a certificate duplication
      • How to request a certificate renewal
      • How to request a certificate recovery
    • Requesting a SCEP challenge
    • Requesting an EST challenge
    • Managing requests (operator)
    • Searching requests and certificates
  • Release notes
    • Horizon 2.5.10 release notes
    • Horizon 2.5.9 release notes
    • Horizon 2.5.8 release notes
    • Horizon 2.5.7 release notes
    • Horizon 2.5.6 release notes
    • Horizon 2.5.5 release notes
    • Horizon 2.5.4 release notes
    • Horizon 2.5.3 release notes
    • Horizon 2.5.2 release notes
    • Horizon 2.5.1 release notes
    • Horizon 2.5.0 release notes
  • Horizon
  • API guide
  • Identity management
  • Principals

Download OpenAPI

2.7 2.6 2.5 2.4 2.3 2.2

Principals

A security principal represents a user in Horizon. It can be used to grant permissions to users, and to assign roles and teams to them.

get
/api/v1/security/principals/self
get
/api/v1/security/principals/logout
get
/api/v1/security/principals/authenticate
Generate a password with a password policy Return the authenticated principal