Update Policy
  • PDF

Update Policy

  • PDF

  • Update a policy.

API

  • PUT /policies/{policyId}

Request

Path Variables

Parameter Requirement status Type Restrictions Description
policyId Y string Policy ID

Body

{
  "policyName": "string",
  "description": "string",
  "permissions": [
    {
      "effect": "string",
      "targets": [
        {
          "product": "string",
          "actions": [
            "string"
          ],
          "resourceNrns": [
            "string"
          ]
        }
      ]
    }
  ]
}
Parameter Requirement status Type Restrictions Description
policyName Y string Policy name
description Y string Policy description
permissions Y array Permission list
permissions.effect Y string Permission status (currently only supports Allow)
permissions.targets Y array Permission target
permissions.targets.product Y string Target product code
permissions.targets.actions Y array Target action
permissions.targets.resourceNrns Y array Target resource nrns

Response

  • Response
{
  "policyId": "string",
  "policyName": "string",
  "description": "string",
  "validationResult": {
    "details": [
      {
        "code": "string",
        "location": "string",
        "message": "string",
        "type": "ERROR"
      }
    ],
    "success": true
  }
}
Parameter name Requirement status Type Description
policyId N string Policy ID
policyName N string Policy name
description N string Policy description
validationResult Y object Policy creation success status
validationResult.success Y boolean Policy creation success status
validationResult.details N array Validity check result details
validationResult.details.code N string Validity check detailed code
validationResult.details.location N string Validity check location
validationResult.details.message N string Validity check detailed message
validationResult.details.type N string Validity check result type (INFO, WARN, ERROR), failure when ERROR is included
  • Response example - Success
{
  "policyId": "000000000-qwer-asdf-123456789012",
  "policyName": "policy-test",
  "description": "policy test ",
  "validationResult": {
    "success": true
  }
}
  • Response example - Failure
{
  "validationResult": {
    "success": false,
    "details": [
      {
        "type": "ERROR",
        "code": "iam.policy.invalidName.length.max",
        "location": "policyName",
        "message": "Policy name field must be less than 30 characters."
      },
      {
        "type": "ERROR",
        "code": "iam.error.requiredFieldIsMissing",
        "location": "permissions",
        "message": "The required value is missing."
      }
    ]
  }
}

Was this article helpful?

What's Next