IAM Policy Management API - IBM Cloud API Docs

Introduction

With the IAM Policy Management API you can create, update, view, and delete IAM policies. An IAM policy enables a subject to access a resource. These policies are used in access decisions when calling APIs for IAM enabled services. More details on IAM can be found at: IBM Cloud Identity and Access Management.

There are three primary values in a policy. The subject, roles, and resources.

The subject describes who is being granted access. The subject can be an iam_id or an access group id.
The iam_id of the entity that you are giving access to. This can be a user or a service id. The access group id is the id of the access group. An access group contains a set of users or service ids. Access groups are the preferred method of managing access control. See: Setting up access groups or IAM Access Groups.

Example format for supported subject types

Type	Attribute name	Attribute value format example
User	iam_id	`IBMid-123456...`
Service ID	iam_id	`iam-ServiceId-12345...`
Access Group	access_group_id	`AccessGroupId-12345...`

Two types of policies are supported access policies and authorization policies. These are described in more detail here: Create a policy

A role is a collection of actions that can be taken on a resource. Role details can be found here: IBM Cloud Identity and Access Management

Error Handling

The Policy Management APIs return standard HTTP status codes to indicate the success or failure of a request. The format of the response is represented in JSON as follows:

{
    "trace": "cd4f7573121a4cf99f0079f8482b3d6b",
    "errors": [
        {
            "code": "invalid_token",
            "message": "The provided IAM token is invalid."
        }
    ],
    "status_code": 401
}

If an operation cannot be fulfilled, an appropriate 400 or 500 series HTTP response is returned from the server. The operations defined in the Reference section describe example errors that can be returned from a failed request. All responses from the IAM Policy Management API are in the JSON format.

Here are potential error codes that the API can return.

HTTP Error Code	Description	Recovery
`200`	Success	The request was successful.
`201`	Created	The resource was successfully created.
`204`	No Content	The request was successful. No response body is provided.
`400`	Bad Request	The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request.
`401`	Unauthorized	You are not authorized to make this request. The token is either invalid, missing or expired. Get a new valid token and try again.
`403`	Forbidden	The token is valid, but the subject of the token is not authorized to perform the operation. If this error persists, contact the account owner to check your permissions.
`404`	Not Found	The requested resource could not be found.
`409`	Conflict	The entity is already in the requested state.
`415`	Unsupported Media Type	Request body sent was formatted using an unsupported media type.
`429`	Too Many Requests	Too many requests have been made within a given time window. Wait the time in seconds indicated in the `Retry-After` response header before calling the API again.
`500`	Service Unavailable	IAM Policy Management Point is currently unavailable. Your request could not be processed. Wait a few minutes and try again.

Authentication

Authorization to the IAM Policy Management API is enforced by using an IAM Access Token. The token is used to validate the identity of the caller and verify access to IAM API services. Obtaining an IAM Token for an authenticated User or Service ID is captured in the IAM Identity Service documentation.

Use of the IAM Policy Management REST API is done by adding a valid IAM Token to the HTTP Authorization request header. Example: -H 'Authorization: Bearer $TOKEN'

Additional headers

Some additional headers might be required to make successful requests to the API. Those additional headers are:

Transaction-Id:

An optional transaction id can be passed to your request, which can be useful for tracking calls through multiple services using one identifier. The header key must be set to Transaction-Id and the value is anything that you choose.

If no transaction id is passed in, then a random id is generated.

Rate limiting

A response with status "429 Too Many Requests" is returned if too many requests are made within a given time window. The response includes a Retry-After header to indicate the time in seconds to wait before sending the next request.

When working with the Policy Management API, it may be helpful to be aware of other IAM services. View Identity Service to learn about api key, service ID, and token creation. View Access groups to create groups and manage memberships.

Get policies by attributes

Get policies and filter by attributes. While managing policies, you may want to retrieve policies in the account and filter by attribute values. This can be done through query parameters. Currently, we only support the following attributes: account_id, iam_id, access_group_id, type, and service_type. account_id is a required query parameter. Only policies that have the specified attributes and that the caller has read access to are returned. If the caller does not have read access to any policies an empty array is returned.

GET /v1/policies

