Get compliance profile details

Open in ChatGPT Open in ChatGPT to ask questions about this page
Open in Claude Open in Claude to ask questions about this page
Copy as MarkdownCopy this page as markdown to use with AI assistants
View as Markdown Open this page as markdown in a new tab

Retrieves the complete configuration of a compliance profile, including its metadata and associated rules.

Request URL

https://{server-hostname}:8383/bsp/api/v1/bmp/compliance/{compliance_id}/profiles

Scope

BrowserManager.READCopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/jsonapplication/jsonCopied!

- Path Parameters

compliance_idstringMandatory

Compliance profile ID from List Compliance Profiles response (profileid field)

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomain/bsp/api/v1/bmp/compliance/{compliance_id}/profiles \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

Response Body - application/json
JSON Object
Hide Sub-Attributes
collection_idstring

Collection ID associated with this profile version

profile_namestring

Name of the compliance profile

compliance_detailsJSON Object

Compliance details including attached rule IDs

Show Sub-Attributes
rule_idsarray

Compliance rule IDs from List All Compliance Rules response (rule_id field) attached to this profile

profile_typestring

Profile type code. 64500=Custom, 64501=STIG, 64502=CIS

latest_versionstring

Latest version number of this profile

is_moved_to_trashboolean

Whether the profile has been moved to trash. false indicates active

profile_idstring

Unique identifier of the compliance profile

scopestring

Scope of the profile. 0 indicates organization-wide

latest_published_versionstring

Latest published version number. '--' if never published

profile_descriptionstring

Description of the compliance profile. Can be empty string

- HTTP code 401

Response Body - application/json
JSON Object
Hide Sub-Attributes
errorCodelong

Unauthorized error code returned when authentication credentials are missing, expired, or invalid (authentication=required)

errorMsgstring

Authentication failure reason

- HTTP code 403

Response Body - application/json
JSON Object
Hide Sub-Attributes
errorCodelong

Forbidden error code returned when the authenticated user does not have the required uem-roles (e.g., DataEncryption_Admin or DataEncryptionRecoveryKey_Admin)

errorMsgstring

Message indicating insufficient privileges to access this resource

- HTTP code 404

Response Body - application/json
JSON Object
Hide Sub-Attributes
errormsgstring

Error message returned when the requested compliance profile is not found

- HTTP code 429

Response Body - application/json
JSON Object
Hide Sub-Attributes
errorCodelong

Rate limit error code returned when the API call threshold (configured via threshold/duration in security XML) is exceeded; client is locked out for lock-period minutes

errorMsgstring

Rate limit exceeded message with retry guidance

- HTTP code 500

Response Body - application/json
JSON Object
Hide Sub-Attributes
error_descriptionstring

Message describing the server-side failure

error_codestring

Internal server error code

Possible Response Codes

200HTTP code
401HTTP code
403HTTP code
404HTTP code
429HTTP code
500HTTP code

Sample Response: HTTP 200

Profile details

Copied!
  {
    "collection_id": "222",
    "profile_name": "FileActivityFilter 16",
    "compliance_details": {
      "rule_ids": [
        4,
        5,
        20,
        21,
        40,
        56,
        57,
        58,
        65,
        66,
        67,
        68
      ]
    },
    "profile_type": "64005",
    "latest_version": "1",
    "is_moved_to_trash": false,
    "profile_id": "111",
    "scope": "0",
    "latest_published_version": "--",
    "profile_description": ""
  }
                
Show full

Sample Response: HTTP 401

Unauthorized

Copied!
  {
    "errorCode": "UNAUTHORIZED",
    "errorMsg": "You are not authorized to perform this action"
  }
                
Show full

Sample Response: HTTP 403

Forbidden

Copied!
  {
    "errorCode": "FORBIDDEN",
    "errorMsg": "You do not have permission to access this resource"
  }
                
Show full

Sample Response: HTTP 404

Profile not found

Copied!
  {
    "errormsg": "Profile not found"
  }
                
Show full

Sample Response: HTTP 429

Rate limit exceeded

Copied!
  {
    "errorCode": "RATE_LIMIT_EXCEEDED",
    "errorMsg": "You have exceeded the maximum number of API calls. Please try again later."
  }
                
Show full

Sample Response: HTTP 500

Server error

Copied!
  {
    "error_description": "Internal Server error, Please try again in a moment.",
    "error_code": "COM0004"
  }
                
Show full

Duration: 1 minute | Threshold: 60 | Lock period: 5 minutes

Duration - Time window for the threshold.
Threshold - Number of API calls allowed within the specified duration.
Lock Period - Wait time before consecutive API requests.