GET Security Roles ID

The GET /Security/Roles/{id} method is used to return a security role by ID. This method returns HTTP 200 OK on a success with details for the specified security roles.

Tip:  The following permissions (see Security Overview) are required to use this feature:

SecuritySettings: Read

Table 469: GET Security Roles {id} Input Parameters

Name In Description
id Path

Required. The Keyfactor Command reference ID of the security role to retrieve.

Use the GET /Security/Roles method (see GET Security Roles) to retrieve a list of all the security roles to determine the role's ID.

Table 470: GET Security Roles {id} 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.
Enabled

A Boolean that indicates whether the security role is enabled (true) or not (false). Security roles that have been disabled cannot be assigned to security identities. The default is true.

This is considered deprecated and may be removed in a future release.
Immutable A Boolean that indicates whether the security role has been marked as editable (true) or not (false). Internal Keyfactor Command roles are not editable. This setting is reserved for Keyfactor Command internal use.
Valid A Boolean that indicates whether the security role's audit XML is valid (true) or not (false). A security role may become invalid if Keyfactor Command determines that it appears to have been tampered with. This setting is not end-user configurable.
Private

A Boolean that indicates whether the security role has been marked private (true) or not (false). The default is false.

This is considered deprecated and may be removed in a future release.
Identities

An array containing information about the security identities assigned to the security role. ClosedShow identity details.
Permissions

An object containing the permissions assigned to the role in a comma-separated list of Name:Value pairs.

For example:

"Permissions": [
   "AdminPortal:Read",
   "Dashboard:Read"
],
Tip:  For code examples, see the Keyfactor API Endpoint Utility. To find the embedded web copy of this utility, click the help icon () at the top of the Keyfactor Command Management Portal page next to the Log Out button.