/v1/policies

Request

Custom Headers

Accept-Language
string
Translation language code

Query Parameters

account_id
string
The account guid in which the policies belong to.
iam_id
string
The IAM ID used to identify the subject.
access_group_id
string
The access group id.
type
string
The type of policy (access or authorization).
service_type
string
The type of service.

```
curl -X GET \
'https://iam.cloud.ibm.com/v1/policies?account_id=$ACCOUNT_ID' \
-H 'Authorization: Bearer $TOKEN'\
-H 'Content-Type: application/json'
```

Response

Response Body

policy_list

A list of policies.

Status Code

200
Policies retrieval successful.
400
The request you made is not valid.
401
The token you provided is not valid.
406
The requested resource(s) cannot be formatted using the requested media type(s).
429
Too many requests have been made within a given time window.

Example responses

Status 200

{
  "policies": [
    {
      "id": "12345678-abcd-1a2b-a1b2-1234567890ab",
      "type": "access",
      "subjects": [
        {
          "attributes": [
            {
              "name": "iam_id",
              "value": "IBMid-123453user"
            }
          ]
        }
      ],
      "roles": [
        {
          "roles_id": "crn:v1:bluemix:public:iam::::role:Viewer"
        }
      ],
      "resources": [
        {
          "attributes": [
            {
              "name": "accountId",
              "value": "ACCOUNT_ID"
            },
            {
              "name": "serviceName",
              "value": "SERVICE_NAME"
            }
          ]
        }
      ],
      "href": "https://iam.cloud.ibm.com/v1/policies/12345678-abcd-1a2b-a1b2-1234567890ab",
      "created_at": "2018-08-30T14:09:09.907Z",
      "created_by_id": "USER ID",
      "last_modified_at": "2018-08-30T14:09:09.907Z",
      "last_modified_by_id": "USER ID"
    }
  ]
}{
  "policies": [
    {
      "id": "12345678-abcd-1a2b-a1b2-1234567890ab",
      "type": "access",
      "subjects": [
        {
          "attributes": [
            {
              "name": "iam_id",
              "value": "IBMid-123453user"
            }
          ]
        }
      ],
      "roles": [
        {
          "roles_id": "crn:v1:bluemix:public:iam::::role:Viewer"
        }
      ],
      "resources": [
        {
          "attributes": [
            {
              "name": "accountId",
              "value": "ACCOUNT_ID"
            },
            {
              "name": "serviceName",
              "value": "SERVICE_NAME"
            }
          ]
        }
      ],
      "href": "https://iam.cloud.ibm.com/v1/policies/12345678-abcd-1a2b-a1b2-1234567890ab",
      "created_at": "2018-08-30T14:09:09.907Z",
      "created_by_id": "USER ID",
      "last_modified_at": "2018-08-30T14:09:09.907Z",
      "last_modified_by_id": "USER ID"
    }
  ]
}

{ "trace": "f23a0d5d3835406bb4a946b7e017600a", "errors": [ { "code": "missing_required_query_parameter", "message": "'account_id' is a required query parameter" } ], "status_code": 400 }
{ "trace": "12345678-abcd-1a2b-a1b2-1234567890ab", "errors": [ { "code": "invalid_token", "message": "The provided IAM token is invalid." } ], "status_code": 401 }
{ "trace": "cb2a0d5d3835406bb4a946b7e017600a", "errors": [ { "code": "unable_to_process", "message": "The requested resource(s) can only be formatted using the 'application/json' media type." } ], "status_code": 406 }
{ "trace": "12345678-abcd-1a2b-a1b2-1234567890ab", "errors": [ { "code": "too_many_requests", "message": "Too many requests." } ], "status_code": 429 }

Create a policy

Creates a policy to grant access between a subject and a resource. There are two types of policies: access and authorization. A policy administrator might want to create an access policy which grants access to a user, service-id, or an access group. They might also want to create an authorization policy and setup access between services.

Access

