Skip to content

Latest commit

 

History

History
204 lines (128 loc) · 6.58 KB

PoliciesApi.md

File metadata and controls

204 lines (128 loc) · 6.58 KB

{{classname}}

All URIs are relative to /

Method HTTP request Description
CreateAccessPolicy Post /policies Create access policy
GetAccessPolicies Get /policies Get all access policies
GetAccessPolicy Get /policies/{id} Get access policy
GetAccessPolicyForResource Get /policies/{action}/{resource} Get access policy for resource
GetResources Get /policies/resources Get available resources
RemoveAccessPolicy Delete /policies/{id} Delete access policy
UpdateAccessPolicy Put /policies/{id} Update access policy

CreateAccessPolicy

AccessPolicy CreateAccessPolicy(ctx, body) Create access policy

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
body AccessPolicy The access policy configuration details.

Return type

AccessPolicy

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetAccessPolicies

[]AccessPolicy GetAccessPolicies(ctx, ) Get all access policies

Required Parameters

This endpoint does not need any parameter.

Return type

[]AccessPolicy

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetAccessPolicy

AccessPolicy GetAccessPolicy(ctx, id) Get access policy

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string The access policy id.

Return type

AccessPolicy

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetAccessPolicyForResource

AccessPolicy GetAccessPolicyForResource(ctx, action, resource) Get access policy for resource

Gets an access policy for the specified action and resource

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
action string The request action.
resource string The resource of the policy.

Return type

AccessPolicy

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetResources

[]Resource GetResources(ctx, ) Get available resources

Gets the available resources that support access/authorization policies

Required Parameters

This endpoint does not need any parameter.

Return type

[]Resource

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RemoveAccessPolicy

AccessPolicy RemoveAccessPolicy(ctx, version, id, optional) Delete access policy

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
version LongParameter The version is used to verify the client is working with the latest version of the entity.
id string The access policy id.
optional *PoliciesApiRemoveAccessPolicyOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a PoliciesApiRemoveAccessPolicyOpts struct

Name Type Description Notes

clientId | optional.Interface of ClientIdParameter| If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response. |

Return type

AccessPolicy

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateAccessPolicy

AccessPolicy UpdateAccessPolicy(ctx, body, id) Update access policy

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
body AccessPolicy The access policy configuration details.
id string The access policy id.

Return type

AccessPolicy

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]