NAME

OpenXPKI::Server::API2::Plugin::Cert::get_cert_actions

COMMANDS

get_cert_actions

Requires a certificate identifier and optional role. Returns a list of actions that the given role (defaults to current session role) can do with the given certificate. The return value is a nested hash with options available for lifecyle actions. The list of workflows is read from the roles uicontrol. The key certaction must contain a list where each item is a hash giving label and workflow and optional a set of conditions to be met.

Example:

  certaction:
   - label: I18N_OPENXPKI_UI_DOWNLOAD_PRIVATE_KEY
     workflow: certificate_privkey_export
     condition: keyexport

   - label: I18N_OPENXPKI_UI_CERT_ACTION_RENEW
     workflow: certificate_renewal_request
     condition: issued

   - label: I18N_OPENXPKI_UI_CERT_ACTION_AUTHORIZE
     workflow: certificate_authorize
     condition: issued profile
     profile: tls-client tls-client-server

The return value is a list with label and workflow set for each element that meets the condition(s) given in the condition keyword. Conditions are optional, if multiple conditions are given (separated by a whitespace) all conditions must be met.

Valid conditions are:

keyexport: A private key must exist in the datapool
issued: The certificate is not revoked
valid: The certificate is not revoked and within the validity interval
owner: current user is the certificate owner (see is_certificate_owner)
profile: Certificate must be of a certain profile, the list of allowed profiles must be given with the profile key, multiple profiles can be given, separated by whitespace.

In addition to the conditional checks, the given workflow must be accessible by the given role.

Parameters

•: "XXX" Bool - XXX. Default: XXX