To create an access policy, use "type": "access" in the body. The possible subject attributes are iam_id and access_group_id. Use the iam_id subject attribute for assigning access for a user or service-id. Use the access_group_id subject attribute for assigning access for an access group. The roles must be a subset of a service's or the platform's supported roles. The resource attributes must be a subset of a service's or the platform's supported attributes. The policy resource must include either the serviceType, serviceName, or resourceGroupId attribute and the accountId attribute.` If the subject is a locked service-id, the request will fail.

Authorization

Authorization policies are supported by services on a case by case basis. Refer to service documentation to verify their support of authorization policies. To create an authorization policy, use "type": "authorization" in the body. The subject attributes must match the supported authorization subjects of the resource. Multiple subject attributes might be provided. The following attributes are supported: serviceName, serviceInstance, region, resourceType, resource, accountId The policy roles must be a subset of the supported authorization roles supported by the target service. The user must also have the same level of access or greater to the target resource in order to grant the role. The resource attributes must be a subset of a service's or the platform's supported attributes. Both the policy subject and the policy resource must include the serviceName and accountId attributes.

POST /v1/policies

/v1/policies

Request

Request Body

policy_request

A policy to be created.

Example request

curl -X POST \
'https://iam.cloud.ibm.com/v1/policies' \
-H 'Authorization: $TOKEN'\
-H 'Content-Type: application/json'\
-d '{
  "type": "access",
  "subjects": [
    {
      "attributes": [
        {
          "name": "iam_id",
          "value": "IBMid-123453user"
        }
      ]
    }'
  ],
  "roles":[
    {
      "role_id": "crn:v1:bluemix:public:iam::::role:Editor"
    }
  ],
  "resources":[
    {
      "attributes": [
        {
          "name": "accountId",
          "value": "$ACCOUNT_ID"
        },
        {
          "name": "serviceName",
          "value": "$SERVICE_NAME"
        }
      ]
    }
  ]
}'curl -X POST \
'https://iam.cloud.ibm.com/v1/policies' \
-H 'Authorization: $TOKEN'\
-H 'Content-Type: application/json'\
-d '{
  "type": "access",
  "subjects": [
    {
      "attributes": [
        {
          "name": "iam_id",
          "value": "IBMid-123453user"
        }
      ]
    }'
  ],
  "roles":[
    {
      "role_id": "crn:v1:bluemix:public:iam::::role:Editor"
    }
  ],
  "resources":[
    {
      "attributes": [
        {
          "name": "accountId",
          "value": "$ACCOUNT_ID"
        },
        {
          "name": "serviceName",
          "value": "$SERVICE_NAME"
        }
      ]
    }
  ]
}'

Response

Response Body

policy

Policy.

Status Code

201
Policy creation successful.
400
Policy input is invalid.
401
The token you provided is not valid.
403
You do not have access to create the policy.
406
The requested resource(s) cannot be formatted using the requested media type(s).
409
A policy already exists for the given subject and resource. You can update that policy or delete it and create a new one.
415
Request body sent was formatted using an unsupported media type.
429
Too many requests have been made within a given time window.

Example responses

Status 201

{
  "id": "12345678-abcd-1a2b-a1b2-1234567890ab",
  "type": "access",
  "subjects": [
    {
      "attributes": [
        {
          "name": "iam_id",
          "value": "IBMid-123453user"
        }
      ]
    }
  ],
  "roles": [
    {
      "roles_id": "crn:v1:bluemix:public:iam::::role:Viewer"
    }
  ],
  "resources": [
    {
      "attributes": [
        {
          "name": "accountId",
          "value": "ACCOUNT_ID"
        },
        {
          "name": "serviceName",
          "value": "SERVICE_NAME"
        }
      ]
    }
  ],
  "href": "https://iam.cloud.ibm.com/v1/policies/12345678-abcd-1a2b-a1b2-1234567890ab",
  "created_at": "2018-08-30T14:09:09.907Z",
  "created_by_id": "USER ID",
  "last_modified_at": "2018-08-30T14:09:09.907Z",
  "last_modified_by_id": "USER ID"
}{
  "id": "12345678-abcd-1a2b-a1b2-1234567890ab",
  "type": "access",
  "subjects": [
    {
      "attributes": [
        {
          "name": "iam_id",
          "value": "IBMid-123453user"
        }
      ]
    }
  ],
  "roles": [
    {
      "roles_id": "crn:v1:bluemix:public:iam::::role:Viewer"
    }
  ],
  "resources": [
    {
      "attributes": [
        {
          "name": "accountId",
          "value": "ACCOUNT_ID"
        },
        {
          "name": "serviceName",
          "value": "SERVICE_NAME"
        }
      ]
    }
  ],
  "href": "https://iam.cloud.ibm.com/v1/policies/12345678-abcd-1a2b-a1b2-1234567890ab",
  "created_at": "2018-08-30T14:09:09.907Z",
  "created_by_id": "USER ID",
  "last_modified_at": "2018-08-30T14:09:09.907Z",
  "last_modified_by_id": "USER ID"
}

{ "trace": "b62f8b6764c44a97975cbef65041ce74", "errors": [ { "code": "invalid_body", "message": "The following role(s) had multiple entries: crn:v1:bluemix:public:iam::::role:Viewer" } ], "status_code": 400 }
{ "trace": "12345678-abcd-1a2b-a1b2-1234567890ab", "errors": [ { "code": "invalid_token", "message": "The provided IAM token is invalid." } ], "status_code": 401 }
{ "trace": "a0ef9bfadddb419aa0ff3844023d4421", "errors": [ { "code": "insufficent_permissions", "message": "You are not allowed to create the requested policy." } ], "status_code": 403 }
{ "trace": "cb2a0d5d3835406bb4a946b7e017600a", "errors": [ { "code": "unable_to_process", "message": "The requested resource(s) can only be formatted using the 'application/json' media type." } ], "status_code": 406 }

Status 409

{
  "trace": "a0ef9bfadddb419aa0ff3844023d4421",
  "errors": [
    {
      "code": "policy_conflict_error",
      "message": "Failed to create policy.",
      "details": {
        "conflicts_with": {
          "etag": "1-847833cec3bf3f3c3231d8f9492febac",
          "policy": "POLICY"
        }
      },
      "status_code": 409
    }
  ]
}{
  "trace": "a0ef9bfadddb419aa0ff3844023d4421",
  "errors": [
    {
      "code": "policy_conflict_error",
      "message": "Failed to create policy.",
      "details": {
        "conflicts_with": {
          "etag": "1-847833cec3bf3f3c3231d8f9492febac",
          "policy": "POLICY"
        }
      },
      "status_code": 409
    }
  ]
}

{ "trace": "64e9d4d538a9433982d1d97304ce05f6", "errors": [ { "code": "unsupported_content_type", "message": "The supported media type for this API is 'application/json'." } ], "status_code": 415 }
{ "trace": "12345678-abcd-1a2b-a1b2-1234567890ab", "errors": [ { "code": "too_many_requests", "message": "Too many requests." } ], "status_code": 429 }

Update a policy

Update a policy to grant access between a subject and a resource. A policy administrator might want to update an existing policy. The policy type cannot be changed (You cannot change an access policy to an authorization policy).

Access

To update an access policy, use "type": "access" in the body. The possible subject attributes are iam_id and access_group_id. Use the iam_id subject attribute for assigning access for a user or service-id. Use the access_group_id subject attribute for assigning access for an access group. The roles must be a subset of a service's or the platform's supported roles. The resource attributes must be a subset of a service's or the platform's supported attributes. The policy resource must include either the serviceType, serviceName, or resourceGroupId attribute and the accountId attribute.` If the subject is a locked service-id, the request will fail.

