Security and Compliance Center CLI Reference

Example

ibmcloud security-compliance
    --region=us-south.compliance \
    --instance-id=instance_id \
    --output=json \
    --jmes-query="[:10]" \
    --quiet

Note: This example only demonstrates the global options available to all sub-commands and is not a valid command itself.

Command options

--x-correlation-id (string)

The supplied or generated value of this header is logged for a request and repeated in a response header for the corresponding response. The same value is used for downstream requests and retries of those requests. If a value of this headers is not supplied in a request, the service generates a random (version 4) UUID.

The maximum length is 1024 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9 ,\\-_]+$/.

--x-request-id (string)

The supplied or generated value of this header is logged for a request and repeated in a response header for the corresponding response. The same value is not used for downstream requests and retries of those requests. If a value of this headers is not supplied in a request, the service generates a random (version 4) UUID.

The maximum length is 1024 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9 ,\\-_]+$/.

Example

ibmcloud security-compliance provider-type list \
    --x-correlation-id=exampleString \
    --x-request-id=exampleString

Command options

--provider-type-id (string)

The provider type ID. Required.

The maximum length is 36 characters. The minimum length is 32 characters. The value must match regular expression /^[a-zA-Z0-9 ,\\-_]+$/.

--x-correlation-id (string)

The supplied or generated value of this header is logged for a request and repeated in a response header for the corresponding response. The same value is used for downstream requests and retries of those requests. If a value of this headers is not supplied in a request, the service generates a random (version 4) UUID.

The maximum length is 1024 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9 ,\\-_]+$/.

--x-request-id (string)

The supplied or generated value of this header is logged for a request and repeated in a response header for the corresponding response. The same value is not used for downstream requests and retries of those requests. If a value of this headers is not supplied in a request, the service generates a random (version 4) UUID.

The maximum length is 1024 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9 ,\\-_]+$/.

Example

ibmcloud security-compliance provider-type get \
    --provider-type-id=exampleString \
    --x-correlation-id=exampleString \
    --x-request-id=exampleString

Command options

--provider-type-id (string)

The provider type ID. Required.

The maximum length is 36 characters. The minimum length is 32 characters. The value must match regular expression /^[a-zA-Z0-9 ,\\-_]+$/.

--x-correlation-id (string)

The supplied or generated value of this header is logged for a request and repeated in a response header for the corresponding response. The same value is used for downstream requests and retries of those requests. If a value of this headers is not supplied in a request, the service generates a random (version 4) UUID.

The maximum length is 1024 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9 ,\\-_]+$/.

--x-request-id (string)

The supplied or generated value of this header is logged for a request and repeated in a response header for the corresponding response. The same value is not used for downstream requests and retries of those requests. If a value of this headers is not supplied in a request, the service generates a random (version 4) UUID.

The maximum length is 1024 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9 ,\\-_]+$/.

Example

ibmcloud security-compliance provider-type instances \
    --provider-type-id=exampleString \
    --x-correlation-id=exampleString \
    --x-request-id=exampleString

Command options

--provider-type-id (string)

The provider type ID. Required.

The maximum length is 36 characters. The minimum length is 32 characters. The value must match regular expression /^[a-zA-Z0-9 ,\\-_]+$/.

--name (string)

The provider type instance name.

The maximum length is 64 characters. The minimum length is 1 character. The value must match regular expression /[A-Za-z0-9]+/.

--attributes (generic map)

The attributes for connecting to the provider type instance.

Provide a JSON string option or specify a JSON file to read from by providing a filepath option that begins with a @, e.g. --attributes=@path/to/file.json.

--x-correlation-id (string)

The supplied or generated value of this header is logged for a request and repeated in a response header for the corresponding response. The same value is used for downstream requests and retries of those requests. If a value of this headers is not supplied in a request, the service generates a random (version 4) UUID.

The maximum length is 1024 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9 ,\\-_]+$/.

--x-request-id (string)

The supplied or generated value of this header is logged for a request and repeated in a response header for the corresponding response. The same value is not used for downstream requests and retries of those requests. If a value of this headers is not supplied in a request, the service generates a random (version 4) UUID.

The maximum length is 1024 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9 ,\\-_]+$/.

Example

ibmcloud security-compliance provider-type-instance create \
    --provider-type-id=exampleString \
    --name=workload-protection-instance-1 \
    --attributes='{"anyKey": "anyValue"}' \
    --x-correlation-id=exampleString \
    --x-request-id=exampleString

Command options

--provider-type-id (string)

The provider type ID. Required.

The maximum length is 36 characters. The minimum length is 32 characters. The value must match regular expression /^[a-zA-Z0-9 ,\\-_]+$/.

--provider-type-instance-id (string)

The provider type instance ID. Required.

The maximum length is 36 characters. The minimum length is 32 characters. The value must match regular expression /^[a-zA-Z0-9 ,\\-_]+$/.

--x-correlation-id (string)

The supplied or generated value of this header is logged for a request and repeated in a response header for the corresponding response. The same value is used for downstream requests and retries of those requests. If a value of this headers is not supplied in a request, the service generates a random (version 4) UUID.

The maximum length is 1024 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9 ,\\-_]+$/.

--x-request-id (string)

The supplied or generated value of this header is logged for a request and repeated in a response header for the corresponding response. The same value is not used for downstream requests and retries of those requests. If a value of this headers is not supplied in a request, the service generates a random (version 4) UUID.

The maximum length is 1024 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9 ,\\-_]+$/.

Example

ibmcloud security-compliance provider-type-instance delete \
    --provider-type-id=exampleString \
    --provider-type-instance-id=exampleString \
    --x-correlation-id=exampleString \
    --x-request-id=exampleString

Command options

--provider-type-id (string)

The provider type ID. Required.

The maximum length is 36 characters. The minimum length is 32 characters. The value must match regular expression /^[a-zA-Z0-9 ,\\-_]+$/.

--provider-type-instance-id (string)

The provider type instance ID. Required.

The maximum length is 36 characters. The minimum length is 32 characters. The value must match regular expression /^[a-zA-Z0-9 ,\\-_]+$/.

--x-correlation-id (string)

The supplied or generated value of this header is logged for a request and repeated in a response header for the corresponding response. The same value is used for downstream requests and retries of those requests. If a value of this headers is not supplied in a request, the service generates a random (version 4) UUID.

The maximum length is 1024 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9 ,\\-_]+$/.

--x-request-id (string)

The supplied or generated value of this header is logged for a request and repeated in a response header for the corresponding response. The same value is not used for downstream requests and retries of those requests. If a value of this headers is not supplied in a request, the service generates a random (version 4) UUID.

The maximum length is 1024 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9 ,\\-_]+$/.

Example

ibmcloud security-compliance provider-type-instance get \
    --provider-type-id=exampleString \
    --provider-type-instance-id=exampleString \
    --x-correlation-id=exampleString \
    --x-request-id=exampleString

Command options

--provider-type-id (string)

The provider type ID. Required.

The maximum length is 36 characters. The minimum length is 32 characters. The value must match regular expression /^[a-zA-Z0-9 ,\\-_]+$/.

--provider-type-instance-id (string)

The provider type instance ID. Required.

The maximum length is 36 characters. The minimum length is 32 characters. The value must match regular expression /^[a-zA-Z0-9 ,\\-_]+$/.

--name (string)

The provider type instance name.

The maximum length is 64 characters. The minimum length is 1 character. The value must match regular expression /[A-Za-z0-9]+/.

--attributes (generic map)

The attributes for connecting to the provider type instance.

Provide a JSON string option or specify a JSON file to read from by providing a filepath option that begins with a @, e.g. --attributes=@path/to/file.json.

--x-correlation-id (string)

The supplied or generated value of this header is logged for a request and repeated in a response header for the corresponding response. The same value is used for downstream requests and retries of those requests. If a value of this headers is not supplied in a request, the service generates a random (version 4) UUID.

The maximum length is 1024 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9 ,\\-_]+$/.

--x-request-id (string)

The supplied or generated value of this header is logged for a request and repeated in a response header for the corresponding response. The same value is not used for downstream requests and retries of those requests. If a value of this headers is not supplied in a request, the service generates a random (version 4) UUID.

The maximum length is 1024 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9 ,\\-_]+$/.

Example

ibmcloud security-compliance provider-type-instance update \
    --provider-type-id=exampleString \
    --provider-type-instance-id=exampleString \
    --name=workload-protection-instance-1 \
    --attributes='{"anyKey": "anyValue"}' \
    --x-correlation-id=exampleString \
    --x-request-id=exampleString

Command options

--x-correlation-id (string)

The supplied or generated value of this header is logged for a request and repeated in a response header for the corresponding response. The same value is used for downstream requests and retries of those requests. If a value of this headers is not supplied in a request, the service generates a random (version 4) UUID.

The maximum length is 1024 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9 ,\\-_]+$/.

--x-request-id (string)

The supplied or generated value of this header is logged for a request and repeated in a response header for the corresponding response. The same value is not used for downstream requests and retries of those requests. If a value of this headers is not supplied in a request, the service generates a random (version 4) UUID.

The maximum length is 1024 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9 ,\\-_]+$/.

Example

ibmcloud security-compliance provider-type-instance list \
    --x-correlation-id=exampleString \
    --x-request-id=exampleString

Command options

--x-correlation-id (string)

The supplied or generated value of this header is logged for a request, and repeated in a response header for the corresponding response. The same value is used for downstream requests and retries of those requests. If a value of this header is not supplied in a request, the service generates a random (version 4) UUID.

The maximum length is 1024 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9 ,\\-_]+$/.

--x-request-id (string)

The supplied or generated value of this header is logged for a request, and repeated in a response header for the corresponding response. The same value is not used for downstream requests and retries of those requests. If a value of this header is not supplied in a request, the service generates a random (version 4) UUID.

The maximum length is 1024 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9 ,\\-_]+$/.

Example

ibmcloud security-compliance setting get \
    --x-correlation-id=1a2b3c4d-5e6f-4a7b-8c9d-e0f1a2b3c4d5 \
    --x-request-id=exampleString

Command options

--event-notifications (EventNotifications)

The Event Notifications settings. This JSON option can instead be provided by setting individual fields with other options. It is mutually exclusive with those options.

