EverTrust Logo
Products
ADCS Connector Cloud Event Forwarder Horizon Horizon Client Horizon Issuer Product lifecycle Stream WinHorizon
Support

Stream

    • Installation
      • Introduction
      • Installing on Linux
        • Pre-requisites
        • Installation
          • Installing MongoDB
          • Installing NGINX
          • Install Stream
        • Configuration
          • Initial Configuration
          • Bootstrapping EverTrust Stream
          • Initial Key Ceremony
          • Finalizing Stream Configuration
        • Security Guidelines
      • Installing on Kubernetes
        • Installation
        • First login
        • Production checklist
        • Advanced usage
        • Chart reference
      • Tinkey
      • Monitoring
      • Troubleshooting
      • Advanced configuration
      • Upgrade
      • Uninstallation
  • Admin guide
    • Introduction
    • Managing Certification Authorities
      • Importing an External Certification Authority
      • Importing an existing Managed Certification Authority
      • Issuing a new Root Certification Authority
      • Issuing a subordinate Certification Authority
      • Note on CRLDP and AIA settings
      • AIA Certificate Issuer
    • Managing Certificate Revocation
      • Configuring Certificate Revocation Lists for an External CA
      • Configuring Certificate Revocation Lists for a Managed CA
      • Viewing CRLs
      • Downloading CRLs
      • External CRL Storages
      • Configuring OCSP
    • Managing Certificate Templates & EKUs
      • Certificate Templates
      • Extended Key Usage
    • Managing Certificate Lifecycle
    • OpenSSH
      • Managing Certification Authorities
      • Managing Key Revocation
        • Configuring Key Revocation Lists for a Managed CA
        • Viewing KRLs
        • Downloading KRLs
      • Managing Certificate Templates
        • Certificate Templates
      • Managing Certificate Lifecycle
    • Managing Keystores & Keys
      • Keystores in Stream
      • Software keystore
      • PKCS#11 HSM
      • Cloud KMS
        • Setting up a Google Cloud Key Management (GCP CKM)
        • Setting up an AWS Key Management Service (AWS KMS)
        • Microsoft Azure Key Vault (AKV)
      • Managing keys in Stream
    • Managing Notifications
      • Email
      • REST
    • Managing Security
      • Authorizations
      • Credentials
      • Identity Providers
      • Local Accounts
      • Roles
      • Enforce Certificate Authentication
    • Managing Stream instance
      • Events
      • Event codes documentation
      • Proxies
      • Queue
      • Global configuration
    • Timestamping
      • Timestamping Authorities
      • NTP Clients
      • Timestamping Signers
    • Backup and Restore
    • Dictionaries
    • Computation rule
    • Template Strings
    • API guide
      • Certificate APIs
        • Certificate Lifecycle
          • List authorized Certificate Authorities / Templates for a lifecycle action
          • Enroll a certificate
          • Revoke a certificate
        • Certificate Information
          • Retrieve a certificate
          • Search for certificates
          • Aggregate certificate
      • SSH Certificate APIs
        • OpenSSH lifecycle
          • List authorized Certificate Authorities / Templates for a lifecycle action
          • Enroll an OpenSSH certificate
          • Revoke a certificate
        • OpenSSH Certificate Information
          • Retrieve a certificate
          • Search for OpenSSH certificates
          • Aggregate OpenSSH certificates
      • Identity management and security
        • Local Identities
          • List local identities
          • Create a local identity
          • Update a local identity
          • Retrieve a local identity
          • Delete a local identity
          • Reset a local identity 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
        • 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 the existing role(s)
          • Register a new role
          • Update an existing role
          • Retrieve an existing role
          • Delete an existing role
        • Credentials
          • List the existing credential(s)
          • Register a new credential
          • Update an existing credential
          • Retrieve an existing credential
          • Delete an existing credential
      • Key Management
        • Keystores
          • List the existing keystore(s)
          • Register a new keystore
          • Update an existing keystore
          • Retrieve an existing keystore
          • Delete an existing keystore
        • Keys
          • List the existing key(s) on a keystore
          • Find the existing key(s) on a keystore corresponding to a specified Certificate Authority
          • Generate a new Private Key on a keystore
          • Get an existing key on a keystore
          • Delete an existing key on a keystore
        • Hardware Security Modules
          • Retrieve the information of an existing hardware security module
          • Retrieve the slot(s) information of an existing hardware security module
      • Event APIs
        • Events
          • Retrieve a specific event
          • Retrieve the event search dictionary
          • Event search
        • Event Integrity Reports
          • List all event integrity reports
          • Run an event scan
      • Configuration APIs
        • Certificate Authorities
          • List the Certificate Authority(ies)
          • Register a new Certificate Authority
          • Update an existing Certificate Authority
          • Delete an existing Certificate Authority
          • Retrieve an existing Certificate Authority
          • Migrate an existing External Certificate Authority
          • Generate a certification request for an existing Certificate Authority
          • Issue a new Certificate Authority
          • CRL generation request for the considered Certificate Authority
          • Upload a CRL for an external Certificate Authority
        • Certificate Templates
          • List the existing certificate template(s)
          • Register a new certificate template
          • Update an existing certificate template
          • Retrieve an existing certificate template
          • Delete an existing certificate template
        • OpenSSH Certificate Authority
          • List the OpenSSH Certificate Authority(ies)
          • Register a new Certificate Authority
          • Update an existing OpenSSH Certificate Authority
          • Delete an existing Certificate Authority
          • Retrieve an existing Certificate Authority
          • KRL generation request for the considered Certificate Authority
        • OpenSSH Certificate Templates
          • List the existing certificate template(s)
          • Register a new certificate template
          • Update an existing certificate template
          • Retrieve an existing certificate template
          • Delete an existing certificate template
        • Extended Key Usages
          • List the extended key usages
          • Register a new custom extended key usage
          • Update an existing custom extended key usage
          • Delete an existing custom extended key usage
          • Retrieve an extended key usage
        • OCSP Signers
          • List the OCSP Signer(s)
          • Register a new OCSP Signer
          • Update an existing OCSP Signer
          • Retrieve an existing OCSP Signer
          • Delete an existing OCSP Signer
          • Generate a certification request for an existing OCSP Signer
        • Timestamping Signers
          • List the Timestamping Signer(s)
          • Register a new Timestamping Signer
          • Update an existing Timestamping Signer
          • Retrieve an existing Timestamping Signer
          • Delete an existing Timestamping Signer
          • Generate a certification request for an existing Timestamping Signer
        • NTP Clients
          • List the NTP Client(s)
          • Register a new NTP Client
          • Update an existing NTP Client
          • Retrieve an existing NTP Client
          • Delete an existing NTP Client
        • Timestamping Authorities
          • List the Timestamping Authorities(s)
          • Register a new Timestamping Authorities
          • Update an existing Timestamping Authorities
          • Retrieve an existing Timestamping Authority
          • Delete an existing Timestamping Authority
        • Triggers
          • List the existing trigger(s)
          • Register a new trigger
          • Update an existing trigger
          • Retrieve an existing trigger
          • Delete an existing trigger
        • RFC5280
          • 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)
        • OpenSSH
          • Parse an openssh public key (file)
          • Parse an openssh public key (pem)
        • Trust Chains
          • List the trust chains
          • Retrieve the trust chain for a specific Certificate Authority
        • System configuration
          • List the existing system configurations
          • Upsert a system configuration
          • Get a system configuration
        • CRLs
          • List the CRL Information
          • Retrieve the CRL Information for a specific Certificate Authority
        • OpenSSH key revocation list
          • List the KRL Information
          • Retrieve the KRL Information for a specific Certificate Authority
        • Queues
          • List the existing queue(s)
          • Register a new queue
          • Update an existing queue
          • Delete an existing queue
          • Retrieve an existing queue
        • HTTP Proxies
          • List the existing http proxy(ies)
          • Register a new http proxy
          • Update an existing http proxy
          • Delete an existing http proxy
          • Retrieve an existing http proxy
        • Configuration cookbook
          • Generate the configuration cookbook in adoc format
        • License
          • Retrieve the license information along with library versions
  • Release notes
    • Stream 2.1.10 release notes
    • Stream 2.1.9 release notes
    • Stream 2.1.8 release notes
    • Stream 2.1.7 release notes
    • Stream 2.1.6 release notes
    • Stream 2.1.5 release notes
    • Stream 2.1.4 release notes
    • Stream 2.1.3 release notes
    • Stream 2.1.2 release notes
    • Stream 2.1.1 release notes
    • Stream 2.1.0 release notes
  • Stream
  • API guide
  • Identity management and security
  • Principals

Download OpenAPI

2.1 1.3

Principals

A security principal represents a logged in user in Stream.

get
/api/v1/security/principals/self
get
/api/v1/security/principals/logout
get
/api/v1/security/principals/authenticate
Retrieve the provider of a principal Return the authenticated principal