Authorization

To update an authorization policy, use "type": "authorization" in the body. The subject attributes must match the supported authorization subjects of the resource. Multiple subject attributes might be provided. The following attributes are supported: serviceName, serviceInstance, region, resourceType, resource, accountId The policy roles must be a subset of the supported authorization roles supported by the target service. The user must also have the same level of access or greater to the target resource in order to grant the role. The resource attributes must be a subset of a service's or the platform's supported attributes. Both the policy subject and the policy resource must include the serviceName and accountId attributes.

PUT /v1/policies/{policy_id}

/v1/policies/{policy_id}

Request

Custom Headers

If-Match
string
The revision number for updating a policy and must match the ETag value of the existing policy. The Etag can be retrieved using the GET /v1/policies/{policy_id} API and looking at the ETag response header.

Path Parameters

policy_id
string
The policy ID

Request Body

policy_request

Updated policy content to be saved.

Example request

curl -X PUT \
'https://iam.cloud.ibm.com/v1/policies' \
-H 'Authorization: Bearer $TOKEN'\
-H 'Content-Type: application/json'\
-H 'If-Match: $ETAG'\
-d '{
  "type": "access",
  "subjects": [
    {
      "attributes": [
        {
          "name": "iam_id",
          "value": "IBMid-123453user"
        }
      ]
    }'
  ],
  "roles":[
    {
      "role_id": "crn:v1:bluemix:public:iam::::role:Viewer"
    }
  ],
  "resources":[
    {
      "attributes": [
        {
          "name": "accountId",
          "value": "$ACCOUNT_ID"
        },
        {
          "name": "serviceName",
          "value": "$SERVICE_NAME"
        }
      ]
    }
  ]
}'curl -X PUT \
'https://iam.cloud.ibm.com/v1/policies' \
-H 'Authorization: Bearer $TOKEN'\
-H 'Content-Type: application/json'\
-H 'If-Match: $ETAG'\
-d '{
  "type": "access",
  "subjects": [
    {
      "attributes": [
        {
          "name": "iam_id",
          "value": "IBMid-123453user"
        }
      ]
    }'
  ],
  "roles":[
    {
      "role_id": "crn:v1:bluemix:public:iam::::role:Viewer"
    }
  ],
  "resources":[
    {
      "attributes": [
        {
          "name": "accountId",
          "value": "$ACCOUNT_ID"
        },
        {
          "name": "serviceName",
          "value": "$SERVICE_NAME"
        }
      ]
    }
  ]
}'

