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
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
project_id |
Yes |
String |
Project ID. Default value: N/A |
|
vault_id |
Yes |
String |
Vault ID. Default value: N/A |
Request Parameters
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
X-Auth-Token |
Yes |
String |
User token. You can obtain it by calling the IAM API for obtaining a user token. The user token is the value of X-Subject-Token in the response header. Default value: N/A |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
destination_vault_id |
No |
String |
Destination vault ID. This parameter is mandatory only when a replication policy is set. Default value: N/A |
|
policy_id |
No |
String |
Policy ID. Default value: N/A Specify either policy_id or add_policy_ids. |
|
add_policy_ids |
No |
Array of strings |
IDs of new policies associated in the multi-policy scenario. Specify either policy_id or add_policy_ids. Default value: N/A |
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
associate_policy |
VaultPolicyResp object |
Details of applying a policy to a vault |
Example Requests
Applying a policy to a vault
POST https://{endpoint}/v3/f841e01fd2b14e7fa41b6ae7aa6b0594/vaults/79bd9daa-884f-4f84-b8fe-235d58cd927d/associatepolicy
{
"policy_id" : "7075c397-25a0-43e2-a83a-bb16eaca3ee5"
}
Example Responses
Status code: 200
OK
{
"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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.