Provide a JSON string option or specify a JSON file to read from by providing a filepath option that begins with a @, e.g. --event-notifications=@path/to/file.json.

--object-storage (ObjectStorage)

The Cloud Object Storage settings. This JSON option can instead be provided by setting individual fields with other options. It is mutually exclusive with those options.

Provide a JSON string option or specify a JSON file to read from by providing a filepath option that begins with a @, e.g. --object-storage=@path/to/file.json.

--x-correlation-id (string)

The supplied or generated value of this header is logged for a request, and repeated in a response header for the corresponding response. The same value is used for downstream requests and retries of those requests. If a value of this header is not supplied in a request, the service generates a random (version 4) UUID.

The maximum length is 1024 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9 ,\\-_]+$/.

--x-request-id (string)

The supplied or generated value of this header is logged for a request, and repeated in a response header for the corresponding response. The same value is not used for downstream requests and retries of those requests. If a value of this header is not supplied in a request, the service generates a random (version 4) UUID.

The maximum length is 1024 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9 ,\\-_]+$/.

--event-notifications-instance-crn (string)

The Event Notifications instance CRN. This option provides a value for a sub-field of the JSON option 'event-notifications'. It is mutually exclusive with that option.

The maximum length is 512 characters. The minimum length is 0 characters. The value must match regular expression /^crn:v[0-9](:([A-Za-z0-9-._~!$&'()*+,;=@\/]|%[0-9A-Z]{2})*){8}|$/.

--event-notifications-updated-on (strfmt.DateTime)

The date when the Event Notifications connection was updated. This option provides a value for a sub-field of the JSON option 'event-notifications'. It is mutually exclusive with that option.

--event-notifications-source-id (string)

The connected Security and Compliance Center instance CRN. This option provides a value for a sub-field of the JSON option 'event-notifications'. It is mutually exclusive with that option.

The maximum length is 512 characters. The minimum length is 1 character. The value must match regular expression /([A-Za-z0-9]+(:[A-Za-z0-9]+)+)/.

--event-notifications-source-description (string)

The description of the source of the Event Notifications. This option provides a value for a sub-field of the JSON option 'event-notifications'. It is mutually exclusive with that option.

The default value is This source is used for integration with IBM Cloud Security and Compliance Center.. The maximum length is 512 characters. The minimum length is 1 character.

--event-notifications-source-name (string)

The name of the source of the Event Notifications. This option provides a value for a sub-field of the JSON option 'event-notifications'. It is mutually exclusive with that option.

The default value is compliance. The maximum length is 512 characters. The minimum length is 1 character.

--object-storage-instance-crn (string)

The connected Cloud Object Storage instance CRN. This option provides a value for a sub-field of the JSON option 'object-storage'. It is mutually exclusive with that option.

The maximum length is 512 characters. The minimum length is 0 characters. The value must match regular expression /^crn:v[0-9](:([A-Za-z0-9-._~!$&'()*+,;=@\/]|%[0-9A-Z]{2})*){8}|$/.

--object-storage-bucket (string)

The connected Cloud Object Storage bucket name. This option provides a value for a sub-field of the JSON option 'object-storage'. It is mutually exclusive with that option.

The maximum length is 64 characters. The minimum length is 0 characters. The value must match regular expression /[A-Za-z]+|/.

--object-storage-bucket-location (string)

The connected Cloud Object Storage bucket location. This option provides a value for a sub-field of the JSON option 'object-storage'. It is mutually exclusive with that option.

The maximum length is 32 characters. The minimum length is 0 characters. The value must match regular expression /[A-Za-z]+/.

--object-storage-bucket-endpoint (string)

The connected Cloud Object Storage bucket endpoint. This option provides a value for a sub-field of the JSON option 'object-storage'. It is mutually exclusive with that option.

The maximum length is 512 characters. The minimum length is 1 character. The value must match regular expression /([A-Za-z0-9-]+)/.

--object-storage-updated-on (strfmt.DateTime)

The date when the bucket connection was updated. This option provides a value for a sub-field of the JSON option 'object-storage'. It is mutually exclusive with that option.

Examples

ibmcloud security-compliance setting update \
    --event-notifications='{"instance_crn": "crn:v1:staging:public:event-notifications:us-south:a/ff88f007f9ff4622aac4fbc0eda36255:7199ae60-a214-4dd8-9bf7-ce571de49d01::", "updated_on": "2019-01-01T12:00:00.000Z", "source_id": "crn:v1:staging:public:event-notifications:us-south:a/ff88f007f9ff4622aac4fbc0eda36255:b8b07245-0bbe-4478-b11c-0dce523105fd::", "source_description": "This source is used for integration with IBM Cloud Security and Compliance Center.", "source_name": "compliance"}' \
    --object-storage='{"instance_crn": "crn:v1:staging:public:cloud-object-storage:global:a/ff88f007f9ff4622aac4fbc0eda36255:7199ae60-a214-4dd8-9bf7-ce571de49d01::", "bucket": "px-scan-results", "bucket_location": "us-south", "bucket_endpoint": "exampleString", "updated_on": "2019-01-01T12:00:00.000Z"}' \
    --x-correlation-id=1a2b3c4d-5e6f-4a7b-8c9d-e0f1a2b3c4d5 \
    --x-request-id=exampleString

Alternatively, granular options are available for for the sub-fields of JSON string options:

ibmcloud security-compliance setting update \
    --x-correlation-id=1a2b3c4d-5e6f-4a7b-8c9d-e0f1a2b3c4d5 \
    --x-request-id=exampleString \
    --event-notifications-instance-crn=crn:v1:staging:public:cloud-object-storage:global:a/ff88f007f9ff4622aac4fbc0eda36255:7199ae60-a214-4dd8-9bf7-ce571de49d01:: \
    --event-notifications-updated-on=2019-01-01T12:00:00.000Z \
    --event-notifications-source-id=crn:v1:staging:public:event-notifications:us-south:a/ff88f007f9ff4622aac4fbc0eda36255:b8b07245-0bbe-4478-b11c-0dce523105fd:: \
    --event-notifications-source-description='This source is used for integration with IBM Cloud Security and Compliance Center.' \
    --event-notifications-source-name=compliance \
    --object-storage-instance-crn=exampleString \
    --object-storage-bucket=exampleString \
    --object-storage-bucket-location=exampleString \
    --object-storage-bucket-endpoint=exampleString \
    --object-storage-updated-on=2019-01-01T12:00:00.000Z

Command options

--x-correlation-id (string)

The supplied or generated value of this header is logged for a request, and repeated in a response header for the corresponding response. The same value is used for downstream requests and retries of those requests. If a value of this header is not supplied in a request, the service generates a random (version 4) UUID.

The maximum length is 1024 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9 ,\\-_]+$/.

--x-request-id (string)

The supplied or generated value of this header is logged for a request, and repeated in a response header for the corresponding response. The same value is not used for downstream requests and retries of those requests. If a value of this header is not supplied in a request, the service generates a random (version 4) UUID.

The maximum length is 1024 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9 ,\\-_]+$/.

Example

ibmcloud security-compliance setting post-test-event \
    --x-correlation-id=1a2b3c4d-5e6f-4a7b-8c9d-e0f1a2b3c4d5 \
    --x-request-id=exampleString

Command options

--x-correlation-id (string)

The supplied or generated value of this header is logged for a request and repeated in a response header for the corresponding response. The same value is used for downstream requests and retries of those requests. If a value of this header is not supplied in a request, the service generates a random (version 4) UUID.

The maximum length is 1024 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9 ,\\-_]+$/.

--x-request-id (string)

The supplied or generated value of this header is logged for a request and repeated in a response header for the corresponding response. The same value is not used for downstream requests and retries of those requests. If a value of this header is not supplied in a request, the service generates a random (version 4) UUID.

The maximum length is 1024 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9 ,\\-_]+$/.

--limit (int64)

The field that indicates how many resources to return, unless the response is the last page of resources.

The default value is 50. The maximum value is 100. The minimum value is 0.

--control-library-type (string)

The field that indicate how you want the resources to be filtered by.

The maximum length is 10 characters. The minimum length is 6 characters. The value must match regular expression /custom|predefined/.

--start (string)

Determine what resource to start the page on or after.

The maximum length is 1024 characters. The minimum length is 0 characters. The value must match regular expression /.*/.

--all-pages (bool)

Invoke multiple requests to display all pages of the collection for control-libraries-list-all.

Example

ibmcloud security-compliance control-library list \
    --x-correlation-id=exampleString \
    --x-request-id=exampleString \
    --limit=50 \
    --control-library-type=custom \
    --start=exampleString

Command options

--control-library-name (string)

The control library name. Required.

The maximum length is 64 characters. The minimum length is 2 characters. The value must match regular expression /^[a-zA-Z0-9_\\s\\-]*$/.

--control-library-description (string)

The control library description. Required.

The maximum length is 256 characters. The minimum length is 2 characters. The value must match regular expression /[A-Za-z0-9]+/.

--control-library-type (string)

The control library type. Required.

Allowable values are: predefined, custom.

--controls (ControlsInControlLib[])

The controls. Required.

The maximum length is 1200 items. The minimum length is 0 items.

Provide a JSON string option or specify a JSON file to read from by providing a filepath option that begins with a @, e.g. --controls=@path/to/file.json.

--version-group-label (string)

The version group label.

The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/.

--control-library-version (string)

The control library version.

The maximum length is 64 characters. The minimum length is 5 characters. The value must match regular expression /^[a-zA-Z0-9_\\-.]*$/.

--latest (bool)

The latest control library version.

--controls-count (int64)

The number of controls.

--x-correlation-id (string)

The supplied or generated value of this header is logged for a request and repeated in a response header for the corresponding response. The same value is used for downstream requests and retries of those requests. If a value of this header is not supplied in a request, the service generates a random (version 4) UUID.

The maximum length is 1024 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9 ,\\-_]+$/.

--x-request-id (string)

The supplied or generated value of this header is logged for a request and repeated in a response header for the corresponding response. The same value is not used for downstream requests and retries of those requests. If a value of this header is not supplied in a request, the service generates a random (version 4) UUID.

The maximum length is 1024 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9 ,\\-_]+$/.

Example

