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.
This endpoint An endpoint is a URL that enables the API to gain access to resources on a server. will be found by selecting V2 (Version 2) in the Keyfactor API 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. Reference and Utility. See Versioning.
Version 2 of the GET /Security/Roles/{id} method has been redesigned to provide support for multiple identity providers and the newer claims-based authentication model that accompanies it. This version of the endpoint supports both Active Directory and other identity providers.
Table 601: GET Security Roles {id} v2 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 602: GET Security Roles {id} v2 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. | |||||||||||||||||||||||||||||||||||||||
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 Set Id |
A string containing the Keyfactor Command reference GUID of the permission set to which the role is assigned (see Permission Sets). |
|||||||||||||||||||||||||||||||||||||||
Permissions |
An array of strings containing the permissions assigned to the role in a comma-separated list of Name:Value pairs. See Version Two Permission Model for an overview of the possible permissions. For example: "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.
|