All URIs are relative to http://localhost
| Method | HTTP request | Description |
|---|---|---|
| AddPolicy | Post /policies | Add a new policy |
| DeletePolicy | Delete /policies/{policyId} | Delete policy |
| GetPolicy | Get /policies/{policyId} | Get specific policy |
| ListPolicies | Get /policies | List policies |
| UpdatePolicy | Put /policies/{policyId} | Update policy |
PolicyBundleRecord AddPolicy(ctx, bundle, optional)
Add a new policy
Adds a new policy bundle to the system
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| bundle | PolicyBundle | ||
| optional | *AddPolicyOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a AddPolicyOpts struct
| Name | Type | Description | Notes |
|---|
xAnchoreAccount | optional.String| An account name to change the resource scope of the request to that account, if permissions allow (admin only) |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DeletePolicy(ctx, policyId, optional)
Delete policy
Delete the specified policy
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| policyId | string | ||
| optional | *DeletePolicyOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a DeletePolicyOpts struct
| Name | Type | Description | Notes |
|---|
xAnchoreAccount | optional.String| An account name to change the resource scope of the request to that account, if permissions allow (admin only) |
(empty response body)
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
[]PolicyBundleRecord GetPolicy(ctx, policyId, optional)
Get specific policy
Get the policy bundle content
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| policyId | string | ||
| optional | *GetPolicyOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a GetPolicyOpts struct
| Name | Type | Description | Notes |
|---|
detail | optional.Bool| Include policy bundle detail in the form of the full bundle content for each entry | xAnchoreAccount | optional.String| An account name to change the resource scope of the request to that account, if permissions allow (admin only) |
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
[]PolicyBundleRecord ListPolicies(ctx, optional)
List policies
List all saved policy bundles
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| optional | *ListPoliciesOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a ListPoliciesOpts struct
| Name | Type | Description | Notes |
|---|---|---|---|
| detail | optional.Bool | Include policy bundle detail in the form of the full bundle content for each entry | |
| xAnchoreAccount | optional.String | An account name to change the resource scope of the request to that account, if permissions allow (admin only) |
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
[]PolicyBundleRecord UpdatePolicy(ctx, policyId, bundle, optional)
Update policy
Update/replace and existing policy
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| policyId | string | ||
| bundle | PolicyBundleRecord | ||
| optional | *UpdatePolicyOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a UpdatePolicyOpts struct
| Name | Type | Description | Notes |
|---|
active | optional.Bool| Mark policy as active | xAnchoreAccount | optional.String| An account name to change the resource scope of the request to that account, if permissions allow (admin only) |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]