ibmcloud security-compliance control-library create \
    --control-library-name='IBM Cloud for Financial Services' \
    --control-library-description='IBM Cloud for Financial Services' \
    --control-library-type=custom \
    --controls='[{"control_name": "SC-7", "control_id": "1fa45e17-9322-4e6c-bbd6-1c51db08e790", "control_description": "Boundary Protection", "control_category": "System and Communications Protection", "control_parent": "exampleString", "control_tags": ["1fa45e17-9322-4e6c-bbd6-1c51db08e790"], "control_specifications": [{"control_specification_id": "5c7d6f88-a92f-4734-9b49-bd22b0900184", "responsibility": "user", "component_id": "iam-identity", "component_name": "exampleString", "environment": "ibm-cloud", "control_specification_description": "IBM cloud", "assessments_count": 38, "assessments": [{"assessment_id": "rule-238a6025-2522-4d36-831b-a32f81f97304", "assessment_method": "ibm-cloud-rule", "assessment_type": "automated", "assessment_description": "Check whether the authorized IP ranges are configured for the account", "parameter_count": 38, "parameters": [{"parameter_name": "session_invalidation_in_seconds", "parameter_display_name": "Sign out due to inactivity in seconds", "parameter_type": "numeric", "parameter_value": "public"}]}]}], "control_docs": {"control_docs_id": "sc-7", "control_docs_type": "ibm-cloud"}, "control_requirement": true, "status": "enabled"}]' \
    --version-group-label=33fc7b80-0fa5-4f16-bbba-1f293f660f0d \
    --control-library-version=1.0.0 \
    --latest=true \
    --controls-count=38 \
    --x-correlation-id=exampleString \
    --x-request-id=exampleString

Command options

--control-libraries-id (string)

The control library ID. Required.

The maximum length is 256 characters. The minimum length is 1 character. The value must match regular expression /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/.

--x-correlation-id (string)

The supplied or generated value of this header is logged for a request and repeated in a response header for the corresponding response. The same value is used for downstream requests and retries of those requests. If a value of this header is not supplied in a request, the service generates a random (version 4) UUID.

The maximum length is 1024 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9 ,\\-_]+$/.

--x-request-id (string)

The supplied or generated value of this header is logged for a request and repeated in a response header for the corresponding response. The same value is not used for downstream requests and retries of those requests. If a value of this header is not supplied in a request, the service generates a random (version 4) UUID.

The maximum length is 1024 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9 ,\\-_]+$/.

Example

ibmcloud security-compliance control-library delete \
    --control-libraries-id=exampleString \
    --x-correlation-id=exampleString \
    --x-request-id=exampleString

Command options

--control-libraries-id (string)

The control library ID. Required.

The maximum length is 256 characters. The minimum length is 1 character. The value must match regular expression /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/.

--x-correlation-id (string)

The supplied or generated value of this header is logged for a request and repeated in a response header for the corresponding response. The same value is used for downstream requests and retries of those requests. If a value of this header is not supplied in a request, the service generates a random (version 4) UUID.

The maximum length is 1024 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9 ,\\-_]+$/.

--x-request-id (string)

The supplied or generated value of this header is logged for a request and repeated in a response header for the corresponding response. The same value is not used for downstream requests and retries of those requests. If a value of this header is not supplied in a request, the service generates a random (version 4) UUID.

The maximum length is 1024 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9 ,\\-_]+$/.

Example

ibmcloud security-compliance control-library get \
    --control-libraries-id=exampleString \
    --x-correlation-id=exampleString \
    --x-request-id=exampleString

Command options

--control-libraries-id (string)

The control library ID. Required.

The maximum length is 256 characters. The minimum length is 1 character. The value must match regular expression /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/.

--id (string)

The control library ID.

The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[a-zA-Z0-9-]*$/.

--account-id (string)

The account ID.

The maximum length is 32 characters. The minimum length is 0 characters. The value must match regular expression /^[a-zA-Z0-9-]*$/.

--control-library-name (string)

The control library name.

The maximum length is 64 characters. The minimum length is 2 characters. The value must match regular expression /^[a-zA-Z0-9_\\s\\-]*$/.

--control-library-description (string)

The control library description.

The maximum length is 256 characters. The minimum length is 2 characters. The value must match regular expression /[A-Za-z0-9]+/.

--control-library-type (string)

The control library type.

Allowable values are: predefined, custom.

--version-group-label (string)

The version group label.

The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/.

--control-library-version (string)

The control library version.

The maximum length is 64 characters. The minimum length is 5 characters. The value must match regular expression /^[a-zA-Z0-9_\\-.]*$/.

--created-on (strfmt.DateTime)

The date when the control library was created.

--created-by (string)

The user who created the control library.

The maximum length is 255 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9-\\.:,_\\s]*$/.

--updated-on (strfmt.DateTime)

The date when the control library was updated.

--updated-by (string)

The user who updated the control library.

The maximum length is 255 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9-\\.:,_\\s]*$/.

--latest (bool)

The latest version of the control library.

--hierarchy-enabled (bool)

The indication of whether hierarchy is enabled for the control library.

--controls-count (int64)

The number of controls.

--control-parents-count (int64)

The number of parent controls in the control library.

--controls (ControlsInControlLib[])

The list of controls in a control library.

The maximum length is 1200 items. The minimum length is 0 items.

Provide a JSON string option or specify a JSON file to read from by providing a filepath option that begins with a @, e.g. --controls=@path/to/file.json.

--x-correlation-id (string)

The supplied or generated value of this header is logged for a request and repeated in a response header for the corresponding response. The same value is used for downstream requests and retries of those requests. If a value of this header is not supplied in a request, the service generates a random (version 4) UUID.

The maximum length is 1024 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9 ,\\-_]+$/.

--x-request-id (string)

The supplied or generated value of this header is logged for a request and repeated in a response header for the corresponding response. The same value is not used for downstream requests and retries of those requests. If a value of this header is not supplied in a request, the service generates a random (version 4) UUID.

The maximum length is 1024 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9 ,\\-_]+$/.

Example

ibmcloud security-compliance control-library update \
    --control-libraries-id=exampleString \
    --id=exampleString \
    --account-id=exampleString \
    --control-library-name='IBM Cloud for Financial Services' \
    --control-library-description='IBM Cloud for Financial Services' \
    --control-library-type=custom \
    --version-group-label=exampleString \
    --control-library-version=1.1.0 \
    --created-on=2019-01-01T12:00:00.000Z \
    --created-by=exampleString \
    --updated-on=2019-01-01T12:00:00.000Z \
    --updated-by=exampleString \
    --latest=true \
    --hierarchy-enabled=true \
    --controls-count=38 \
    --control-parents-count=38 \
    --controls='[{"control_name": "SC-7", "control_id": "1fa45e17-9322-4e6c-bbd6-1c51db08e790", "control_description": "Boundary Protection", "control_category": "System and Communications Protection", "control_parent": "exampleString", "control_tags": ["1fa45e17-9322-4e6c-bbd6-1c51db08e790"], "control_specifications": [{"control_specification_id": "5c7d6f88-a92f-4734-9b49-bd22b0900184", "responsibility": "user", "component_id": "iam-identity", "component_name": "exampleString", "environment": "ibm-cloud", "control_specification_description": "IBM cloud", "assessments_count": 38, "assessments": [{"assessment_id": "rule-238a6025-2522-4d36-831b-a32f81f97304", "assessment_method": "ibm-cloud-rule", "assessment_type": "automated", "assessment_description": "Check whether authorized IP ranges are configured for the account", "parameter_count": 38, "parameters": [{"parameter_name": "session_invalidation_in_seconds", "parameter_display_name": "Sign out due to inactivity in seconds", "parameter_type": "numeric", "parameter_value": "public"}]}]}], "control_docs": {"control_docs_id": "sc-7", "control_docs_type": "ibm-cloud"}, "control_requirement": true, "status": "enabled"}]' \
    --x-correlation-id=exampleString \
    --x-request-id=exampleString

Command options

--profile-id (string)

The profile ID. Required.

The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/.

--x-correlation-id (string)

The supplied or generated value of this header is logged for a request and repeated in a response header for the corresponding response. The same value is used for downstream requests and retries of those requests. If a value of this header is not supplied in a request, the service generates a random (version 4) UUID.

The maximum length is 1024 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9 ,\\-_]+$/.

--x-request-id (string)

The supplied or generated value of this header is logged for a request and repeated in a response header for the corresponding response. The same value is not used for downstream requests and retries of those requests. If a value of this header is not supplied in a request, the service generates a random (version 4) UUID.

The maximum length is 1024 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9 ,\\-_]+$/.

--limit (int64)

The indication of how many resources to return, unless the response is the last page of resources.

The default value is 50. The maximum value is 100. The minimum value is 0.

--start (string)

Determine what resource to start the page on or after.

The maximum length is 1024 characters. The minimum length is 0 characters. The value must match regular expression /.*/.

--all-pages (bool)

Invoke multiple requests to display all pages of the collection for attachments-list.

Example

ibmcloud security-compliance profile attachments \
    --profile-id=exampleString \
    --x-correlation-id=exampleString \
    --x-request-id=exampleString \
    --limit=10 \
    --start=exampleString

Command options

--x-correlation-id (string)

The supplied or generated value of this header is logged for a request, and repeated in a response header for the corresponding response. The same value is used for downstream requests, and retries of those requests. If a value of this header is not supplied in a request, the service generates a random (version 4) UUID.

The maximum length is 1024 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9 ,\\-_]+$/.

--x-request-id (string)

The supplied or generated value of this header is logged for a request and repeated in a response header for the corresponding response. The same value is not used for downstream requests and retries of those requests. If a value of this header is not supplied in a request, the service generates a random (version 4) UUID.

The maximum length is 1024 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9 ,\\-_]+$/.

--limit (int64)

The indication of how many resources to return, unless the response is the last page of resources.

The default value is 50. The maximum value is 100. The minimum value is 0.

--profile-type (string)

The field that indicate how you want the resources to be filtered by.

The maximum length is 10 characters. The minimum length is 6 characters. The value must match regular expression /custom|predefined/.

--start (string)

Determine what resource to start the page on or after.

The maximum length is 1024 characters. The minimum length is 0 characters. The value must match regular expression /.*/.

--all-pages (bool)

Invoke multiple requests to display all pages of the collection for profiles-list-all.

Example

