Get Policy Details

Select

SaaS

Customer Managed

Get Policy Details

Responses

• 200
• 400
• 403
• 500

---

OK

application/json

• Schema
• Example (from schema)

---

Schema

• remediationPolicyInfo object

  Remediation Policy object

  policyId int32

  Unique identifier for policy

  policyName string

  policy name

  policyDescription string

  policy description

  rule string

  Query or Rule criteria for policy

  systemGenerated boolean

  Indicating if policy is system generated or custom

  criticality string

  Possible values: [HIGH, MEDIUM, LOW]

  Criticality level

  creationTime int32

  creation time of policy

  modifiedTime int32

  modified time of policy

  remedialAction RemediationActionEnum

  Possible values: [Move, Delete]

  owners object[]

  List of users with ownership on policy

  id int32

  name string

  assignees object[]

  List of users assigned to take action on policy

  id int32

  name string

  category RemediationPolicyCategory

  Possible values: [EXPIRATION, PRIVACY, REDUNDANT]

  violations string

  xml representation of violation counts for policy

• violatedDatastores string

  comma seperated list of datastored ids

• errorCode RemediationPolicyErrorCode

  Possible values: [NO_ERROR, INVALID_INPUT, UNKNOWN_ERROR, INTERNAL_SERVER_ERROR]

• errorMessage string

{
  "remediationPolicyInfo": {
    "policyId": 0,
    "policyName": "string",
    "policyDescription": "string",
    "rule": "string",
    "systemGenerated": true,
    "criticality": "HIGH",
    "creationTime": 0,
    "modifiedTime": 0,
    "remedialAction": "Move",
    "owners": [
      {
        "id": 0,
        "name": "string"
      }
    ],
    "assignees": [
      {
        "id": 0,
        "name": "string"
      }
    ],
    "category": "EXPIRATION",
    "violations": "string"
  },
  "violatedDatastores": "string",
  "errorCode": "NO_ERROR",
  "errorMessage": "string"
}

Bad Request

application/json

• Schema
• Example (from schema)

---

Schema

• remediationPolicyInfo object

  Remediation Policy object

  policyId int32

  Unique identifier for policy

  policyName string

  policy name

  policyDescription string

  policy description

  rule string

  Query or Rule criteria for policy

  systemGenerated boolean

  Indicating if policy is system generated or custom

  criticality string

  Possible values: [HIGH, MEDIUM, LOW]

  Criticality level

  creationTime int32

  creation time of policy

  modifiedTime int32

  modified time of policy

  remedialAction RemediationActionEnum

  Possible values: [Move, Delete]

  owners object[]

  List of users with ownership on policy

  id int32

  name string

  assignees object[]

  List of users assigned to take action on policy

  id int32

  name string

  category RemediationPolicyCategory

  Possible values: [EXPIRATION, PRIVACY, REDUNDANT]

  violations string

  xml representation of violation counts for policy

• violatedDatastores string

  comma seperated list of datastored ids

• errorCode RemediationPolicyErrorCode

  Possible values: [NO_ERROR, INVALID_INPUT, UNKNOWN_ERROR, INTERNAL_SERVER_ERROR]

• errorMessage string

{
  "remediationPolicyInfo": {
    "policyId": 0,
    "policyName": "string",
    "policyDescription": "string",
    "rule": "string",
    "systemGenerated": true,
    "criticality": "HIGH",
    "creationTime": 0,
    "modifiedTime": 0,
    "remedialAction": "Move",
    "owners": [
      {
        "id": 0,
        "name": "string"
      }
    ],
    "assignees": [
      {
        "id": 0,
        "name": "string"
      }
    ],
    "category": "EXPIRATION",
    "violations": "string"
  },
  "violatedDatastores": "string",
  "errorCode": "NO_ERROR",
  "errorMessage": "string"
}

Forbidden

application/json

• Schema
• Example (from schema)

---

Schema

• remediationPolicyInfo object

  Remediation Policy object

  policyId int32

  Unique identifier for policy

  policyName string

  policy name

  policyDescription string

  policy description

  rule string

  Query or Rule criteria for policy

  systemGenerated boolean

  Indicating if policy is system generated or custom

  criticality string

  Possible values: [HIGH, MEDIUM, LOW]

  Criticality level

  creationTime int32

  creation time of policy

  modifiedTime int32

  modified time of policy

  remedialAction RemediationActionEnum

  Possible values: [Move, Delete]

  owners object[]

  List of users with ownership on policy

  id int32

  name string

  assignees object[]

  List of users assigned to take action on policy

  id int32

  name string

  category RemediationPolicyCategory

  Possible values: [EXPIRATION, PRIVACY, REDUNDANT]

  violations string

  xml representation of violation counts for policy

• violatedDatastores string

  comma seperated list of datastored ids

• errorCode RemediationPolicyErrorCode

  Possible values: [NO_ERROR, INVALID_INPUT, UNKNOWN_ERROR, INTERNAL_SERVER_ERROR]

• errorMessage string

{
  "remediationPolicyInfo": {
    "policyId": 0,
    "policyName": "string",
    "policyDescription": "string",
    "rule": "string",
    "systemGenerated": true,
    "criticality": "HIGH",
    "creationTime": 0,
    "modifiedTime": 0,
    "remedialAction": "Move",
    "owners": [
      {
        "id": 0,
        "name": "string"
      }
    ],
    "assignees": [
      {
        "id": 0,
        "name": "string"
      }
    ],
    "category": "EXPIRATION",
    "violations": "string"
  },
  "violatedDatastores": "string",
  "errorCode": "NO_ERROR",
  "errorMessage": "string"
}

Internal Server Error

application/json

• Schema
• Example (from schema)

---

Schema

• remediationPolicyInfo object

  Remediation Policy object

  policyId int32

  Unique identifier for policy

  policyName string

  policy name

  policyDescription string

  policy description

  rule string

  Query or Rule criteria for policy

  systemGenerated boolean

  Indicating if policy is system generated or custom

  criticality string

  Possible values: [HIGH, MEDIUM, LOW]

  Criticality level

  creationTime int32

  creation time of policy

  modifiedTime int32

  modified time of policy

  remedialAction RemediationActionEnum

  Possible values: [Move, Delete]

  owners object[]

  List of users with ownership on policy

  id int32

  name string

  assignees object[]

  List of users assigned to take action on policy

  id int32

  name string

  category RemediationPolicyCategory

  Possible values: [EXPIRATION, PRIVACY, REDUNDANT]

  violations string

  xml representation of violation counts for policy

• violatedDatastores string

  comma seperated list of datastored ids

• errorCode RemediationPolicyErrorCode

  Possible values: [NO_ERROR, INVALID_INPUT, UNKNOWN_ERROR, INTERNAL_SERVER_ERROR]

• errorMessage string

{
  "remediationPolicyInfo": {
    "policyId": 0,
    "policyName": "string",
    "policyDescription": "string",
    "rule": "string",
    "systemGenerated": true,
    "criticality": "HIGH",
    "creationTime": 0,
    "modifiedTime": 0,
    "remedialAction": "Move",
    "owners": [
      {
        "id": 0,
        "name": "string"
      }
    ],
    "assignees": [
      {
        "id": 0,
        "name": "string"
      }
    ],
    "category": "EXPIRATION",
    "violations": "string"
  },
  "violatedDatastores": "string",
  "errorCode": "NO_ERROR",
  "errorMessage": "string"
}

Loading...