SecurityRolePermissionsApi

All URIs are relative to https://192.168.78.139/KeyfactorAPI

Method	HTTP request	Description
securityRolePermissionsAddCollectionPermissions	POST /Security/Roles/{id}/Permissions/Collections	Adds collection permissions to the security role that matches the id.
securityRolePermissionsAddContainerPermissions	POST /Security/Roles/{id}/Permissions/Containers	Adds container permissions to the security role that matches the id.
securityRolePermissionsAddGlobalPermissions	POST /Security/Roles/{id}/Permissions/Global	Adds global permissions to the security role that matches the id.
securityRolePermissionsGetCollectionPermissionsForRole	GET /Security/Roles/{id}/Permissions/Collections	Returns all collection permissions associated with the security role that matches the id.
securityRolePermissionsGetContainerPermissionsForRole	GET /Security/Roles/{id}/Permissions/Containers	Returns all container permissions associated with the security role that matches the id.
securityRolePermissionsGetGlobalPermissionsForRole	GET /Security/Roles/{id}/Permissions/Global	Returns all global permissions associated with the security role that matches the id.
securityRolePermissionsGetPermissionsForRole	GET /Security/Roles/{id}/Permissions	Returns all permissions associated with the security role that matches the id.
securityRolePermissionsSetCollectionPermissions	PUT /Security/Roles/{id}/Permissions/Collections	Sets collection permissions to the security role that matches the id.
securityRolePermissionsSetContainerPermissions	PUT /Security/Roles/{id}/Permissions/Containers	Sets container permissions to the security role that matches the id.
securityRolePermissionsSetGlobalPermissions	PUT /Security/Roles/{id}/Permissions/Global	Adds global permissions to the security role that matches the id.

securityRolePermissionsAddCollectionPermissions

List<KeyfactorApiModelsSecurityRolesIdentitiesSecurityRolesCollectionPermissionResponse> securityRolePermissionsAddCollectionPermissions(id, xKeyfactorRequestedWith, collectionPermissions, xKeyfactorApiVersion)

Adds collection permissions to the security role that matches the id.

Valid Permissions ### | Permission | Permission Display Name | |---------------|---------------------------| | Read | Read | | EditMetadata | Edit Metadata | | Recover | Download with Private Key | | Revoke | Revoke | | Delete | Delete |

Example