ibmcloud security-compliance profile list \
    --x-correlation-id=exampleString \
    --x-request-id=exampleString \
    --limit=10 \
    --profile-type=custom \
    --start=exampleString

Command options

--profile-name (string)

The name of the profile. Required.

The maximum length is 64 characters. The minimum length is 2 characters. The value must match regular expression /^[a-zA-Z0-9_\\s\\-]*$/.

--profile-description (string)

The description of the profile. Required.

The maximum length is 256 characters. The minimum length is 2 characters. The value must match regular expression /^[a-zA-Z0-9_,'"\\s\\-\\[\\]]+$/.

--profile-type (string)

The profile type. Required.

Allowable values are: predefined, custom.

--controls (ProfileControlsPrototype[])

The controls that are in the profile. Required.

The maximum length is 512 items. The minimum length is 0 items.

Provide a JSON string option or specify a JSON file to read from by providing a filepath option that begins with a @, e.g. --controls=@path/to/file.json.

--default-parameters (DefaultParametersPrototype[])

The default parameters of the profile. Required.

The maximum length is 512 items. The minimum length is 0 items.

Provide a JSON string option or specify a JSON file to read from by providing a filepath option that begins with a @, e.g. --default-parameters=@path/to/file.json.

--x-correlation-id (string)

The supplied or generated value of this header is logged for a request, and repeated in a response header for the corresponding response. The same value is used for downstream requests, and retries of those requests. If a value of this header is not supplied in a request, the service generates a random (version 4) UUID.

The maximum length is 1024 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9 ,\\-_]+$/.

--x-request-id (string)

The supplied or generated value of this header is logged for a request and repeated in a response header for the corresponding response. The same value is not used for downstream requests and retries of those requests. If a value of this header is not supplied in a request, the service generates a random (version 4) UUID.

The maximum length is 1024 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9 ,\\-_]+$/.

Example

ibmcloud security-compliance profile create \
    --profile-name=test_profile1 \
    --profile-description=test_description1 \
    --profile-type=custom \
    --controls='[{"control_library_id": "e98a56ff-dc24-41d4-9875-1e188e2da6cd", "control_id": "1fa45e17-9322-4e6c-bbd6-1c51db08e790"}]' \
    --default-parameters='[{"assessment_type": "Automated", "assessment_id": "rule-a637949b-7e51-46c4-afd4-b96619001bf1", "parameter_name": "session_invalidation_in_seconds", "parameter_default_value": "120", "parameter_display_name": "Sign out due to inactivity in seconds", "parameter_type": "numeric"}]' \
    --x-correlation-id=exampleString \
    --x-request-id=exampleString

Command options

--profile-id (string)

The profile ID. Required.

The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/.

--x-correlation-id (string)

The supplied or generated value of this header is logged for a request and repeated in a response header for the corresponding response. The same value is used for downstream requests and retries of those requests. If a value of this header is not supplied in a request, the service generates a random (version 4) UUID.

The maximum length is 1024 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9 ,\\-_]+$/.

--x-request-id (string)

The supplied or generated value of this header is logged for a request and repeated in a response header for the corresponding response. The same value is not used for downstream requests and retries of those requests. If a value of this header is not supplied in a request, the service generates a random (version 4) UUID.

The maximum length is 1024 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9 ,\\-_]+$/.

Example

ibmcloud security-compliance profile delete \
    --profile-id=exampleString \
    --x-correlation-id=exampleString \
    --x-request-id=exampleString

Command options

--profile-id (string)

The profile ID. Required.

The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/.

--x-correlation-id (string)

The supplied or generated value of this header is logged for a request and repeated in a response header for the corresponding response. The same value is used for downstream requests and retries of those requests. If a value of this header is not supplied in a request, the service generates a random (version 4) UUID.

The maximum length is 1024 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9 ,\\-_]+$/.

--x-request-id (string)

The supplied or generated value of this header is logged for a request and repeated in a response header for the corresponding response. The same value is not used for downstream requests and retries of those requests. If a value of this header is not supplied in a request, the service generates a random (version 4) UUID.

The maximum length is 1024 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9 ,\\-_]+$/.

Example

ibmcloud security-compliance profile get \
    --profile-id=exampleString \
    --x-correlation-id=exampleString \
    --x-request-id=exampleString

Command options

--profile-id (string)

The profile ID. Required.

The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/.

--profile-name (string)

The name of the profile. Required.

The maximum length is 64 characters. The minimum length is 2 characters. The value must match regular expression /^[a-zA-Z0-9_\\s\\-]*$/.

--profile-description (string)

The description of the profile. Required.

The maximum length is 256 characters. The minimum length is 2 characters. The value must match regular expression /^[a-zA-Z0-9_,'"\\s\\-\\[\\]]+$/.

--profile-type (string)

The profile type. Required.

Allowable values are: predefined, custom.

--controls (ProfileControlsPrototype[])

The controls that are in the profile. Required.

The maximum length is 512 items. The minimum length is 0 items.

Provide a JSON string option or specify a JSON file to read from by providing a filepath option that begins with a @, e.g. --controls=@path/to/file.json.

--default-parameters (DefaultParametersPrototype[])

The default parameters of the profile. Required.

The maximum length is 512 items. The minimum length is 0 items.

Provide a JSON string option or specify a JSON file to read from by providing a filepath option that begins with a @, e.g. --default-parameters=@path/to/file.json.

--x-correlation-id (string)

The supplied or generated value of this header is logged for a request and repeated in a response header for the corresponding response. The same value is used for downstream requests and retries of those requests. If a value of this header is not supplied in a request, the service generates a random (version 4) UUID.

The maximum length is 1024 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9 ,\\-_]+$/.

--x-request-id (string)

The supplied or generated value of this header is logged for a request and repeated in a response header for the corresponding response. The same value is not used for downstream requests and retries of those requests. If a value of this header is not supplied in a request, the service generates a random (version 4) UUID.

The maximum length is 1024 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9 ,\\-_]+$/.

Example

ibmcloud security-compliance profile update \
    --profile-id=exampleString \
    --profile-name=test_profile1 \
    --profile-description=test_description1 \
    --profile-type=custom \
    --controls='[{"control_library_id": "e98a56ff-dc24-41d4-9875-1e188e2da6cd", "control_id": "1fa45e17-9322-4e6c-bbd6-1c51db08e790"}]' \
    --default-parameters='[{"assessment_type": "Automated", "assessment_id": "rule-a637949b-7e51-46c4-afd4-b96619001bf1", "parameter_name": "session_invalidation_in_seconds", "parameter_default_value": "120", "parameter_display_name": "Sign out due to inactivity in seconds", "parameter_type": "numeric"}]' \
    --x-correlation-id=exampleString \
    --x-request-id=exampleString

Command options

--x-correlation-id (string)

The supplied or generated value of this header is logged for a request and repeated in a response header for the corresponding response. The same value is used for downstream requests and retries of those requests. If a value of this header is not supplied in a request, the service generates a random (version 4) UUID.

The maximum length is 1024 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9 ,\\-_]+$/.

--x-request-id (string)

The supplied or generated value of this header is logged for a request and repeated in a response header for the corresponding response. The same value is not used for downstream requests and retries of those requests. If a value of this header is not supplied in a request, the service generates a random (version 4) UUID.

The maximum length is 1024 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9 ,\\-_]+$/.

--type (string)

The list of only user-defined, or system-defined rules.

The maximum length is 14 characters. The minimum length is 12 characters. The value must match regular expression /user_defined|system_defined/.

--search (string)

The indication of whether to search for rules with a specific string string in the name, description, or labels.

The maximum length is 256 characters. The minimum length is 0 characters. The value must match regular expression /.*/.

--service-name (string)

Searches for rules targeting corresponding service.

The maximum length is 64 characters. The minimum length is 0 characters. The value must match regular expression /.*/.

Example

ibmcloud security-compliance rule list \
    --x-correlation-id=exampleString \
    --x-request-id=exampleString \
    --type=system_defined \
    --search=exampleString \
    --service-name=exampleString

Command options

--description (string)

The rule description. Required.

The maximum length is 512 characters. The minimum length is 0 characters. The value must match regular expression /[A-Za-z0-9]+/.

--target (Target)

The rule target. This JSON option can instead be provided by setting individual fields with other options. It is mutually exclusive with those options.

Provide a JSON string option or specify a JSON file to read from by providing a filepath option that begins with a @, e.g. --target=@path/to/file.json.

--required-config (RequiredConfig)

The required configurations. This JSON option can instead be provided by setting individual fields with other options. It is mutually exclusive with those options.

Provide a JSON string option or specify a JSON file to read from by providing a filepath option that begins with a @, e.g. --required-config=@path/to/file.json.

--type (string)

The rule type (user_defined or system_defined).

Allowable values are: user_defined, system_defined. The maximum length is 14 characters. The minimum length is 12 characters. The value must match regular expression /[A-Za-z]+_[A-Za-z]+/.

--version (string)

The rule version number.

The maximum length is 10 characters. The minimum length is 5 characters. The value must match regular expression /^[0-9][0-9.]*$/.

--import (Import)

The collection of import parameters. This JSON option can instead be provided by setting individual fields with other options. It is mutually exclusive with those options.

Provide a JSON string option or specify a JSON file to read from by providing a filepath option that begins with a @, e.g. --import=@path/to/file.json.

--labels ([]string)

The list of labels that correspond to a rule.

The list items must match regular expression /[A-Za-z0-9]+/. The maximum length is 32 items. The minimum length is 0 items.

--x-correlation-id (string)

The supplied or generated value of this header is logged for a request and repeated in a response header for the corresponding response. The same value is used for downstream requests and retries of those requests. If a value of this header is not supplied in a request, the service generates a random (version 4) UUID.

The maximum length is 1024 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9 ,\\-_]+$/.

--x-request-id (string)

The supplied or generated value of this header is logged for a request and repeated in a response header for the corresponding response. The same value is not used for downstream requests and retries of those requests. If a value of this header is not supplied in a request, the service generates a random (version 4) UUID.

The maximum length is 1024 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9 ,\\-_]+$/.

--target-service-name (string)

The target service name. This option provides a value for a sub-field of the JSON option 'target'. It is mutually exclusive with that option.

The maximum length is 64 characters. The minimum length is 0 characters. The value must match regular expression /[A-Za-z0-9]+/.

