The PUT /Certificates/{id}/Owner method is used to update the certificate owner for a specified certificate. The optional certificate owner is a security role defined in Keyfactor Command (see Security Roles and Claims). This endpoint
An endpoint is a URL that enables the API to gain access to resources on a server. returns 204 with no content upon success.
The user executing the request must also hold the security role marked as the current certificate owner on the certificate, if any, and the certificate owner to be assigned to the certificate.
Permissions for certificates can be set at either the global or certificate collection The certificate search function allows you to query the Keyfactor Command database for certificates from any available source based on any criteria of the certificates and save the results as a collection that will be availble in other places in the Management Portal (e.g. expiration alerts and certain reports). level. See Certificate Collection Permissions for more information about global vs collection permissions. See also the CollectionId input parameter A parameter or argument is a value that is passed into a function in an application., below.
Table 278: PUT Certificates {id} Owner Input Parameters
|
Name |
In |
Description |
|---|---|---|
| Id | Path | Required. An integer specifying the Keyfactor Command reference ID for the certificate to update. |
| CollectionId | Query |
An integer specifying an optional certificate collection identifier to validate that the user executing the request has sufficient permissions to do so. If a certificate collection ID is not supplied, the user must have global permissions to complete the action. Supplying a certificate collection ID allows for a check of the user's certificate collection-level permissions to determine whether the user has sufficient permissions at a collection level to complete the action. See Certificate Collection Permissions for more information. |
| NewRoleId | Body |
An integer indicating the Keyfactor Command reference ID of the security role assigned as the certificate owner. Set this value to null to clear an existing certificate owner. The value cannot be unset if the certificate template or system-wide settings Certificate Owner Role policy has been configured as Required. Note: To assign a certificate owner, one of NewRoleId or NewRoleName is required, not both.
|
| NewRoleName | Body |
A string containing the name of the security role assigned as the certificate owner. This name must match the existing name of the security role. Set this value to null or blank to clear an existing certificate owner. The value cannot be unset if the certificate template or system-wide settings Certificate Owner Role policy has been configured as Required. Note: To assign a certificate owner, one of NewRoleId or NewRoleName is required, not both.
|
An API is a set of functions to allow creation of applications. Keyfactor offers the Keyfactor API, which allows third-party software to integrate with the advanced certificate enrollment and management features of Keyfactor Command. endpoints can be called and results returned. It is intended to be used primarily for validation, testing and workflow A workflow is a series of steps necessary to complete a process. In Keyfactor Command, it refers to the workflow builder, which allows you to automate event-driven tasks such as when a certificate is requested, revoked or found in a certificate store. development. It also serves secondarily as documentation for the API. The link to the Keyfactor API Reference and Utility is in the dropdown from the help icon (
) at the top of the Management Portal page next to the Log Out button.