Response

Response Body

policy

Policy.

Status Code

200
Policy update successful.
400
Policy input is invalid.
401
The token you provided is not valid.
403
You do not have access to update the policy.
406
The requested resource(s) cannot be formatted using the requested media type(s).
409
A policy already exists for the given subject and resource. You can update that policy or delete it and create a new one.
415
Request body sent was formatted using an unsupported media type.
429
Too many requests have been made within a given time window.

Example responses

Status 200

{
  "id": "12345678-abcd-1a2b-a1b2-1234567890ab",
  "type": "access",
  "subjects": [
    {
      "attributes": [
        {
          "name": "iam_id",
          "value": "IBMid-123453user"
        }
      ]
    }
  ],
  "roles": [
    {
      "roles_id": "crn:v1:bluemix:public:iam::::role:Viewer"
    }
  ],
  "resources": [
    {
      "attributes": [
        {
          "name": "accountId",
          "value": "ACCOUNT_ID"
        },
        {
          "name": "serviceName",
          "value": "SERVICE_NAME"
        }
      ]
    }
  ],
  "href": "https://iam.cloud.ibm.com/v1/policies/12345678-abcd-1a2b-a1b2-1234567890ab",
  "created_at": "2018-08-30T14:09:09.907Z",
  "created_by_id": "USER ID",
  "last_modified_at": "2018-08-30T14:09:09.907Z",
  "last_modified_by_id": "USER ID"
}{
  "id": "12345678-abcd-1a2b-a1b2-1234567890ab",
  "type": "access",
  "subjects": [
    {
      "attributes": [
        {
          "name": "iam_id",
          "value": "IBMid-123453user"
        }
      ]
    }
  ],
  "roles": [
    {
      "roles_id": "crn:v1:bluemix:public:iam::::role:Viewer"
    }
  ],
  "resources": [
    {
      "attributes": [
        {
          "name": "accountId",
          "value": "ACCOUNT_ID"
        },
        {
          "name": "serviceName",
          "value": "SERVICE_NAME"
        }
      ]
    }
  ],
  "href": "https://iam.cloud.ibm.com/v1/policies/12345678-abcd-1a2b-a1b2-1234567890ab",
  "created_at": "2018-08-30T14:09:09.907Z",
  "created_by_id": "USER ID",
  "last_modified_at": "2018-08-30T14:09:09.907Z",
  "last_modified_by_id": "USER ID"
}