--target-service-display-name (string)

The display name of the target service. This option provides a value for a sub-field of the JSON option 'target'. It is mutually exclusive with that option.

The maximum length is 64 characters. The minimum length is 0 characters. The value must match regular expression /[A-Za-z0-9]+/.

--target-resource-kind (string)

The target resource kind. This option provides a value for a sub-field of the JSON option 'target'. It is mutually exclusive with that option.

The maximum length is 99999 characters. The minimum length is 0 characters. The value must match regular expression /[A-Za-z0-9]+/.

--target-additional-target-attributes (AdditionalTargetAttribute[])

The list of targets supported properties. This option provides a value for a sub-field of the JSON option 'target'. It is mutually exclusive with that option.

The maximum length is 99999 items. The minimum length is 0 items.

Provide a JSON string option or specify a JSON file to read from by providing a filepath option that begins with a @, e.g. --target-additional-target-attributes=@path/to/file.json.

--required-config-description (string)

The required config description. This option provides a value for a sub-field of the JSON option 'required-config'. It is mutually exclusive with that option.

The maximum length is 512 characters. The minimum length is 0 characters. The value must match regular expression /[A-Za-z0-9]+/.

--required-config-and (RequiredConfigItems[])

The AND required configurations. This option provides a value for a sub-field of the JSON option 'required-config'. It is mutually exclusive with that option.

The maximum length is 64 items. The minimum length is 1 item.

Provide a JSON string option or specify a JSON file to read from by providing a filepath option that begins with a @, e.g. --required-config-and=@path/to/file.json.

--required-config-or (RequiredConfigItems[])

The OR required configurations. This option provides a value for a sub-field of the JSON option 'required-config'. It is mutually exclusive with that option.

The maximum length is 64 items. The minimum length is 1 item.

Provide a JSON string option or specify a JSON file to read from by providing a filepath option that begins with a @, e.g. --required-config-or=@path/to/file.json.

--required-config-property (string)

The property. This option provides a value for a sub-field of the JSON option 'required-config'. It is mutually exclusive with that option.

The maximum length is 256 characters. The minimum length is 0 characters. The value must match regular expression /[A-Za-z0-9]+/.

--required-config-operator (string)

The operator. This option provides a value for a sub-field of the JSON option 'required-config'. It is mutually exclusive with that option.

Allowable values are: string_equals, string_not_equals, string_match, string_not_match, string_contains, string_not_contains, num_equals, num_not_equals, num_less_than, num_less_than_equals, num_greater_than, num_greater_than_equals, is_empty, is_not_empty, is_true, is_false, strings_in_list, strings_allowed, strings_required, ips_in_range, ips_equals, ips_not_equals, days_less_than. The maximum length is 23 characters. The minimum length is 7 characters.

--required-config-value (interface{})

Schema for any JSON type. This option provides a value for a sub-field of the JSON option 'required-config'. It is mutually exclusive with that option.

Provide a JSON string option or specify a JSON file to read from by providing a filepath option that begins with a @, e.g. --required-config-value=@path/to/file.json.

--import-parameters (Parameter[])

The list of import parameters. This option provides a value for a sub-field of the JSON option 'import'. It is mutually exclusive with that option.

The maximum length is 8 items. The minimum length is 0 items.

Provide a JSON string option or specify a JSON file to read from by providing a filepath option that begins with a @, e.g. --import-parameters=@path/to/file.json.

Examples

ibmcloud security-compliance rule create \
    --description='Example rule' \
    --target='{"service_name": "cloud-object-storage", "service_display_name": "exampleString", "resource_kind": "bucket", "additional_target_attributes": [{"name": "location", "operator": "string_equals", "value": "us-east"}]}' \
    --required-config='{"description": "The Cloud Object Storage rule.", "and": [{"description": "exampleString", "property": "hard_quota", "operator": "num_equals", "value": "${hard_quota}"}]}' \
    --type=user_defined \
    --version=1.0.0 \
    --import='{"parameters": [{"name": "hard_quota", "display_name": "The Cloud Object Storage bucket quota.", "description": "The maximum bytes that are allocated to the Cloud Object Storage bucket.", "type": "numeric"}]}' \
    --labels=foo,bar \
    --x-correlation-id=exampleString \
    --x-request-id=exampleString

Alternatively, granular options are available for for the sub-fields of JSON string options:

ibmcloud security-compliance rule create \
    --description='Example rule' \
    --type=user_defined \
    --version=1.0.0 \
    --labels=foo,bar \
    --x-correlation-id=exampleString \
    --x-request-id=exampleString \
    --target-service-name=exampleString \
    --target-service-display-name=exampleString \
    --target-resource-kind=exampleString \
    --target-additional-target-attributes='[additionalTargetAttribute]' \
    --required-config-description=exampleString \
    --required-config-and='[requiredConfigItems]' \
    --required-config-or='[requiredConfigItems]' \
    --required-config-property=exampleString \
    --required-config-operator=string_equals \
    --required-config-value="exampleString" \
    --import-parameters='[{"name": "hard_quota", "display_name": "The Cloud Object Storage bucket quota.", "description": "The maximum bytes that are allocated to the Cloud Object Storage bucket.", "type": "numeric"}]'

Command options

--rule-id (string)

The ID of the corresponding rule. Required.

The maximum length is 41 characters. The minimum length is 41 characters. The value must match regular expression /rule-[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}/.

--x-correlation-id (string)

The supplied or generated value of this header is logged for a request and repeated in a response header for the corresponding response. The same value is used for downstream requests and retries of those requests. If a value of this header is not supplied in a request, the service generates a random (version 4) UUID.

The maximum length is 1024 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9 ,\\-_]+$/.

--x-request-id (string)

The supplied or generated value of this header is logged for a request and repeated in a response header for the corresponding response. The same value is not used for downstream requests and retries of those requests. If a value of this header is not supplied in a request, the service generates a random (version 4) UUID.

The maximum length is 1024 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9 ,\\-_]+$/.

Example

ibmcloud security-compliance rule delete \
    --rule-id=exampleString \
    --x-correlation-id=exampleString \
    --x-request-id=exampleString

Command options

--rule-id (string)

The ID of the corresponding rule. Required.

The maximum length is 41 characters. The minimum length is 41 characters. The value must match regular expression /rule-[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}/.

--x-correlation-id (string)

The supplied or generated value of this header is logged for a request and repeated in a response header for the corresponding response. The same value is used for downstream requests and retries of those requests. If a value of this header is not supplied in a request, the service generates a random (version 4) UUID.

The maximum length is 1024 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9 ,\\-_]+$/.

--x-request-id (string)

The supplied or generated value of this header is logged for a request and repeated in a response header for the corresponding response. The same value is not used for downstream requests and retries of those requests. If a value of this header is not supplied in a request, the service generates a random (version 4) UUID.

The maximum length is 1024 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9 ,\\-_]+$/.

Example

ibmcloud security-compliance rule get \
    --rule-id=exampleString \
    --x-correlation-id=exampleString \
    --x-request-id=exampleString

Command options

--rule-id (string)

The ID of the corresponding rule. Required.

The maximum length is 41 characters. The minimum length is 41 characters. The value must match regular expression /rule-[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}/.

--if-match (string)

This field compares a supplied Etag value with the version that is stored for the requested resource. If the values match, the server allows the request method to continue.

To find the Etag value, run a GET request on the resource that you want to modify, and check the response headers. Required.

The maximum length is `128` characters. The minimum length is `4` characters. The value must match regular expression `/W\/"[^"]*"/`.

--description (string)

The rule description. Required.

The maximum length is 512 characters. The minimum length is 0 characters. The value must match regular expression /[A-Za-z0-9]+/.

--target (Target)

The rule target. This JSON option can instead be provided by setting individual fields with other options. It is mutually exclusive with those options.

Provide a JSON string option or specify a JSON file to read from by providing a filepath option that begins with a @, e.g. --target=@path/to/file.json.

--required-config (RequiredConfig)

The required configurations. This JSON option can instead be provided by setting individual fields with other options. It is mutually exclusive with those options.

Provide a JSON string option or specify a JSON file to read from by providing a filepath option that begins with a @, e.g. --required-config=@path/to/file.json.

--type (string)

The rule type (user_defined or system_defined).

Allowable values are: user_defined, system_defined. The maximum length is 14 characters. The minimum length is 12 characters. The value must match regular expression /[A-Za-z]+_[A-Za-z]+/.

--version (string)

The rule version number.

The maximum length is 10 characters. The minimum length is 5 characters. The value must match regular expression /^[0-9][0-9.]*$/.

--import (Import)

The collection of import parameters. This JSON option can instead be provided by setting individual fields with other options. It is mutually exclusive with those options.

Provide a JSON string option or specify a JSON file to read from by providing a filepath option that begins with a @, e.g. --import=@path/to/file.json.

--labels ([]string)

The list of labels that correspond to a rule.

The list items must match regular expression /[A-Za-z0-9]+/. The maximum length is 32 items. The minimum length is 0 items.

--x-correlation-id (string)

The supplied or generated value of this header is logged for a request and repeated in a response header for the corresponding response. The same value is used for downstream requests and retries of those requests. If a value of this header is not supplied in a request, the service generates a random (version 4) UUID.

The maximum length is 1024 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9 ,\\-_]+$/.

--x-request-id (string)

The supplied or generated value of this header is logged for a request and repeated in a response header for the corresponding response. The same value is not used for downstream requests and retries of those requests. If a value of this header is not supplied in a request, the service generates a random (version 4) UUID.

The maximum length is 1024 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9 ,\\-_]+$/.

--target-service-name (string)

The target service name. This option provides a value for a sub-field of the JSON option 'target'. It is mutually exclusive with that option.

The maximum length is 64 characters. The minimum length is 0 characters. The value must match regular expression /[A-Za-z0-9]+/.

--target-service-display-name (string)

The display name of the target service. This option provides a value for a sub-field of the JSON option 'target'. It is mutually exclusive with that option.

The maximum length is 64 characters. The minimum length is 0 characters. The value must match regular expression /[A-Za-z0-9]+/.

--target-resource-kind (string)

The target resource kind. This option provides a value for a sub-field of the JSON option 'target'. It is mutually exclusive with that option.

