Applying a Policy to a Vault¶

Function¶

This API is used to apply a policy to a vault.

URI¶

POST /v3/{project_id}/vaults/{vault_id}/associatepolicy

**Table 1** Path Parameters¶
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID
vault_id	Yes	String	Vault ID

Request Parameters¶

**Table 2** Request header parameters¶
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

**Table 3** Request body parameters¶
Parameter	Mandatory	Type	Description
policy_id	No	String	Policy ID.

Response Parameters¶

Status code: 200

**Table 4** Response body parameters¶
Parameter	Type	Description
associate_policy	VaultPolicyResp object	Details of applying a policy to a vault

**Table 5** VaultPolicyResp¶
Parameter	Type	Description
policy_id	String	Configured policy ID
vault_id	String	Vault ID for configuring the policy ID

Example Requests¶

POST https://{endpoint}/v3/f841e01fd2b14e7fa41b6ae7aa6b0594/vaults/79bd9daa-884f-4f84-b8fe-235d58cd927d/associatepolicy

{
  "policy_id" : "7075c397-25a0-43e2-a83a-bb16eaca3ee5"
}

Example Responses¶

Status code: 200

{
  "associate_policy" : {
    "vault_id" : "2402058d-8373-4b0a-b848-d3c0dfdc71a8",
    "policy_id" : "7075c397-25a0-43e2-a83a-bb16eaca3ee5"
  }
}

Status Codes¶

Status Code	Description
200	OK

Error Codes¶

See Error Codes.

last updated: 2024-11-13 13:44 UTC - commit: bd2d1958eaead4a18cca4ca43ac601bab2a34dcb