{ "trace": "a0ef9bfadddb419aa0ff3844023d4421", "errors": [ { "code": "invalid_body", "message": "A policy's type cannot be updated. Create a new policy and delete the existing one." } ], "status_code": 400 }
{ "trace": "12345678-abcd-1a2b-a1b2-1234567890ab", "errors": [ { "code": "invalid_token", "message": "The provided IAM token is invalid." } ], "status_code": 401 }
{ "trace": "6e25f4459c84467ab6923fa276428bd8", "errors": [ { "code": "insufficent_permissions", "message": "You are not allowed to update the requested policy." } ], "status_code": 403 }
{ "trace": "cb2a0d5d3835406bb4a946b7e017600a", "errors": [ { "code": "unable_to_process", "message": "The requested resource(s) can only be formatted using the 'application/json' media type." } ], "status_code": 406 }

Status 409

{
  "trace": "38e538a321a24bde9323a88ced8f8c98",
  "errors": [
    {
      "code": "policy_conflict_error",
      "message": "Failed to update policy.",
      "details": {
        "conflicts_with": {
          "etag": "1-847833cec3bf3f3c3231d8f9492febac",
          "policy": "POLICY"
        }
      },
      "status_code": 409
    }
  ]
}{
  "trace": "38e538a321a24bde9323a88ced8f8c98",
  "errors": [
    {
      "code": "policy_conflict_error",
      "message": "Failed to update policy.",
      "details": {
        "conflicts_with": {
          "etag": "1-847833cec3bf3f3c3231d8f9492febac",
          "policy": "POLICY"
        }
      },
      "status_code": 409
    }
  ]
}

{ "trace": "64e9d4d538a9433982d1d97304ce05f6", "errors": [ { "code": "unsupported_content_type", "message": "The supported media type for this API is 'application/json'." } ], "status_code": 415 }
{ "trace": "12345678-abcd-1a2b-a1b2-1234567890ab", "errors": [ { "code": "too_many_requests", "message": "Too many requests." } ], "status_code": 429 }

Retrieve a policy by ID

Retrieve a policy by providing a policy ID.

GET /v1/policies/{policy_id}

/v1/policies/{policy_id}

Request

Path Parameters

policy_id
string
The policy ID

```
curl -X GET \
'https://iam.cloud.ibm.com/v1/policies/$POLICY_ID' \
-H 'Authorization: Bearer $TOKEN'\
-H 'Content-Type: application/json'
```

Response

Response Body

policy

Policy.

Status Code

200
Policy retrieval successful.
401
The token you provided is not valid.
403
You do not have access to retrieve the policy.
404
Policy was not found.
406
The requested resource(s) cannot be formatted using the requested media type(s).
429
Too many requests have been made within a given time window.

Example responses

Status 200

{
  "id": "12345678-abcd-1a2b-a1b2-1234567890ab",
  "type": "access",
  "subjects": [
    {
      "attributes": [
        {
          "name": "iam_id",
          "value": "IBMid-123453user"
        }
      ]
    }
  ],
  "roles": [
    {
      "roles_id": "crn:v1:bluemix:public:iam::::role:Viewer"
    }
  ],
  "resources": [
    {
      "attributes": [
        {
          "name": "accountId",
          "value": "ACCOUNT_ID"
        },
        {
          "name": "serviceName",
          "value": "SERVICE_NAME"
        }
      ]
    }
  ],
  "href": "https://iam.cloud.ibm.com/v1/policies/12345678-abcd-1a2b-a1b2-1234567890ab",
  "created_at": "2018-08-30T14:09:09.907Z",
  "created_by_id": "USER ID",
  "last_modified_at": "2018-08-30T14:09:09.907Z",
  "last_modified_by_id": "USER ID"
}{
  "id": "12345678-abcd-1a2b-a1b2-1234567890ab",
  "type": "access",
  "subjects": [
    {
      "attributes": [
        {
          "name": "iam_id",
          "value": "IBMid-123453user"
        }
      ]
    }
  ],
  "roles": [
    {
      "roles_id": "crn:v1:bluemix:public:iam::::role:Viewer"
    }
  ],
  "resources": [
    {
      "attributes": [
        {
          "name": "accountId",
          "value": "ACCOUNT_ID"
        },
        {
          "name": "serviceName",
          "value": "SERVICE_NAME"
        }
      ]
    }
  ],
  "href": "https://iam.cloud.ibm.com/v1/policies/12345678-abcd-1a2b-a1b2-1234567890ab",
  "created_at": "2018-08-30T14:09:09.907Z",
  "created_by_id": "USER ID",
  "last_modified_at": "2018-08-30T14:09:09.907Z",
  "last_modified_by_id": "USER ID"
}