The maximum length is 99999 characters. The minimum length is 0 characters. The value must match regular expression /[A-Za-z0-9]+/.

--target-additional-target-attributes (AdditionalTargetAttribute[])

The list of targets supported properties. This option provides a value for a sub-field of the JSON option 'target'. It is mutually exclusive with that option.

The maximum length is 99999 items. The minimum length is 0 items.

Provide a JSON string option or specify a JSON file to read from by providing a filepath option that begins with a @, e.g. --target-additional-target-attributes=@path/to/file.json.

--required-config-description (string)

The required config description. This option provides a value for a sub-field of the JSON option 'required-config'. It is mutually exclusive with that option.

The maximum length is 512 characters. The minimum length is 0 characters. The value must match regular expression /[A-Za-z0-9]+/.

--required-config-and (RequiredConfigItems[])

The AND required configurations. This option provides a value for a sub-field of the JSON option 'required-config'. It is mutually exclusive with that option.

The maximum length is 64 items. The minimum length is 1 item.

Provide a JSON string option or specify a JSON file to read from by providing a filepath option that begins with a @, e.g. --required-config-and=@path/to/file.json.

--required-config-or (RequiredConfigItems[])

The OR required configurations. This option provides a value for a sub-field of the JSON option 'required-config'. It is mutually exclusive with that option.

The maximum length is 64 items. The minimum length is 1 item.

Provide a JSON string option or specify a JSON file to read from by providing a filepath option that begins with a @, e.g. --required-config-or=@path/to/file.json.

--required-config-property (string)

The property. This option provides a value for a sub-field of the JSON option 'required-config'. It is mutually exclusive with that option.

The maximum length is 256 characters. The minimum length is 0 characters. The value must match regular expression /[A-Za-z0-9]+/.

--required-config-operator (string)

The operator. This option provides a value for a sub-field of the JSON option 'required-config'. It is mutually exclusive with that option.

Allowable values are: string_equals, string_not_equals, string_match, string_not_match, string_contains, string_not_contains, num_equals, num_not_equals, num_less_than, num_less_than_equals, num_greater_than, num_greater_than_equals, is_empty, is_not_empty, is_true, is_false, strings_in_list, strings_allowed, strings_required, ips_in_range, ips_equals, ips_not_equals, days_less_than. The maximum length is 23 characters. The minimum length is 7 characters.

--required-config-value (interface{})

Schema for any JSON type. This option provides a value for a sub-field of the JSON option 'required-config'. It is mutually exclusive with that option.

Provide a JSON string option or specify a JSON file to read from by providing a filepath option that begins with a @, e.g. --required-config-value=@path/to/file.json.

--import-parameters (Parameter[])

The list of import parameters. This option provides a value for a sub-field of the JSON option 'import'. It is mutually exclusive with that option.

The maximum length is 8 items. The minimum length is 0 items.

Provide a JSON string option or specify a JSON file to read from by providing a filepath option that begins with a @, e.g. --import-parameters=@path/to/file.json.

Examples

ibmcloud security-compliance rule update \
    --rule-id=exampleString \
    --if-match=exampleString \
    --description='Example rule' \
    --target='{"service_name": "cloud-object-storage", "service_display_name": "Cloud Object Storage", "resource_kind": "bucket", "additional_target_attributes": [{"name": "location", "operator": "string_equals", "value": "us-south"}]}' \
    --required-config='{"description": "The Cloud Object Storage rule.", "and": [{"description": "exampleString", "property": "hard_quota", "operator": "num_equals", "value": "${hard_quota}"}]}' \
    --type=user_defined \
    --version=1.0.1 \
    --import='{"parameters": [{"name": "hard_quota", "display_name": "The Cloud Object Storage bucket quota.", "description": "The maximum bytes that are allocated to the Cloud Object Storage bucket.", "type": "numeric"}]}' \
    --labels=foo,bar \
    --x-correlation-id=exampleString \
    --x-request-id=exampleString

Alternatively, granular options are available for for the sub-fields of JSON string options:

ibmcloud security-compliance rule update \
    --rule-id=exampleString \
    --if-match=exampleString \
    --description='Example rule' \
    --type=user_defined \
    --version=1.0.1 \
    --labels=foo,bar \
    --x-correlation-id=exampleString \
    --x-request-id=exampleString \
    --target-service-name=exampleString \
    --target-service-display-name=exampleString \
    --target-resource-kind=exampleString \
    --target-additional-target-attributes='[additionalTargetAttribute]' \
    --required-config-description=exampleString \
    --required-config-and='[requiredConfigItems]' \
    --required-config-or='[requiredConfigItems]' \
    --required-config-property=exampleString \
    --required-config-operator=string_equals \
    --required-config-value="exampleString" \
    --import-parameters='[{"name": "hard_quota", "display_name": "The Cloud Object Storage bucket quota.", "description": "The maximum bytes that are allocated to the Cloud Object Storage bucket.", "type": "numeric"}]'

Command options

--profile-id (string)

The profile ID. Required.

The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/.

--attachments (AttachmentsPrototype[])

The array that displays all of the available attachments. Required.

The maximum length is 50 items. The minimum length is 0 items.

Provide a JSON string option or specify a JSON file to read from by providing a filepath option that begins with a @, e.g. --attachments=@path/to/file.json.

--x-correlation-id (string)

The supplied or generated value of this header is logged for a request and repeated in a response header for the corresponding response. The same value is used for downstream requests and retries of those requests. If a value of this header is not supplied in a request, the service generates a random (version 4) UUID.

The maximum length is 1024 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9 ,\\-_]+$/.

--x-request-id (string)

The supplied or generated value of this header is logged for a request and repeated in a response header for the corresponding response. The same value is not used for downstream requests and retries of those requests. If a value of this header is not supplied in a request, the service generates a random (version 4) UUID.

The maximum length is 1024 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9 ,\\-_]+$/.

Example

ibmcloud security-compliance attachment create \
    --profile-id=exampleString \
    --attachments='[{"id": "130003ea8bfa43c5aacea07a86da3000", "name": "account-0d8c3805dfea40aa8ad02265a18eb12b", "description": "Test description", "scope": [{"environment": "ibm-cloud", "properties": [{"name": "scope_id", "value": "cg3335893hh1428692d6747cf300yeb5"}]}], "status": "enabled", "schedule": "every_30_days", "notifications": {"enabled": false, "controls": {"threshold_limit": 15, "failed_control_ids": []}}, "attachment_parameters": [{"assessment_type": "Automated", "assessment_id": "rule-a637949b-7e51-46c4-afd4-b96619001bf1", "parameter_name": "session_invalidation_in_seconds", "parameter_value": "120", "parameter_display_name": "Sign out due to inactivity in seconds", "parameter_type": "numeric"}]}]' \
    --x-correlation-id=exampleString \
    --x-request-id=exampleString

Command options

--attachment-id (string)

The attachment ID. Required.

The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-4[0-9A-Fa-f]{3}-[89ABab][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}$|^$/.

--profile-id (string)

The profile ID. Required.

The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/.

--x-correlation-id (string)

The supplied or generated value of this header is logged for a request and repeated in a response header for the corresponding response. The same value is used for downstream requests and retries of those requests. If a value of this header is not supplied in a request, the service generates a random (version 4) UUID.

The maximum length is 1024 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9 ,\\-_]+$/.

--x-request-id (string)

The supplied or generated value of this header is logged for a request and repeated in a response header for the corresponding response. The same value is not used for downstream requests and retries of those requests. If a value of this header is not supplied in a request, the service generates a random (version 4) UUID.

The maximum length is 1024 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9 ,\\-_]+$/.

Example

ibmcloud security-compliance attachment delete \
    --attachment-id=exampleString \
    --profile-id=exampleString \
    --x-correlation-id=exampleString \
    --x-request-id=exampleString

Command options

--attachment-id (string)

The attachment ID. Required.

The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-4[0-9A-Fa-f]{3}-[89ABab][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}$|^$/.

--profile-id (string)

The profile ID. Required.

The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/.

--x-correlation-id (string)

The supplied or generated value of this header is logged for a request and repeated in a response header for the corresponding response. The same value is used for downstream requests and retries of those requests. If a value of this header is not supplied in a request, the service generates a random (version 4) UUID.

The maximum length is 1024 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9 ,\\-_]+$/.

--x-request-id (string)

The supplied or generated value of this header is logged for a request and repeated in a response header for the corresponding response. The same value is not used for downstream requests and retries of those requests. If a value of this header is not supplied in a request, the service generates a random (version 4) UUID.

The maximum length is 1024 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9 ,\\-_]+$/.

Example

ibmcloud security-compliance attachment get \
    --attachment-id=exampleString \
    --profile-id=exampleString \
    --x-correlation-id=exampleString \
    --x-request-id=exampleString

Command options

--attachment-id (string)

The attachment ID. Required.

The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-4[0-9A-Fa-f]{3}-[89ABab][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}$|^$/.

--profile-id (string)

The profile ID. Required.

The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/.

--id (string)

The ID of the attachment.

The maximum length is 32 characters. The minimum length is 32 characters. The value must match regular expression /^[a-zA-Z0-9-]*$/.

--account-id (string)

The account ID that is associated to the attachment.

The maximum length is 32 characters. The minimum length is 32 characters. The value must match regular expression /^[a-zA-Z0-9-]*$/.

--instance-id (string)

The instance ID of the account that is associated to the attachment.

The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-4[0-9A-Fa-f]{3}-[89ABab][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}$|^$/.

--scope (MultiCloudScope[])

The scope payload for the multi cloud feature.

The maximum length is 8 items. The minimum length is 0 items.

Provide a JSON string option or specify a JSON file to read from by providing a filepath option that begins with a @, e.g. --scope=@path/to/file.json.

--created-on (strfmt.DateTime)

The date when the attachment was created.

--created-by (string)

The user who created the attachment.

The maximum length is 255 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9-\\.:,_\\s]*$/.

--updated-on (strfmt.DateTime)

The date when the attachment was updated.

--updated-by (string)

The user who updated the attachment.

The maximum length is 255 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9-\\.:,_\\s]*$/.

--status (string)

The status of an attachment evaluation.

Allowable values are: enabled, disabled.

--schedule (string)

The schedule of an attachment evaluation.

Allowable values are: daily, every_7_days, every_30_days.

