NAME

OpenXPKI::Server::API2::Plugin::Token::get_token_alias_by_x

COMMANDS

get_token_alias_by_type

Returns the name of the "best" token for the given token type. For a definition of "best" see API command get_token_alias_by_group

Looks up the token group for that type at config path realm.crypto.type and then calls "get_token_alias_by_group".

Parameters

"type" Str - Token type (for possible values see "TokenType" in OpenXPKI::Server::API2::Types). Required.
"validity" HashRef - two datetime objects, given as hash keys notbefore and notafter. Hash values of "undef" will be interpreted as "now". Default: now

get_token_alias_by_group

Returns the name (alias) of the "best" token for the given token group.

By default, the "best" match is the newest token (i.e. token with the newest notbefore date) that is usable now. You can specify an alternative time frame using the "validity" parameter to find a token that is able to sign a request with the given validity.

Parameters

"group" Str - Token group. Required.
"validity" HashRef - two datetime objects, given as hash keys notbefore and notafter. Hash values of "undef" will be interpreted as "now". Default: now