Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
OpenXPKI::Server::API2UserpContributed Perl DoOpenXPKI::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.

   Hex
       A string	containing a number in hexadecimal notation

   IntOrHex
       Either an "Int" or a "Hex" number

   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

   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".

   TokenType
       Enumeration: certsign, crlsign, datasafe	or scep.

   CertStatus
       Enumeration of certificate stati: ISSUED, REVOKED, CRL_ISSUANCE_PENDING
       or 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;

perl v5.32.0			  2020-08-29  OpenXPKI::Server::API2::Types(3)

NAME | TYPES | COERCION

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=OpenXPKI::Server::API2::Types&sektion=3&manpath=FreeBSD+12.2-RELEASE+and+Ports>

home | help