Return and reason codes

R_PKIServ may return the following values in the reason and return code parameters:

Table 1. Return and reason codes
SAF return code	RACF® return code	RACF reason code	Explanation
0	0	0	Successful completion
4	0	0	RACF not installed
8	8	4	A parameter list error has been detected. See Usage Notes for further details
8	8	8	The caller of this service has not been RACF authorized to use this callable service
8	8	12	An internal error has occurred during RACF processing of the requested function
8	8	16	Unable to establish a recovery environment
8	8	20	Function code specified is not defined
8	8	24	Parameter list version specified is not supported
8	8	28	Certificate generation provider not available
8	8	32	Incorrect value specified for CA_domain. Either the length is greater than 8 or the value contains characters that are not valid
8	12	xx	Certificate generation provider internal error. Reason code is the reason code from provider

Reason and return code parameters specific to function GENCERT and REQCERT:

SAF return code	RACF return code	RACF reason code	Explanation
4	4	0	Successful completion. However, notification of the TID through email is unsuccessful.
8	8	40	CertPlist has an incorrect length
8	8	44	CertPlist DiagInfo field missing or has an incorrect length
8	8	48	Incorrect field name specified in CertPlist. The field name is either unknown or not supported by this certificate generation provider
8	8	52	Incorrect field value specified in CertPlist
8	8	56	Required field is missing from the CertPlist
8	8	60	Certificate generation provider input or environment error
8	8	64	PKCS#11 Token Service encountered an error.
8	8	68	Notification form is not set up correctly in the case of key generation.
8	8	76	Conflicting field names specified in CertPlist.

Reason and return code parameters specific to function EXPORT:

SAF return code	RACF return rode	RACF reason code	Explanation
0	0	0	Successful completion. If the “PKICACERT” CertId was specified, then the returned certificate package contains just the X.509 CA certificate
0	0	1	Successful completion. The “PKICACERT” CertId was specified. The returned certificate package is the RA/CA PKCS #7 certificate chain
0	0	2	Successful completion. If serial number was specified in CertId, the returned certificate package contains the PKCS12 package.
8	8	40	CertAnchor area missing
8	8	44	CertAnchor area too small
8	8	48	Incorrect CertID (transaction ID or serial number) specified
8	8	52	Incorrect PassPhrase specified
8	8	56	Request is still pending approval or has yet to be issued
8	8	60	Request has been rejected by the administrator
8	8	64	PKCS#11 Token Service has encountered an error.
8	8	68	Incorrect KeyId specified or private key object in TKDS not found.
8	8	72	“PKICACERT” CertId specified, but SCEP is disabled

Reason and return code parameters specific to function QUERYREQS:

SAF return code	RACF return code	RACF reason code	Explanation
8	8	40	Results list area missing.
8	8	44	Results list area too small.
8	8	48	Incorrect CertId specified.
8	8	56	Incorrect status criteria specified.
8	8	60	No requests satisfy the input criteria.

Reason and return code parameters specific to function REQDETAILS:

SAF return code	RACF return code	RACF reason code	Explanation
8	8	40	Summary list or CertPlist area missing.
8	8	44	Summary list or CertPlist area too small.
8	8	48	Incorrect CertId specified.
8	8	52	Success, however name fields not returned in CertPlist.
8	8	64	Not authorized to display the details of the request under a specific template.

Reason and return code parameters specific to function MODIFYREQS:

SAF return code	RACF return code	RACF reason code	Explanation
8	8	40	CertPlist has an incorrect length.
8	8	44	CertPlist DiagInfo field missing or has an incorrect length.
8	8	48	Incorrect field name specified in CertPlist.
8	8	52	Incorrect field value specified in CertPlist.
8	8	56	Required field missing from CertPlist.
8	8	60	Certificate generation input or environment error.
8	8	64	CertIds has an incorrect length or value.
8	8	68	Incorrect Action specified.
8	8	72	One or more requests could not be modified because of a state change. CertIds contains the certificate request Ids that could not be modified. ErrList contains the corresponding error description.
8	8	96	One or more requests could not be modified because the user is not authorized to perform the action on the requests under that template. CertIds contains the certificate request Ids that could not be modified. ErrList contains the corresponding error description.

Reason and return code parameters specific to function QUERYCERTS:

SAF return code	RACF return code	RACF reason code	Explanation
8	8	40	Results list area missing.
8	8	44	Results list area too small.
8	8	48	Incorrect SerialNum specified.
8	8	56	Incorrect status criteria specified.
8	8	60	No certificates satisfy the input criteria.

Reason and return code parameters specific to function CERTDETAILS:

SAF return code	RACF return code	RACF reason code	Explanation
8	8	40	Summary list or CertPlist area missing.
8	8	44	Summary list or CertPlist area too small.
8	8	48	Incorrect SerialNum specified.
8	8	64	Not authorized to display the details of the certificate under a specific template.

Reason and return code parameters specific to function MODIFYCERTS:

SAF return code	RACF return code	RACF reason code	Explanation
8	8	40	Incorrect Reason specified.
8	8	52	Incorrect field value specified in RequestorEmail.
8	8	64	SerialNums has an incorrect length or value.
8	8	68	Incorrect Action specified.
8	8	72	One or more certificates cannot be modified because of a state change. SerialNums contains the certificate serial numbers that cannot be modified. ErrList contains the corresponding error description.
8	8	76	One or more certificates cannot be set up for automatic renewal. SerialNums contains the certificate serial numbers that could not be set up for automatic renewal. ErrList contains the corresponding error description.
8	8	80	RequestorEmail could not be modified because the key of the certificate was not generated by PKI Services.
8	8	84	More than one serial number is requested for RequestorEmail change.
8	8	88	One or more certificates could not be deleted from the TKDS although they were deleted from the ICL. SerialNums contains the certificate serial numbers that could not be deleted from the TKDS. ErrList contains the corresponding error description.
8	8	92	CRL or Certificate posting is not configured.
8	8	96	One or more certificates could not be modified because the calling userid is not authorized to perform the modify action for the given template (if applicable) and CA domain. The SerialNums parameter contains the serial number of the certificates that could not be modified. The ErrList parameter contains the corresponding error description for each of the failing serial numbers.

Reason and return code parameters specific to function VERIFY:

SAF return code	RACF return code	RACF reason code	Explanation
8	8	40	Summary list or CertPlist area missing.
8	8	44	Summary list or CertPlist area too small.
8	8	64	Incorrect certificate specified.

Reason and return code parameters specific to function REVOKE:

SAF return code	RACF return code	RACF reason code	Explanation
8	8	40	Incorrect Reason specified.
8	8	64	SerialNum has an incorrect length or value.
8	8	72	The certificate could not be revoked because of a state change.

Reason and return code parameters specific to functions GENRENEW and REQRENEW:

SAF return code	RACF return code	RACF reason code	Explanation
4	4	0	Successful completion. But notification of the TID through email was unsuccessful.
8	8	40	CertPlist has an incorrect length.
8	8	44	CertPlist DiagInfo field missing or has an incorrect length.
8	8	48	Incorrect field name specified in CertPlist. The field name is either unknown or not supported by this certificate generation provider.
8	8	52	Incorrect field value specified in CertPlist.
8	8	56	Required field missing from CertPlist.
8	8	60	Certificate generation input or environment error.
8	8	64	SerialNum has an incorrect length or value.
8	8	68	Notification form is not set up correctly for key generation.
8	8	72	The certificate could not be renewed because of a state change.
8	8	76	Conflicting field names specified in CertPlist.
8	8	80	The certificate could not be renewed because the requester's email has changed.

Reason and return code parameters specific to function RESPOND:

SAF return code	RACF return code	RACF reason code	Explanation
8	8	40	Response area missing.
8	8	44	Response area too small.
8	8	64	Incorrect request specified.
8	8	72	Responder disabled.

Reason and return code parameters specific to function SCEPREQ:

SAF return code	RACF return code	RACF reason code	Explanation
8	8	40	Response area missing.
8	8	44	Response area too small.
8	8	64	Incorrect request specified.
8	8	72	SCEP disabled.

Reason and return code parameters specific to function PREREGISTER:

SAF return code	RACF return code	RACF reason code	Explanation
8	8	40	CertPlist has an incorrect length
8	8	44	CertPlist DiagInfo field missing or has an incorrect length
8	8	48	Incorrect field name specified in CertPlist. The field name is either unknown or not supported by this certificate generation provider
8	8	52	Incorrect field value specified in CertPlist
8	8	56	Required field missing from CertPlist
8	8	60	Certificate generation provider input or environment error
8	8	72	Client already preregistered
8	8	76	Not authorized to preregister a client under a specific template.

Reason and return code parameters specific to function QRECOVER:

SAF return code	RACF return code	RACF reason code	Explanation
8	8	40	Results list area missing.
8	8	44	Results list area too small.
8	8	48	Incorrect requester’s email address specified.
8	8	52	Incorrect pass phrase specified.
8	8	56	Notify form is not set up correctly.
8	8	60	No certificates satisfy the input criteria.
8	8	64	Notify email cannot be sent.