PUT Certificates ID Owner

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 endpointClosed 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 certificate history will be updated on the certificate details for actions on this endpoint.

Tip:  The following permissions (see Security Roles and Claims) are required to use this feature:
/certificates/collections/change_owner/
OR
/certificates/collections/change_owner/#/ (where # is a reference to a specific certificate collection ID—see CollectionID, below)
OR
/certificate_stores/change_owner/
OR
/certificate_stores/change_owner/#/ (where # is a reference to a specific certificate store container ID—see ContainerID, below)
OR
/certificates/expanded_change_owner/
AND
/security/read/ (in the permission set containing the security role to which the certificate owner will be set)

In addition, the method checks the following to determine whether the user has permissions to change owner on the specified certificate ID:

For Change Owner permission:

  • The security role(s) assigned to the requesting user
  • The current certificate owner assigned to the certificate, if any

For Expanded Change Owner permission:

  • The permission set(s) associated with the user's role(s)
  • The permission set(s) associated with the certificate owner role, if defined

The change owner action succeeds only if all applicable permission checks pass.

See Change Owner and Certificates for more information about change owner permissions.

Permissions for certificates can be configured at multiple levels. You can apply them system-wide—for all certificates or all certificate stores—or use fine-grained control by assigning permissions at the certificate collectionClosed 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). or certificate store container level. The appropriate level depends on how the certificates are accessed. See Certificate Collection Permissions and Container Permissions for more information about system-wide versus more targeted permission models.

Table 317: 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 optional integer that specifies the certificate collection (CollectionId) to validate whether the user has sufficient permissions to perform the action. If a CollectionId is not provided, the user must have appropriate permissions granted system-wide or via certificate store containers.

Providing a CollectionId allows the system to check the user's permissions at the certificate collection level. Permissions are evaluated in the following order:

  1. System-wide certificate permissions
  2. Granular certificate permissions

Use either ContainerId or CollectionId, not both. If both are specified, CollectionId takes precedence, and the ContainerId is ignored (defaults to 0).

See Certificate Collection Permissions for more information.
ContainerId Query

An optional integer that specifies the certificate store container (ContainerId) to validate whether the user has sufficient permissions to perform the action. If a ContainerId is not provided, the user must have appropriate permissions granted system-wide or via certificate collections.

Providing a ContainerId allows the system to check the user's permissions at the container level. Permissions are evaluated in the following order:

  1. System-wide certificate permissions
  2. System-wide certificate store container permissions
  3. Granular certificate store container permissions

Use either ContainerId or CollectionId, not both. If both are specified, CollectionId takes precedence, and the ContainerId is ignored (defaults to 0).

See Container Permissions for more information.
NewRoleId Body

An integer indicating the Keyfactor Command reference ID of the security role to assign as the certificate owner. Set this value to null to clear an existing certificate owner. The value cannot be unset if the enrollment pattern 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 to assign 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 enrollment pattern 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.
Tip:  See the Keyfactor API Reference and Utility which provides a utility through which the Keyfactor APIClosed 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 workflowClosed 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.