--notifications (AttachmentsNotificationsPrototype)

The request payload of the attachment notifications. This JSON option can instead be provided by setting individual fields with other options. It is mutually exclusive with those options.

Provide a JSON string option or specify a JSON file to read from by providing a filepath option that begins with a @, e.g. --notifications=@path/to/file.json.

--attachment-parameters (AttachmentParameterPrototype[])

The profile parameters for the attachment.

The maximum length is 512 items. The minimum length is 0 items.

Provide a JSON string option or specify a JSON file to read from by providing a filepath option that begins with a @, e.g. --attachment-parameters=@path/to/file.json.

--last-scan (LastScan)

The details of the last scan of an attachment. This JSON option can instead be provided by setting individual fields with other options. It is mutually exclusive with those options.

Provide a JSON string option or specify a JSON file to read from by providing a filepath option that begins with a @, e.g. --last-scan=@path/to/file.json.

--next-scan-time (strfmt.DateTime)

The start time of the next scan.

--name (string)

The name of the attachment.

The maximum length is 128 characters. The minimum length is 2 characters. The value must match regular expression /^[a-zA-Z0-9-]*$/.

--description (string)

The description for the attachment.

The maximum length is 256 characters. The minimum length is 0 characters. The value must match regular expression /^[a-zA-Z0-9_,'\\s\\-]*$/.

--x-correlation-id (string)

The supplied or generated value of this header is logged for a request and repeated in a response header for the corresponding response. The same value is used for downstream requests and retries of those requests. If a value of this header is not supplied in a request, the service generates a random (version 4) UUID.

The maximum length is 1024 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9 ,\\-_]+$/.

--x-request-id (string)

The supplied or generated value of this header is logged for a request and repeated in a response header for the corresponding response. The same value is not used for downstream requests and retries of those requests. If a value of this header is not supplied in a request, the service generates a random (version 4) UUID.

The maximum length is 1024 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9 ,\\-_]+$/.

--notifications-enabled (bool)

enabled notifications. This option provides a value for a sub-field of the JSON option 'notifications'. It is mutually exclusive with that option.

--notifications-controls (FailedControls)

The failed controls. This option provides a value for a sub-field of the JSON option 'notifications'. It is mutually exclusive with that option.

Provide a JSON string option or specify a JSON file to read from by providing a filepath option that begins with a @, e.g. --notifications-controls=@path/to/file.json.

--last-scan-id (string)

The ID of the last scan of an attachment. This option provides a value for a sub-field of the JSON option 'last-scan'. It is mutually exclusive with that option.

The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[a-zA-Z0-9-]*$/.

--last-scan-status (string)

The status of the last scan of an attachment. This option provides a value for a sub-field of the JSON option 'last-scan'. It is mutually exclusive with that option.

Allowable values are: in_progress, completed.

--last-scan-time (strfmt.DateTime)

The time when the last scan started. This option provides a value for a sub-field of the JSON option 'last-scan'. It is mutually exclusive with that option.

Examples

ibmcloud security-compliance attachment update \
    --attachment-id=exampleString \
    --profile-id=exampleString \
    --id=exampleString \
    --account-id=exampleString \
    --instance-id=exampleString \
    --scope='[{"environment": "ibm-cloud", "properties": [{"name": "scope_id", "value": "cg3335893hh1428692d6747cf300yeb5"}]}]' \
    --created-on=2019-01-01T12:00:00.000Z \
    --created-by=exampleString \
    --updated-on=2019-01-01T12:00:00.000Z \
    --updated-by=exampleString \
    --status=enabled \
    --schedule=every_30_days \
    --notifications='{"enabled": false, "controls": {"threshold_limit": 15, "failed_control_ids": []}}' \
    --attachment-parameters='[{"assessment_type": "Automated", "assessment_id": "rule-a637949b-7e51-46c4-afd4-b96619001bf1", "parameter_name": "session_invalidation_in_seconds", "parameter_value": "120", "parameter_display_name": "Sign out due to inactivity in seconds", "parameter_type": "numeric"}]' \
    --last-scan='{"id": "e8a39d25-0051-4328-8462-988ad321f49a", "status": "in_progress", "time": "2019-01-01T12:00:00.000Z"}' \
    --next-scan-time=2019-01-01T12:00:00.000Z \
    --name=account-0d8c3805dfea40aa8ad02265a18eb12b \
    --description='Test description' \
    --x-correlation-id=exampleString \
    --x-request-id=exampleString

Alternatively, granular options are available for for the sub-fields of JSON string options:

ibmcloud security-compliance attachment update \
    --attachment-id=exampleString \
    --profile-id=exampleString \
    --id=exampleString \
    --account-id=exampleString \
    --instance-id=exampleString \
    --scope=multiCloudScope \
    --created-on=2019-01-01T12:00:00.000Z \
    --created-by=exampleString \
    --updated-on=2019-01-01T12:00:00.000Z \
    --updated-by=exampleString \
    --status=enabled \
    --schedule=every_30_days \
    --attachment-parameters=attachmentParameterPrototype \
    --next-scan-time=2019-01-01T12:00:00.000Z \
    --name=account-0d8c3805dfea40aa8ad02265a18eb12b \
    --description='Test description' \
    --x-correlation-id=exampleString \
    --x-request-id=exampleString \
    --notifications-enabled=true \
    --notifications-controls=failedControls \
    --last-scan-id=e8a39d25-0051-4328-8462-988ad321f49a \
    --last-scan-status=in_progress \
    --last-scan-time=2019-01-01T12:00:00.000Z

Command options

--attachment-id (string)

The attachment ID of a profile. Required.

The maximum length is 32 characters. The minimum length is 32 characters. The value must match regular expression /^[0-9a-f]{32}$/.

--x-correlation-id (string)

The supplied or generated value of this header is logged for a request and repeated in a response header for the corresponding response. The same value is used for downstream requests and retries of those requests. If a value of this header is not supplied in a request, the service generates a random (version 4) UUID.

The maximum length is 1024 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9 ,\\-_]+$/.

--x-request-id (string)

The supplied or generated value of this header is logged for a request and repeated in a response header for the corresponding response. The same value is not used for downstream requests and retries of those requests. If a value of this header is not supplied in a request, the service generates a random (version 4) UUID.

The maximum length is 1024 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9 ,\\-_]+$/.

Example

ibmcloud security-compliance attachment scan \
    --attachment-id=exampleString \
    --x-correlation-id=exampleString \
    --x-request-id=exampleString

Command options

--x-correlation-id (string)

The supplied or generated value of this header is logged for a request and repeated in a response header for the corresponding response. The same value is used for downstream requests and retries of those requests. If a value of this header is not supplied in a request, the service generates a random (version 4) UUID.

The maximum length is 1024 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9 ,\\-_]+$/.

--x-request-id (string)

The supplied or generated value of this header is logged for a request and repeated in a response header for the corresponding response. The same value is not used for downstream requests and retries of those requests. If a value of this header is not supplied in a request, the service generates a random (version 4) UUID.

The maximum length is 1024 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9 ,\\-_]+$/.

--limit (int64)

The indication of how many resources to return, unless the response is the last page of resources.

The default value is 50. The maximum value is 100. The minimum value is 0.

--start (string)

Determine what resource to start the page on or after.

The maximum length is 1024 characters. The minimum length is 0 characters. The value must match regular expression /.*/.

--all-pages (bool)

Invoke multiple requests to display all pages of the collection for attachments-list-all.

Example

ibmcloud security-compliance attachment list \
    --x-correlation-id=exampleString \
    --x-request-id=exampleString \
    --limit=10 \
    --start=exampleString

Command options

--x-correlation-id (string)

The supplied or generated value of this header is logged for a request and repeated in a response header for the corresponding response. The same value is used for downstream requests and retries of those requests. If a value of this header is not supplied in a request, the service generates a random (version 4) UUID.

The maximum length is 1024 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9 ,\\-_]+$/.

--x-request-id (string)

The supplied or generated value of this header is logged for a request and repeated in a response header for the corresponding response. The same value is not used for downstream requests and retries of those requests. If a value of this header is not supplied in a request, the service generates a random (version 4) UUID.

The maximum length is 1024 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9 ,\\-_]+$/.

--sort (string)

This field sorts results by using a valid sort field. To learn more, see Sorting.

The maximum length is 32 characters. The minimum length is 1 character. The value must match regular expression /^[\\-]?[a-z0-9_]+$/.

Example

ibmcloud security-compliance report latest \
    --x-correlation-id=exampleString \
    --x-request-id=exampleString \
    --sort=profile_name

Command options

--x-correlation-id (string)

The supplied or generated value of this header is logged for a request and repeated in a response header for the corresponding response. The same value is used for downstream requests and retries of those requests. If a value of this header is not supplied in a request, the service generates a random (version 4) UUID.

The maximum length is 1024 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9 ,\\-_]+$/.

--x-request-id (string)

The supplied or generated value of this header is logged for a request and repeated in a response header for the corresponding response. The same value is not used for downstream requests and retries of those requests. If a value of this header is not supplied in a request, the service generates a random (version 4) UUID.

The maximum length is 1024 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9 ,\\-_]+$/.

--attachment-id (string)

The ID of the attachment.

The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9\\-]+$/.

--group-id (string)

The report group ID.

The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9\\-]+$/.

--profile-id (string)

The ID of the profile.

The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9\\-]+$/.

--type (string)

The type of the scan.

Allowable values are: ondemand, scheduled.

--start (string)

The indication of what resource to start the page on.

The maximum length is 512 characters. The minimum length is 0 characters. The value must match regular expression /^[a-zA-Z0-9\\-]+$/.

--limit (int64)

The indication of many resources to return, unless the response is the last page of resources.

The default value is 50. The maximum value is 100. The minimum value is 0.

--sort (string)

This field sorts results by using a valid sort field. To learn more, see Sorting.

The maximum length is 32 characters. The minimum length is 1 character. The value must match regular expression /^[\\-]?[a-z0-9_]+$/.

--all-pages (bool)

Invoke multiple requests to display all pages of the collection for reports-list.

Example

ibmcloud security-compliance report list \
    --x-correlation-id=exampleString \
    --x-request-id=exampleString \
    --attachment-id=exampleString \
    --group-id=exampleString \
    --profile-id=exampleString \
    --type=scheduled \
    --start=exampleString \
    --limit=10 \
    --sort=profile_name

