Add CA Certificate Trust (QycdAddCACertTrust) API
Required Parameter Group:
| 1 | Application ID | Output | Char(*) |
| 2 | Length of application ID | Input | Binary(4) |
| 3 | Trusted CA certificate ID type | Input | Char(1) |
| 4 | Trusted CA certificate ID | Input | Char(*) |
| 5 | Length of trusted CA certificate ID | Input | Binary(4) |
| 6 | Error code | I/O | Char(*) |
Service Program: QICSS/QYCDCUSG
Default Public Authority: *USE
Threadsafe: Yes
The Add CA Certificate Trust (QycdAddCACertTrust) API will add a trusted certificate authority (CA) certificate to the list of trusted CA certificates for an application. The trusted CA certificate is assumed to be stored in the system certificate store (*SYSTEM). The exit program that is associated with the application will be called indicating that a CA certificate is now trusted by the application. If the exit program does not exist, or is the default value (program QSY_NOPGM in library QSY_NOLIB), the exit program will not be called.
Authorities and Locks
- Authority Required
- Caller must have *ALLOBJ and *SECADM special authorities.
- QUSRSYS/QYCDCERTI *USRIDX
- *EXCL
- Exit Registration Lock
- *SHRNUP
Required Parameter Group
- Application ID
- INPUT; CHAR(*)
The application identifier that the trusted CA certificate is assigned.
- Length of application ID
- INPUT; BINARY(4)
The length of the specified application ID. The length must be a value from 1 to 100.
- Trusted CA certificate ID type
- INPUT; CHAR(1)
The type of the trusted CA certificate ID.
You must use the following value:
1 The trusted CA certificate ID is the label for the certificate.
- Trusted CA certificate ID
- INPUT; CHAR(*)
The ID for the assigned trusted CA certificate. The ID is assumed to be in the coded character set ID (CCSID) of the job.
- Length of trusted CA certificate ID
- INPUT; BINARY(4)
The length of the specified trusted CA certificate ID. The length must be a value from 1 to 1024.
- Error code
- I/O; CHAR(*)
The structure in which to return error information. For the format of the structure, see Error Code Parameter.
Error Messages
| Message ID | Error Message Text |
|---|---|
| CPFA0AA E | Error occurred while attempting to obtain space. |
| CPF220E E | Application &1 not registered. |
| CPF2225 E | Not able to allocate internal system object. |
| CPF222E E | &1 special authority is required. |
| CPF3C3C E | Value for parameter &1 not valid. |
| CPF3C90 E | Literal value cannot be changed. |
| CPF3CD9 E | Requested function cannot be performed at this time. |
| CPF3CDA E | Registration facility repository not available for use. |
| CPF3CF1 E | Error code parameter not valid. |
| CPF3CF2 E | Error(s) occurred during running of &1 API. |
| CPF8100 E | All CPF81xx messages could be returned. xx is from 01 to FF. |
| CPF9803 E | Cannot allocate object &2 in library &3. |
| CPF9804 E | Object &2 in library &3 damaged. |
| CPF9810 E | Library &1 not found. |
| CPF9811 E | Program &1 in library &2 not found. |
| CPF9872 E | Program or service program &1 in library &2 ended. Reason code &3. |
| ICS1001 E | Trusted CA certificate operation not allowed. |
| ICS1003 E | Certificate not valid. |
API introduced: IBM® i 7.4
| Top | Security APIs | APIs by category |