NAME

OpenXPKI::Server::API2::Plugin::Token::list_active_aliases

COMMANDS

list_active_aliases

Returns an ArrayRef of HashRefs with all tokens from the given group, which are/were valid within the given validity period:

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

Dates are taken from the alias table and might differ from the certificates validity!

The list is sorted by notbefore date, starting with the newest date.

Parameters

"group" Str - Token group. Default: none
"type" Str - Token type, might be specified instead of token group to query one of the predefined token types (for possible values see "TokenType" in OpenXPKI::Server::API2::Types). Default: none
"pki_realm" Str - PK realm, specify this to query another realm. Default: current session's realm.
"validity" HashRef - two datetime objects, given as hash keys notbefore and notafter. Hash values of "undef" will be interpreted as "now". Default: current time
"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