{ "trace": "12345678-abcd-1a2b-a1b2-1234567890ab", "errors": [ { "code": "invalid_token", "message": "The provided IAM token is invalid." } ], "status_code": 401 }
{ "trace": "g3c529cc338a4cdab4b04831f5aeb23e", "errors": [ { "code": "insufficent_permissions", "message": "You are not allowed to retrieve the requested policy." } ], "status_code": 403 }
{ "trace": "f3c529cc338a4cdab4b04831f5aeb23e", "errors": [ { "code": "policy_not_found", "message": "Policy with Id POLICY_ID not found." } ], "status_code": 404 }
{ "trace": "cb2a0d5d3835406bb4a946b7e017600a", "errors": [ { "code": "unable_to_process", "message": "The requested resource(s) can only be formatted using the 'application/json' media type." } ], "status_code": 406 }
{ "trace": "12345678-abcd-1a2b-a1b2-1234567890ab", "errors": [ { "code": "too_many_requests", "message": "Too many requests." } ], "status_code": 429 }

Delete a policy by ID

Delete a policy by providing a policy ID. A policy cannot be deleted if the subject ID contains a locked service ID. If the subject of the policy is a locked service-id, the request will fail.

DELETE /v1/policies/{policy_id}

/v1/policies/{policy_id}

Request

Path Parameters

policy_id
string
The policy ID

```
curl -X DELETE \
'https://iam.cloud.ibm.com/v1/policies/$POLICY_ID' \
-H 'Authorization: Bearer $TOKEN'\
-H 'Content-Type: application/json'
```

Response

Status Code

204
Policy deletion successful.
400
Policy was not valid to delete.
401
The token you provided is not valid.
403
You do not have access to delete the policy.
404
Policy was not found.
429
Too many requests have been made within a given time window.

Example responses

{ "trace": "26f0b2491ed6425c9e7b0c08a3a645f7", "errors": [ { "code": "invalid_body", "message": "Request includes a locked service id, cannot perform action" } ], "status_code": 400 }
{ "trace": "12345678-abcd-1a2b-a1b2-1234567890ab", "errors": [ { "code": "invalid_token", "message": "The provided IAM token is invalid." } ], "status_code": 401 }
{ "trace": "26f0b2491ed6425c9e7b0c08a3a645f7", "errors": [ { "code": "insufficent_permissions", "message": "You are not allowed to delete the requested policy." } ], "status_code": 403 }
{ "trace": "9b4b2751c6dc4c91af4b209177f4be88", "errors": [ { "code": "policy_not_found", "message": "Policy with Id POLICY_ID not found." } ], "status_code": 404 }
{ "trace": "12345678-abcd-1a2b-a1b2-1234567890ab", "errors": [ { "code": "too_many_requests", "message": "Too many requests." } ], "status_code": 429 }

Introduction

Error Handling

Authentication

Additional headers

Transaction-Id:

Rate limiting

Related APIs

Methods

Get policies by attributes

Custom Headers

Accept-Language

Query Parameters

account_id

iam_id

access_group_id

type

service_type

Response Body

policies

Status Code

200

400

401

406

429

Create a policy

Access

Authorization

Request Body

type

subjects

roles

resources

Response Body

id

type

subjects

roles

resources

href

created_by_id

created_at

last_modified_by_id

last_modified_at

Status Code

201

400

401

403

406

409

415

429

Update a policy

Access

Authorization

Custom Headers

If-Match

Path Parameters

policy_id

Request Body

type

subjects

roles

resources

Response Body

id

type

subjects

roles

resources

href

created_by_id

created_at

last_modified_by_id

last_modified_at

Status Code

200

400

401