GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages
OpenXPKI::Server::API2::Plugin::Token::get_ca_list(3) User Contributed Perl Documentation OpenXPKI::Server::API2::Plugin::Token::get_ca_list(3)

OpenXPKI::Server::API2::Plugin::Token::get_ca_list

List all items in the certsign group of the requested realm.

Each entry of the list is a HashRef:

    {
        alias => '...',      # full alias name
        identifier => '...', # certificate identifier
        notbefore => '...',  # certificate validity (UNIX epoch timestamp)
        notafter => '...',   # certificate validity (UNIX epoch timestamp)
        subject => '...',    # certificate subject
        status => '...',     # verbose status of the token: EXPIRED, UPCOMING, ONLINE, OFFLINE OR UNKNOWN
    }

The online/offline status check is only possible from within the current realm, for requests outside the current realm the status of a valid token is always "UNKNOWN".

The list is sorted by "notbefore" date, starting with the newest date. Dates are taken from the alias table and might differ from the certificates validity!

Parameters

  • "pki_realm" Str - PKI realm to query, defaults to the session realm
  • "check_online" Bool - Set to 1 to get the token online status (is_token_usable is called for each alias). The status check is only possible from within the current session's realm, for requests regarding another realm the status is always "UNKNOWN". Default: 0
2022-05-14 perl v5.32.1

Search for    or go to Top of page |  Section 3 |  Main Index

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with ManDoc.