Skip to content

Latest commit

 

History

History
160 lines (86 loc) · 3.65 KB

PolicyApi.md

File metadata and controls

160 lines (86 loc) · 3.65 KB
Raw

\PolicyApi

All URIs are relative to http://localhost

Method HTTP request Description
CreatePolicy Post /policies
DeletePolicy Delete /policies/{id}
GetPolicy Get /policies/{id}
ListPolicies Get /policies
UpdatePolicy Put /policies/{id}

CreatePolicy

Policy CreatePolicy($body)

Create an Access Control Policy

Parameters

Name Type Description Notes
body Policy [optional]

Return type

Policy

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]

DeletePolicy

DeletePolicy($id)

Delete an Access Control Policy

Parameters

Name Type Description Notes
id string The id of the policy.

Return type

void (empty response body)

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]

GetPolicy

Policy GetPolicy($id)

Get an Access Control Policy

Parameters

Name Type Description Notes
id string The id of the policy.

Return type

Policy

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]

ListPolicies

[]Policy ListPolicies($offset, $limit)

List Access Control Policies

Parameters

Name Type Description Notes
offset int64 The offset from where to start looking. [optional]
limit int64 The maximum amount of policies returned. [optional]

Return type

[]Policy

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]

UpdatePolicy

Policy UpdatePolicy($id, $body)

Update an Access Control Policy

Parameters

Name Type Description Notes
id string The id of the policy.
body Policy [optional]

Return type

Policy

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]