Command options

--report-id (string)

The ID of the scan that is associated with a report. Required.

The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9\\-]+$/.

--x-correlation-id (string)

The supplied or generated value of this header is logged for a request and repeated in a response header for the corresponding response. The same value is used for downstream requests and retries of those requests. If a value of this header is not supplied in a request, the service generates a random (version 4) UUID.

The maximum length is 1024 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9 ,\\-_]+$/.

--x-request-id (string)

The supplied or generated value of this header is logged for a request and repeated in a response header for the corresponding response. The same value is not used for downstream requests and retries of those requests. If a value of this header is not supplied in a request, the service generates a random (version 4) UUID.

The maximum length is 1024 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9 ,\\-_]+$/.

Example

ibmcloud security-compliance report get \
    --report-id=exampleString \
    --x-correlation-id=exampleString \
    --x-request-id=exampleString

Command options

--report-id (string)

The ID of the scan that is associated with a report. Required.

The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9\\-]+$/.

--x-correlation-id (string)

The supplied or generated value of this header is logged for a request and repeated in a response header for the corresponding response. The same value is used for downstream requests and retries of those requests. If a value of this header is not supplied in a request, the service generates a random (version 4) UUID.

The maximum length is 1024 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9 ,\\-_]+$/.

--x-request-id (string)

The supplied or generated value of this header is logged for a request and repeated in a response header for the corresponding response. The same value is not used for downstream requests and retries of those requests. If a value of this header is not supplied in a request, the service generates a random (version 4) UUID.

The maximum length is 1024 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9 ,\\-_]+$/.

Example

ibmcloud security-compliance report summary \
    --report-id=exampleString \
    --x-correlation-id=exampleString \
    --x-request-id=exampleString

Command options

--report-id (string)

The ID of the scan that is associated with a report. Required.

The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9\\-]+$/.

--x-correlation-id (string)

The supplied or generated value of this header is logged for a request and repeated in a response header for the corresponding response. The same value is used for downstream requests and retries of those requests. If a value of this header is not supplied in a request, the service generates a random (version 4) UUID.

The maximum length is 1024 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9 ,\\-_]+$/.

--x-request-id (string)

The supplied or generated value of this header is logged for a request and repeated in a response header for the corresponding response. The same value is not used for downstream requests and retries of those requests. If a value of this header is not supplied in a request, the service generates a random (version 4) UUID.

The maximum length is 1024 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9 ,\\-_]+$/.

--control-id (string)

The ID of the control.

The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9\\-]+$/.

--control-name (string)

The name of the control.

The maximum length is 1024 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9\\-]+$/.

--control-description (string)

The description of the control.

The maximum length is 1024 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9\\s]+$/.

--control-category (string)

A control category value.

The maximum length is 1024 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9\\-]+$/.

--status (string)

The compliance status value.

Allowable values are: compliant, not_compliant, unable_to_perform, user_evaluation_required.

--sort (string)

This field sorts controls by using a valid sort field. To learn more, see Sorting.

Allowable values are: control_name, control_category, status.

Example

ibmcloud security-compliance report controls \
    --report-id=exampleString \
    --x-correlation-id=exampleString \
    --x-request-id=exampleString \
    --control-id=exampleString \
    --control-name=exampleString \
    --control-description=exampleString \
    --control-category=exampleString \
    --status=compliant \
    --sort=control_name

Command options

--report-id (string)

The ID of the scan that is associated with a report. Required.

The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9\\-]+$/.

--rule-id (string)

The ID of a rule in a report. Required.

The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9\\-]+$/.

--x-correlation-id (string)

The supplied or generated value of this header is logged for a request and repeated in a response header for the corresponding response. The same value is used for downstream requests and retries of those requests. If a value of this header is not supplied in a request, the service generates a random (version 4) UUID.

The maximum length is 1024 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9 ,\\-_]+$/.

--x-request-id (string)

The supplied or generated value of this header is logged for a request and repeated in a response header for the corresponding response. The same value is not used for downstream requests and retries of those requests. If a value of this header is not supplied in a request, the service generates a random (version 4) UUID.

The maximum length is 1024 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9 ,\\-_]+$/.

Example

ibmcloud security-compliance report rule \
    --report-id=exampleString \
    --rule-id=rule-8d444f8c-fd1d-48de-bcaa-f43732568761 \
    --x-correlation-id=exampleString \
    --x-request-id=exampleString

Command options

--report-id (string)

The ID of the scan that is associated with a report. Required.

The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9\\-]+$/.

--x-correlation-id (string)

The supplied or generated value of this header is logged for a request and repeated in a response header for the corresponding response. The same value is used for downstream requests and retries of those requests. If a value of this header is not supplied in a request, the service generates a random (version 4) UUID.

The maximum length is 1024 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9 ,\\-_]+$/.

--x-request-id (string)

The supplied or generated value of this header is logged for a request and repeated in a response header for the corresponding response. The same value is not used for downstream requests and retries of those requests. If a value of this header is not supplied in a request, the service generates a random (version 4) UUID.

The maximum length is 1024 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9 ,\\-_]+$/.

--assessment-id (string)

The ID of the assessment.

The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9\\-]+$/.

--component-id (string)

The ID of component.

The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9.\\-]+$/.

--target-id (string)

The ID of the evaluation target.

The maximum length is 1024 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9\\-]+$/.

--target-name (string)

The name of the evaluation target.

The maximum length is 1024 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9\\-]+$/.

--status (string)

The evaluation status value.

Allowable values are: pass, failure, error, skipped.

--start (string)

The indication of what resource to start the page on.

The maximum length is 512 characters. The minimum length is 0 characters. The value must match regular expression /^[a-zA-Z0-9\\-]+$/.

--limit (int64)

The indication of many resources to return, unless the response is the last page of resources.

The default value is 50. The maximum value is 100. The minimum value is 0.

--all-pages (bool)

Invoke multiple requests to display all pages of the collection for reports-list-evaluations.

Example

ibmcloud security-compliance report evaluations \
    --report-id=exampleString \
    --x-correlation-id=exampleString \
    --x-request-id=exampleString \
    --assessment-id=exampleString \
    --component-id=exampleString \
    --target-id=exampleString \
    --target-name=exampleString \
    --status=failure \
    --start=exampleString \
    --limit=10

Command options

--report-id (string)

The ID of the scan that is associated with a report. Required.

The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9\\-]+$/.

--x-correlation-id (string)

The supplied or generated value of this header is logged for a request and repeated in a response header for the corresponding response. The same value is used for downstream requests and retries of those requests. If a value of this header is not supplied in a request, the service generates a random (version 4) UUID.

The maximum length is 1024 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9 ,\\-_]+$/.

--x-request-id (string)

The supplied or generated value of this header is logged for a request and repeated in a response header for the corresponding response. The same value is not used for downstream requests and retries of those requests. If a value of this header is not supplied in a request, the service generates a random (version 4) UUID.

The maximum length is 1024 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9 ,\\-_]+$/.

--id (string)

The ID of the resource.

The maximum length is 1024 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9\\-]+$/.

--resource-name (string)

The name of the resource.

The maximum length is 1024 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9\\-]+$/.

--account-id (string)

The ID of the account owning a resource.

The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9\\-]+$/.

--component-id (string)

The ID of component.

The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9.\\-]+$/.

--status (string)

The compliance status value.

Allowable values are: compliant, not_compliant, unable_to_perform, user_evaluation_required.

--sort (string)

This field sorts resources by using a valid sort field. To learn more, see Sorting.

Allowable values are: account_id, component_id, resource_name, status.

--start (string)

The indication of what resource to start the page on.

The maximum length is 512 characters. The minimum length is 0 characters. The value must match regular expression /^[a-zA-Z0-9\\-]+$/.

--limit (int64)

The indication of many resources to return, unless the response is the last page of resources.

The default value is 50. The maximum value is 100. The minimum value is 0.

--all-pages (bool)

Invoke multiple requests to display all pages of the collection for reports-list-resources.

Example

ibmcloud security-compliance report resources \
    --report-id=exampleString \
    --x-correlation-id=exampleString \
    --x-request-id=exampleString \
    --id=exampleString \
    --resource-name=exampleString \
    --account-id=exampleString \
    --component-id=exampleString \
    --status=compliant \
    --sort=account_id \
    --start=exampleString \
    --limit=10

Command options

--report-id (string)

The ID of the scan that is associated with a report. Required.

The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9\\-]+$/.

--x-correlation-id (string)

The supplied or generated value of this header is logged for a request and repeated in a response header for the corresponding response. The same value is used for downstream requests and retries of those requests. If a value of this header is not supplied in a request, the service generates a random (version 4) UUID.

The maximum length is 1024 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9 ,\\-_]+$/.

--x-request-id (string)

The supplied or generated value of this header is logged for a request and repeated in a response header for the corresponding response. The same value is not used for downstream requests and retries of those requests. If a value of this header is not supplied in a request, the service generates a random (version 4) UUID.

The maximum length is 1024 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9 ,\\-_]+$/.

Example

ibmcloud security-compliance report tags \
    --report-id=exampleString \
    --x-correlation-id=exampleString \
    --x-request-id=exampleString

Command options

--report-id (string)

The ID of the scan that is associated with a report. Required.

The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9\\-]+$/.

--x-correlation-id (string)

The supplied or generated value of this header is logged for a request and repeated in a response header for the corresponding response. The same value is used for downstream requests and retries of those requests. If a value of this header is not supplied in a request, the service generates a random (version 4) UUID.

The maximum length is 1024 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9 ,\\-_]+$/.

--x-request-id (string)

The supplied or generated value of this header is logged for a request and repeated in a response header for the corresponding response. The same value is not used for downstream requests and retries of those requests. If a value of this header is not supplied in a request, the service generates a random (version 4) UUID.

The maximum length is 1024 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9 ,\\-_]+$/.

--scan-time-duration (int64)

The duration of the scan_time timestamp in number of days.

The default value is 0. The maximum value is 366. The minimum value is 0.

Example

ibmcloud security-compliance report violation-drift \
    --report-id=exampleString \
    --x-correlation-id=exampleString \
    --x-request-id=exampleString \
    --scan-time-duration=0