DELETE Security Roles ID Claims (v2)

The DELETE /Security/Roles/{id}/Claims operation disassociates claims from the security role with the specified ID. This operation removes the claims from the role but does not delete the claims from Keyfactor Command. On success, the operation returns 204 with no content.

Requests are processed with configurable retry and timeout settings. Failed requests may be retried up to the configured number of attempts. If all retries are exhausted, a 409 Conflict response is returned. Requests that time out return a 408 response. Concurrent request conflicts also return 409 responses. Retry behavior and timeouts are configurable via appsettings.json (see 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. appsetting.json File).

Note:  This operation is available only in Version 2 and does not have a Version 1 equivalent.
Tip:  The following permissions (see Security Roles and Claims) are required to use this feature:

/security/modify/

The user must hold a role containing this permission in the Global Permission Set (see Permission Sets).

Table 829: DELETE Security Roles {id} Claims Input Parameters

Name

In

 Description
id Path Required. The Keyfactor Command reference ID of the security role from which to remove security claims.

Use the GET Security Roles operation to retrieve a list of all the security roles to determine the role's ID.
Claims Body

An array of objects defining the claims to remove from the specified security role. ClosedShow claim details.

Table 830: DELETE Security Roles {id} Claims Response Data

Name

Description
Id

An integer containing the Keyfactor Command identifier for the security role.
Name A string containing the short reference name for the security role.
Description A string containing the description for the security role.
EmailAddress A string containing an email address for the role. This address can be used from workflows to direct email messages to the owner of certificates for uses such as certificate expiration alerts (assuming the certificate owner for the certificates, a security role, has been populated)
Immutable A Boolean indicating if the role is immutable or not. Only the built-in Administrators role is considered immutable. The value of this parameter cannot be changed.
Permission SetId

A string containing the Keyfactor Command reference GUID of the permission set to which the role is assigned (see Permission Sets).

Tip:  For details of the permissions associated with the role, use the GET Security Roles ID operation for the desired role. For details of the permissions associated withe the permission set to which the role belongs, use the GET Permission Sets ID operation with this permission set GUID. A role may be only granted a subset of the permissions available in a permission set.
Enable Cert Ownership A Boolean indicating if the role can be assigned as a certificate owner (True or False). If this security role is expected to be an owner of any certificate, this flag must be True. If this value is set to False, this role will not appear when trying to assign an owner to a certificate.
Permissions

An array of strings containing the permissions assigned to the role in a comma-separated list of Name:Value pairs. See Security Structure for an overview of the possible permissions.

For example:

Copy 
"Permissions": [  
   "/portal/read/",
   "/dashboard/read/",
   "/certificates/collections/metadata/modify/6/",
   "/certificates/collections/private_key/read/6/"
],
Claims

An array of objects containing the claims associated with the role. ClosedShow claim details.
Tip:  See the Keyfactor API Reference and Utility, which allows you to call API operations and view results. It is primarily intended 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, and also serves as an interactive supplement to this API documentation. You can access it from the help menu () in the Management Portal.