// Import classes:
import com.keyfactor.command.client.ApiClient;
import com.keyfactor.command.client.ApiException;
import com.keyfactor.command.client.Configuration;
import com.keyfactor.command.client.auth.*;
import com.keyfactor.command.client.models.*;
import com.keyfactor.command.client.api.SecurityRolePermissionsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://192.168.78.139/KeyfactorAPI");
    
    // Configure HTTP basic authorization: basicAuth
    HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
    basicAuth.setUsername("YOUR USERNAME");
    basicAuth.setPassword("YOUR PASSWORD");

    SecurityRolePermissionsApi apiInstance = new SecurityRolePermissionsApi(defaultClient);
    Integer id = 56; // Integer | Security role identifier
    String xKeyfactorRequestedWith = "APIClient"; // String | Type of the request [XMLHttpRequest, APIClient]
    List<KeyfactorApiModelsSecurityRolesIdentitiesSecurityRolesCollectionPermissionRequest> collectionPermissions = Arrays.asList(); // List<KeyfactorApiModelsSecurityRolesIdentitiesSecurityRolesCollectionPermissionRequest> | Collections permissions
    String xKeyfactorApiVersion = "1"; // String | Desired version of the api, if not provided defaults to v1
    try {
      List<KeyfactorApiModelsSecurityRolesIdentitiesSecurityRolesCollectionPermissionResponse> result = apiInstance.securityRolePermissionsAddCollectionPermissions(id, xKeyfactorRequestedWith, collectionPermissions, xKeyfactorApiVersion);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling SecurityRolePermissionsApi#securityRolePermissionsAddCollectionPermissions");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
id	Integer	Security role identifier
xKeyfactorRequestedWith	String	Type of the request [XMLHttpRequest, APIClient]	[default to APIClient]
collectionPermissions	List<KeyfactorApiModelsSecurityRolesIdentitiesSecurityRolesCollectionPermissionRequest>	Collections permissions
xKeyfactorApiVersion	String	Desired version of the api, if not provided defaults to v1	[optional] [default to 1]

Return type

List<KeyfactorApiModelsSecurityRolesIdentitiesSecurityRolesCollectionPermissionResponse>

Authorization

basicAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

securityRolePermissionsAddContainerPermissions

List<KeyfactorApiModelsSecurityRolesContainerPermissionResponse> securityRolePermissionsAddContainerPermissions(id, xKeyfactorRequestedWith, containerPermissions, xKeyfactorApiVersion)

Adds container permissions to the security role that matches the id.

Valid Permissions ### | Permission | Requisite Permissions | |---------------|-----------------------| | Read | | | Schedule | Read | | Modify | Read, Schedule |

Example

// Import classes:
import com.keyfactor.command.client.ApiClient;
import com.keyfactor.command.client.ApiException;
import com.keyfactor.command.client.Configuration;
import com.keyfactor.command.client.auth.*;
import com.keyfactor.command.client.models.*;
import com.keyfactor.command.client.api.SecurityRolePermissionsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://192.168.78.139/KeyfactorAPI");
    
    // Configure HTTP basic authorization: basicAuth
    HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
    basicAuth.setUsername("YOUR USERNAME");
    basicAuth.setPassword("YOUR PASSWORD");

    SecurityRolePermissionsApi apiInstance = new SecurityRolePermissionsApi(defaultClient);
    Integer id = 56; // Integer | Security role identifier
    String xKeyfactorRequestedWith = "APIClient"; // String | Type of the request [XMLHttpRequest, APIClient]
    List<KeyfactorApiModelsSecurityRolesContainerPermissionRequest> containerPermissions = Arrays.asList(); // List<KeyfactorApiModelsSecurityRolesContainerPermissionRequest> | Container permissions
    String xKeyfactorApiVersion = "1"; // String | Desired version of the api, if not provided defaults to v1
    try {
      List<KeyfactorApiModelsSecurityRolesContainerPermissionResponse> result = apiInstance.securityRolePermissionsAddContainerPermissions(id, xKeyfactorRequestedWith, containerPermissions, xKeyfactorApiVersion);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling SecurityRolePermissionsApi#securityRolePermissionsAddContainerPermissions");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
id	Integer	Security role identifier
xKeyfactorRequestedWith	String	Type of the request [XMLHttpRequest, APIClient]	[default to APIClient]
containerPermissions	List<KeyfactorApiModelsSecurityRolesContainerPermissionRequest>	Container permissions
xKeyfactorApiVersion	String	Desired version of the api, if not provided defaults to v1	[optional] [default to 1]

Return type

List<KeyfactorApiModelsSecurityRolesContainerPermissionResponse>

Authorization

basicAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

securityRolePermissionsAddGlobalPermissions

List<KeyfactorApiModelsSecurityRolesIdentitiesSecurityRolesGlobalPermissionResponse> securityRolePermissionsAddGlobalPermissions(id, xKeyfactorRequestedWith, globalPermissions, xKeyfactorApiVersion)

Adds global permissions to the security role that matches the id.

Valid Global Permissions ### | Area | Permission | |-------------------------------|-------------------| | AdminPortal | Read | | AgentAutoRegistration | Read | | AgentAutoRegistration | Modify | | AgentManagement | Read | | AgentManagement | Modify | | API | Read | | ApplicationSettings | Read | | ApplicationSettings | Modify | | Auditing | Read | | CertificateCollections | Modify | | CertificateEnrollment | EnrollPFX | | CertificateEnrollment | EnrollCSR | | CertificateEnrollment | CsrGeneration | | CertificateEnrollment | PendingCsr | | CertificateMetadataTypes | Read | | CertificateMetadataTypes | Modify | | Certificates | Read | | Certificates | EditMetadata | | Certificates | Import | | Certificates | Recover | | Certificates | Revoke | | Certificates | Delete | | Certificates | ImportPrivateKey | | CertificateStoreManagement | Read | | CertificateStoreManagement | Schedule | | CertificateStoreManagement | Modify | | Dashboard | Read | | Dashboard | RiskHeader | | EventHandlerRegistration | Read | | EventHandlerRegistration | Modify | | MacAutoEnrollManagement | Read | | MacAutoEnrollManagement | Modify | | Monitoring | Read | | Monitoring | Modify | | Monitoring | Test | | PkiManagement | Read | | PkiManagement | Modify | | PrivilegedAccessManagement | Read | | PrivilegedAccessManagement | Modify | | Reports | Read | | Reports | Modify | | SecuritySettings | Read | | SecuritySettings | Modify | | SSH | User | | SSH | ServerAdmin | | SSH | EnterpriseAdmin | | SslManagement | Read | | SslManagement | Modify | | SystemSettings | Read | | SystemSettings | Modify | | WorkflowDefinitions | Read | | WorkflowDefinitions | Modify | | WorkflowInstances | ReadAll | | WorkflowInstances | ReadAssignedToMe | | WorkflowInstances | ReadMy | | WorkflowInstances | Manage | | WorkflowManagement | Read | | WorkflowManagement | Modify | | WorkflowManagement | Test | | WorkflowManagement | Participate | | WorkflowManagement | Manage |

Example

// Import classes:
import com.keyfactor.command.client.ApiClient;
import com.keyfactor.command.client.ApiException;
import com.keyfactor.command.client.Configuration;
import com.keyfactor.command.client.auth.*;
import com.keyfactor.command.client.models.*;
import com.keyfactor.command.client.api.SecurityRolePermissionsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://192.168.78.139/KeyfactorAPI");
    
    // Configure HTTP basic authorization: basicAuth
    HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
    basicAuth.setUsername("YOUR USERNAME");
    basicAuth.setPassword("YOUR PASSWORD");

    SecurityRolePermissionsApi apiInstance = new SecurityRolePermissionsApi(defaultClient);
    Integer id = 56; // Integer | Security role identifier
    String xKeyfactorRequestedWith = "APIClient"; // String | Type of the request [XMLHttpRequest, APIClient]
    List<KeyfactorApiModelsSecurityRolesIdentitiesSecurityRolesGlobalPermissionRequest> globalPermissions = Arrays.asList(); // List<KeyfactorApiModelsSecurityRolesIdentitiesSecurityRolesGlobalPermissionRequest> | Global permissions
    String xKeyfactorApiVersion = "1"; // String | Desired version of the api, if not provided defaults to v1
    try {
      List<KeyfactorApiModelsSecurityRolesIdentitiesSecurityRolesGlobalPermissionResponse> result = apiInstance.securityRolePermissionsAddGlobalPermissions(id, xKeyfactorRequestedWith, globalPermissions, xKeyfactorApiVersion);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling SecurityRolePermissionsApi#securityRolePermissionsAddGlobalPermissions");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
id	Integer	Security role identifier
xKeyfactorRequestedWith	String	Type of the request [XMLHttpRequest, APIClient]	[default to APIClient]
globalPermissions	List<KeyfactorApiModelsSecurityRolesIdentitiesSecurityRolesGlobalPermissionRequest>	Global permissions
xKeyfactorApiVersion	String	Desired version of the api, if not provided defaults to v1	[optional] [default to 1]

Return type

List<KeyfactorApiModelsSecurityRolesIdentitiesSecurityRolesGlobalPermissionResponse>

Authorization

basicAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

securityRolePermissionsGetCollectionPermissionsForRole

List<KeyfactorApiModelsSecurityRolesIdentitiesSecurityRolesCollectionPermissionResponse> securityRolePermissionsGetCollectionPermissionsForRole(id, xKeyfactorRequestedWith, xKeyfactorApiVersion)

Returns all collection permissions associated with the security role that matches the id.

Example

// Import classes:
import com.keyfactor.command.client.ApiClient;
import com.keyfactor.command.client.ApiException;
import com.keyfactor.command.client.Configuration;
import com.keyfactor.command.client.auth.*;
import com.keyfactor.command.client.models.*;
import com.keyfactor.command.client.api.SecurityRolePermissionsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://192.168.78.139/KeyfactorAPI");
    
    // Configure HTTP basic authorization: basicAuth
    HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
    basicAuth.setUsername("YOUR USERNAME");
    basicAuth.setPassword("YOUR PASSWORD");

    SecurityRolePermissionsApi apiInstance = new SecurityRolePermissionsApi(defaultClient);
    Integer id = 56; // Integer | Security role identifier
    String xKeyfactorRequestedWith = "APIClient"; // String | Type of the request [XMLHttpRequest, APIClient]
    String xKeyfactorApiVersion = "1"; // String | Desired version of the api, if not provided defaults to v1
    try {
      List<KeyfactorApiModelsSecurityRolesIdentitiesSecurityRolesCollectionPermissionResponse> result = apiInstance.securityRolePermissionsGetCollectionPermissionsForRole(id, xKeyfactorRequestedWith, xKeyfactorApiVersion);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling SecurityRolePermissionsApi#securityRolePermissionsGetCollectionPermissionsForRole");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
id	Integer	Security role identifier
xKeyfactorRequestedWith	String	Type of the request [XMLHttpRequest, APIClient]	[default to APIClient]
xKeyfactorApiVersion	String	Desired version of the api, if not provided defaults to v1	[optional] [default to 1]

Return type

List<KeyfactorApiModelsSecurityRolesIdentitiesSecurityRolesCollectionPermissionResponse>

Authorization

basicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json, text/json, application/xml, text/xml

HTTP response details

Status code	Description	Response headers
200	OK	-

securityRolePermissionsGetContainerPermissionsForRole

List<KeyfactorApiModelsSecurityRolesContainerPermissionResponse> securityRolePermissionsGetContainerPermissionsForRole(id, xKeyfactorRequestedWith, xKeyfactorApiVersion)

Returns all container permissions associated with the security role that matches the id.

Example

// Import classes:
import com.keyfactor.command.client.ApiClient;
import com.keyfactor.command.client.ApiException;
import com.keyfactor.command.client.Configuration;
import com.keyfactor.command.client.auth.*;
import com.keyfactor.command.client.models.*;
import com.keyfactor.command.client.api.SecurityRolePermissionsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://192.168.78.139/KeyfactorAPI");
    
    // Configure HTTP basic authorization: basicAuth
    HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
    basicAuth.setUsername("YOUR USERNAME");
    basicAuth.setPassword("YOUR PASSWORD");

    SecurityRolePermissionsApi apiInstance = new SecurityRolePermissionsApi(defaultClient);
    Integer id = 56; // Integer | Security role identifier
    String xKeyfactorRequestedWith = "APIClient"; // String | Type of the request [XMLHttpRequest, APIClient]
    String xKeyfactorApiVersion = "1"; // String | Desired version of the api, if not provided defaults to v1
    try {
      List<KeyfactorApiModelsSecurityRolesContainerPermissionResponse> result = apiInstance.securityRolePermissionsGetContainerPermissionsForRole(id, xKeyfactorRequestedWith, xKeyfactorApiVersion);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling SecurityRolePermissionsApi#securityRolePermissionsGetContainerPermissionsForRole");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
id	Integer	Security role identifier
xKeyfactorRequestedWith	String	Type of the request [XMLHttpRequest, APIClient]	[default to APIClient]
xKeyfactorApiVersion	String	Desired version of the api, if not provided defaults to v1	[optional] [default to 1]

Return type

List<KeyfactorApiModelsSecurityRolesContainerPermissionResponse>

Authorization

basicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json, text/json, application/xml, text/xml

HTTP response details

Status code	Description	Response headers
200	OK	-

securityRolePermissionsGetGlobalPermissionsForRole

List<KeyfactorApiModelsSecurityRolesIdentitiesSecurityRolesGlobalPermissionResponse> securityRolePermissionsGetGlobalPermissionsForRole(id, xKeyfactorRequestedWith, xKeyfactorApiVersion)

Returns all global permissions associated with the security role that matches the id.

Example

// Import classes:
import com.keyfactor.command.client.ApiClient;
import com.keyfactor.command.client.ApiException;
import com.keyfactor.command.client.Configuration;
import com.keyfactor.command.client.auth.*;
import com.keyfactor.command.client.models.*;
import com.keyfactor.command.client.api.SecurityRolePermissionsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://192.168.78.139/KeyfactorAPI");
    
    // Configure HTTP basic authorization: basicAuth
    HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
    basicAuth.setUsername("YOUR USERNAME");
    basicAuth.setPassword("YOUR PASSWORD");

    SecurityRolePermissionsApi apiInstance = new SecurityRolePermissionsApi(defaultClient);
    Integer id = 56; // Integer | Security role identifier
    String xKeyfactorRequestedWith = "APIClient"; // String | Type of the request [XMLHttpRequest, APIClient]
    String xKeyfactorApiVersion = "1"; // String | Desired version of the api, if not provided defaults to v1
    try {
      List<KeyfactorApiModelsSecurityRolesIdentitiesSecurityRolesGlobalPermissionResponse> result = apiInstance.securityRolePermissionsGetGlobalPermissionsForRole(id, xKeyfactorRequestedWith, xKeyfactorApiVersion);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling SecurityRolePermissionsApi#securityRolePermissionsGetGlobalPermissionsForRole");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
id	Integer	Security role identifier
xKeyfactorRequestedWith	String	Type of the request [XMLHttpRequest, APIClient]	[default to APIClient]
xKeyfactorApiVersion	String	Desired version of the api, if not provided defaults to v1	[optional] [default to 1]

Return type

List<KeyfactorApiModelsSecurityRolesIdentitiesSecurityRolesGlobalPermissionResponse>

Authorization

basicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json, text/json, application/xml, text/xml

HTTP response details

Status code	Description	Response headers
200	OK	-

securityRolePermissionsGetPermissionsForRole

List<KeyfactorApiModelsSecurityRolesAreaPermissionResponse> securityRolePermissionsGetPermissionsForRole(id, xKeyfactorRequestedWith, xKeyfactorApiVersion)

Returns all permissions associated with the security role that matches the id.

Example

// Import classes:
import com.keyfactor.command.client.ApiClient;
import com.keyfactor.command.client.ApiException;
import com.keyfactor.command.client.Configuration;
import com.keyfactor.command.client.auth.*;
import com.keyfactor.command.client.models.*;
import com.keyfactor.command.client.api.SecurityRolePermissionsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://192.168.78.139/KeyfactorAPI");
    
    // Configure HTTP basic authorization: basicAuth
    HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
    basicAuth.setUsername("YOUR USERNAME");
    basicAuth.setPassword("YOUR PASSWORD");

    SecurityRolePermissionsApi apiInstance = new SecurityRolePermissionsApi(defaultClient);
    Integer id = 56; // Integer | Security role identifier
    String xKeyfactorRequestedWith = "APIClient"; // String | Type of the request [XMLHttpRequest, APIClient]
    String xKeyfactorApiVersion = "1"; // String | Desired version of the api, if not provided defaults to v1
    try {
      List<KeyfactorApiModelsSecurityRolesAreaPermissionResponse> result = apiInstance.securityRolePermissionsGetPermissionsForRole(id, xKeyfactorRequestedWith, xKeyfactorApiVersion);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling SecurityRolePermissionsApi#securityRolePermissionsGetPermissionsForRole");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
id	Integer	Security role identifier
xKeyfactorRequestedWith	String	Type of the request [XMLHttpRequest, APIClient]	[default to APIClient]
xKeyfactorApiVersion	String	Desired version of the api, if not provided defaults to v1	[optional] [default to 1]

Return type

List<KeyfactorApiModelsSecurityRolesAreaPermissionResponse>

Authorization

basicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json, text/json, application/xml, text/xml

HTTP response details

Status code	Description	Response headers
200	OK	-

securityRolePermissionsSetCollectionPermissions

List<KeyfactorApiModelsSecurityRolesIdentitiesSecurityRolesCollectionPermissionResponse> securityRolePermissionsSetCollectionPermissions(id, xKeyfactorRequestedWith, collectionPermissions, xKeyfactorApiVersion)

Sets collection permissions to the security role that matches the id.

Valid Permissions ### | Permission | Permission Display Name | |---------------|---------------------------| | Read | Read | | EditMetadata | Edit Metadata | | Recover | Download with Private Key | | Revoke | Revoke | | Delete | Delete |

Example

// Import classes:
import com.keyfactor.command.client.ApiClient;
import com.keyfactor.command.client.ApiException;
import com.keyfactor.command.client.Configuration;
import com.keyfactor.command.client.auth.*;
import com.keyfactor.command.client.models.*;
import com.keyfactor.command.client.api.SecurityRolePermissionsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://192.168.78.139/KeyfactorAPI");
    
    // Configure HTTP basic authorization: basicAuth
    HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
    basicAuth.setUsername("YOUR USERNAME");
    basicAuth.setPassword("YOUR PASSWORD");

    SecurityRolePermissionsApi apiInstance = new SecurityRolePermissionsApi(defaultClient);
    Integer id = 56; // Integer | Security role identifier
    String xKeyfactorRequestedWith = "APIClient"; // String | Type of the request [XMLHttpRequest, APIClient]
    List<KeyfactorApiModelsSecurityRolesIdentitiesSecurityRolesCollectionPermissionRequest> collectionPermissions = Arrays.asList(); // List<KeyfactorApiModelsSecurityRolesIdentitiesSecurityRolesCollectionPermissionRequest> | Collections permissions
    String xKeyfactorApiVersion = "1"; // String | Desired version of the api, if not provided defaults to v1
    try {
      List<KeyfactorApiModelsSecurityRolesIdentitiesSecurityRolesCollectionPermissionResponse> result = apiInstance.securityRolePermissionsSetCollectionPermissions(id, xKeyfactorRequestedWith, collectionPermissions, xKeyfactorApiVersion);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling SecurityRolePermissionsApi#securityRolePermissionsSetCollectionPermissions");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
id	Integer	Security role identifier
xKeyfactorRequestedWith	String	Type of the request [XMLHttpRequest, APIClient]	[default to APIClient]
collectionPermissions	List<KeyfactorApiModelsSecurityRolesIdentitiesSecurityRolesCollectionPermissionRequest>	Collections permissions
xKeyfactorApiVersion	String	Desired version of the api, if not provided defaults to v1	[optional] [default to 1]

Return type

List<KeyfactorApiModelsSecurityRolesIdentitiesSecurityRolesCollectionPermissionResponse>

Authorization

basicAuth

HTTP request headers

Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Accept: application/json, text/json, application/xml, text/xml

HTTP response details

Status code	Description	Response headers
200	OK	-

securityRolePermissionsSetContainerPermissions

List<KeyfactorApiModelsSecurityRolesContainerPermissionResponse> securityRolePermissionsSetContainerPermissions(id, xKeyfactorRequestedWith, containerPermissions, xKeyfactorApiVersion)

Sets container permissions to the security role that matches the id.

Valid Permissions ### | Permission | Requisite Permissions | |---------------|-----------------------| | Read | | | Schedule | Read | | Modify | Read, Schedule |

Example

// Import classes:
import com.keyfactor.command.client.ApiClient;
import com.keyfactor.command.client.ApiException;
import com.keyfactor.command.client.Configuration;
import com.keyfactor.command.client.auth.*;
import com.keyfactor.command.client.models.*;
import com.keyfactor.command.client.api.SecurityRolePermissionsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://192.168.78.139/KeyfactorAPI");
    
    // Configure HTTP basic authorization: basicAuth
    HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
    basicAuth.setUsername("YOUR USERNAME");
    basicAuth.setPassword("YOUR PASSWORD");

    SecurityRolePermissionsApi apiInstance = new SecurityRolePermissionsApi(defaultClient);
    Integer id = 56; // Integer | Security role identifier
    String xKeyfactorRequestedWith = "APIClient"; // String | Type of the request [XMLHttpRequest, APIClient]
    List<KeyfactorApiModelsSecurityRolesContainerPermissionRequest> containerPermissions = Arrays.asList(); // List<KeyfactorApiModelsSecurityRolesContainerPermissionRequest> | Container permissions
    String xKeyfactorApiVersion = "1"; // String | Desired version of the api, if not provided defaults to v1
    try {
      List<KeyfactorApiModelsSecurityRolesContainerPermissionResponse> result = apiInstance.securityRolePermissionsSetContainerPermissions(id, xKeyfactorRequestedWith, containerPermissions, xKeyfactorApiVersion);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling SecurityRolePermissionsApi#securityRolePermissionsSetContainerPermissions");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
id	Integer	Security role identifier
xKeyfactorRequestedWith	String	Type of the request [XMLHttpRequest, APIClient]	[default to APIClient]
containerPermissions	List<KeyfactorApiModelsSecurityRolesContainerPermissionRequest>	Container permissions
xKeyfactorApiVersion	String	Desired version of the api, if not provided defaults to v1	[optional] [default to 1]

Return type

List<KeyfactorApiModelsSecurityRolesContainerPermissionResponse>

Authorization

basicAuth

HTTP request headers

Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Accept: application/json, text/json, application/xml, text/xml

HTTP response details

Status code	Description	Response headers
200	OK	-

securityRolePermissionsSetGlobalPermissions

List<KeyfactorApiModelsSecurityRolesIdentitiesSecurityRolesGlobalPermissionResponse> securityRolePermissionsSetGlobalPermissions(id, xKeyfactorRequestedWith, globalPermissions, xKeyfactorApiVersion)

Adds global permissions to the security role that matches the id.

Valid Global Permissions ### | Area | Permission | |-------------------------------|-------------------| | AdminPortal | Read | | AgentAutoRegistration | Read | | AgentAutoRegistration | Modify | | AgentManagement | Read | | AgentManagement | Modify | | API | Read | | ApplicationSettings | Read | | ApplicationSettings | Modify | | Auditing | Read | | CertificateCollections | Modify | | CertificateEnrollment | EnrollPFX | | CertificateEnrollment | EnrollCSR | | CertificateEnrollment | CsrGeneration | | CertificateEnrollment | PendingCsr | | CertificateMetadataTypes | Read | | CertificateMetadataTypes | Modify | | Certificates | Read | | Certificates | EditMetadata | | Certificates | Import | | Certificates | Recover | | Certificates | Revoke | | Certificates | Delete | | Certificates | ImportPrivateKey | | CertificateStoreManagement | Read | | CertificateStoreManagement | Schedule | | CertificateStoreManagement | Modify | | Dashboard | Read | | Dashboard | RiskHeader | | EventHandlerRegistration | Read | | EventHandlerRegistration | Modify | | MacAutoEnrollManagement | Read | | MacAutoEnrollManagement | Modify | | Monitoring | Read | | Monitoring | Modify | | Monitoring | Test | | PkiManagement | Read | | PkiManagement | Modify | | PrivilegedAccessManagement | Read | | PrivilegedAccessManagement | Modify | | Reports | Read | | Reports | Modify | | SecuritySettings | Read | | SecuritySettings | Modify | | SSH | User | | SSH | ServerAdmin | | SSH | EnterpriseAdmin | | SslManagement | Read | | SslManagement | Modify | | SystemSettings | Read | | SystemSettings | Modify | | WorkflowDefinitions | Read | | WorkflowDefinitions | Modify | | WorkflowInstances | ReadAll | | WorkflowInstances | ReadAssignedToMe | | WorkflowInstances | ReadMy | | WorkflowInstances | Manage | | WorkflowManagement | Read | | WorkflowManagement | Modify | | WorkflowManagement | Test | | WorkflowManagement | Participate | | WorkflowManagement | Manage |

Example

// Import classes:
import com.keyfactor.command.client.ApiClient;
import com.keyfactor.command.client.ApiException;
import com.keyfactor.command.client.Configuration;
import com.keyfactor.command.client.auth.*;
import com.keyfactor.command.client.models.*;
import com.keyfactor.command.client.api.SecurityRolePermissionsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://192.168.78.139/KeyfactorAPI");
    
    // Configure HTTP basic authorization: basicAuth
    HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
    basicAuth.setUsername("YOUR USERNAME");
    basicAuth.setPassword("YOUR PASSWORD");

    SecurityRolePermissionsApi apiInstance = new SecurityRolePermissionsApi(defaultClient);
    Integer id = 56; // Integer | Security role identifier
    String xKeyfactorRequestedWith = "APIClient"; // String | Type of the request [XMLHttpRequest, APIClient]
    List<KeyfactorApiModelsSecurityRolesIdentitiesSecurityRolesGlobalPermissionRequest> globalPermissions = Arrays.asList(); // List<KeyfactorApiModelsSecurityRolesIdentitiesSecurityRolesGlobalPermissionRequest> | Global permissions
    String xKeyfactorApiVersion = "1"; // String | Desired version of the api, if not provided defaults to v1
    try {
      List<KeyfactorApiModelsSecurityRolesIdentitiesSecurityRolesGlobalPermissionResponse> result = apiInstance.securityRolePermissionsSetGlobalPermissions(id, xKeyfactorRequestedWith, globalPermissions, xKeyfactorApiVersion);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling SecurityRolePermissionsApi#securityRolePermissionsSetGlobalPermissions");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
id	Integer	Security role identifier
xKeyfactorRequestedWith	String	Type of the request [XMLHttpRequest, APIClient]	[default to APIClient]
globalPermissions	List<KeyfactorApiModelsSecurityRolesIdentitiesSecurityRolesGlobalPermissionRequest>	Global permissions
xKeyfactorApiVersion	String	Desired version of the api, if not provided defaults to v1	[optional] [default to 1]

Return type

List<KeyfactorApiModelsSecurityRolesIdentitiesSecurityRolesGlobalPermissionResponse>

Authorization

basicAuth

HTTP request headers

Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Accept: application/json, text/json, application/xml, text/xml

HTTP response details

Status code	Description	Response headers
200	OK	-

Files

SecurityRolePermissionsApi.md

Latest commit

History

SecurityRolePermissionsApi.md

File metadata and controls

SecurityRolePermissionsApi

securityRolePermissionsAddCollectionPermissions

Valid Permissions ### | Permission | Permission Display Name | |---------------|---------------------------| | Read | Read | | EditMetadata | Edit Metadata | | Recover | Download with Private Key | | Revoke | Revoke | | Delete | Delete |

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

securityRolePermissionsAddContainerPermissions

Valid Permissions ### | Permission | Requisite Permissions | |---------------|-----------------------| | Read | | | Schedule | Read | | Modify | Read, Schedule |

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

securityRolePermissionsAddGlobalPermissions

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

securityRolePermissionsGetCollectionPermissionsForRole

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

securityRolePermissionsGetContainerPermissionsForRole

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

securityRolePermissionsGetGlobalPermissionsForRole

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

securityRolePermissionsGetPermissionsForRole

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

securityRolePermissionsSetCollectionPermissions

Valid Permissions ### | Permission | Permission Display Name | |---------------|---------------------------| | Read | Read | | EditMetadata | Edit Metadata | | Recover | Download with Private Key | | Revoke | Revoke | | Delete | Delete |

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

securityRolePermissionsSetContainerPermissions

Valid Permissions ### | Permission | Requisite Permissions | |---------------|-----------------------| | Read | | | Schedule | Read | | Modify | Read, Schedule |

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

securityRolePermissionsSetGlobalPermissions

Example

Parameters

Return type

Authorization

HTTP request headers