|
Unix VPS
Support
FAQ
Network
Miscellaneous
|
| OpenXPKI::Server::API2::Types(3) | User Contributed Perl Documentation | OpenXPKI::Server::API2::Types(3) |
NAME
OpenXPKI::Server::API2::Types - Collection of Moose types used for API command parameters
TYPES
AlphaPunct
Text with space and punctuation characters. Allowed: alphanumeric, underscore ("_"), other connector punctuation chars, Unicode marks, dash ("-"), colon (":"), space
ArrayOrAlphaPunct
Array of AlphaPunct strings.
PosInt
A postive integer value (excluding zero)
Hex
A string containing a number in hexadecimal notation
IntOrHex
Either an "Int" or a "Hex" number
Ident
A string used as identifier, allows word + underscore
Empty
The empty string
Base64
A string containing only characters allowed in Base64 and Base64 filename/URL safe encoding.
PEM
A PEM encoded data (i.e. Base64 encoded string separated by newlines).
PEMCert
A PEM encoded certificate
PEMCertChain
A PEM encoded certificate chain
PEMPKCS7
A PEM encoded PKCS7 container
PEMPKey
A PEM encoded private key container
PEMPubKey
A PEM encoded private key container
An email address (or at least 99% of them).
Allowed characters are word and dash, for the local part also the plus sign and a colon. A percent character is NOT allowed to avoid some nasty SQL issues.
ArrayRefOrPEMCertChain
An ArrayRef of "PEMCertChain" that will also accept a scalar of type "PEMCertChain" (which is automatically wrapped into an ArrayRef).
Please also see "COERCION".
ArrayRefOrStr
An ArrayRef of Str that will also accept a scalar Str (which is automatically wrapped into an ArrayRef).
# this is the same:
CTX('api2')->show(animal => "all");
CTX('api2')->show(animal => [ "all" ]);
Please also see "COERCION".
ArrayRefOrCommaList
An ArrayRef of Str that will also accept a scalar Str with a comma separated list of string (which is converted into an ArrayRef).
# this is the same:
CTX('api2')->show(animal => "dog,cat, other");
CTX('api2')->show(animal => [ "dog", "cat", "other"]);
Please also see "COERCION".
Tenant
TokenType
Enumeration: certsign, crlsign, datasafe, cmcra or scep.
CertStatus
Enumeration of certificate stati: ISSUED, REVOKED, CRL_ISSUANCE_PENDING or VALID, EXPIRED.
Please note that in queries specifying a validity date the returned status can also be VALID.
COERCION
For some of the types you must also specify "coerce => 1" for the automatic type conversions to work, e.g.:
command "doit" => {
types => { isa => 'ArrayRefOrCommaList', coerce => 1, },
} => sub {
my ($self, $params) = @_;
print join(", ", @{ $params->types }), "\n";
};
no Moose::Util::TypeConstraints;
| 2025-07-15 | perl v5.40.2 |
Visit the GSP FreeBSD Man Page Interface.
Output converted with ManDoc.