openstack/keystone
Code Issues Proposed changes
Files
4f183727f18f9183426e930543f01fc82cd32411
keystone/api-ref/source/v3-ext/identity_v3_OS-ENDPOINT-POLICY-ext.inc
Samuel de Medeiros Queiroz 038c0e35ca Migrate identity /v3-ext docs from api-ref repo 
Docs at [1] have already been converted from WADL (SGML / XML) to RST
using fairy-slipper [2].

This commit polish the results from the conversion and migrate the v3
extension docs to our repository under 'api-ref/source' directory. It
also removes the OS-KDS docs, given it does not exist anymore. Missing
parameters definitions were added.

The API examples for the extensions were moved into '/v3-ext/samples'.

Polishing the generated RST files include:
- Removing unnecessary blank lines;
- Removing empty references.

Polishing the generated RST files do not include:
- Modifying their content;
- Modifying file names;
- Wrapping lines at the maximum of 79 chars.

Updating the documentation will be done after this migration step.

[1] https://github.com/openstack/api-site/tree/master/api-ref/source/identity/v3
[2] https://github.com/russell/fairy-slipper

Change-Id: I632ac0aaa8e1ba2eeb598f5fd80350ac0c5ad3c1
2016-06-28 18:53:37 +00:00

309 lines
7.2 KiB
ReStructuredText
Raw Blame History

.. -*- rst -*-
=================================================
OS-ENDPOINT-POLICY extension (OS-ENDPOINT-POLICY)
=================================================
Creates, verifies, and deletes associations between service
endpoints and policies. Such associations enable an endpoint to
request its policy.
To create, check, or delete an association, you reference a policy
by its ID in the Identity server.
The extension supports these associations:
- A policy and endpoint association.
- A policy and service-type endpoint in a region association.
- A policy and service-type endpoint association.
This order reflects policies in their most to least-specific order.
When an endpoint requests the appropriate policy for itself, the
extension finds the policy by traversing the ordered sequence of
methods of association. The extension shows the policy for the
first association that it finds.
If the region of the endpoint has a parent, the extension examines
the region associations up the region tree in ascending order. For
region associations, the extension examines any parent regions in
ascending order. The extension does not combine polices.
Associate policy and service-type endpoint
==========================================
.. rest_method:: PUT /v3/policies/{policy_id}/OS-ENDPOINT-POLICY/services/{service_id}
Associates a policy and any endpoint of a service type.
If an association already exists between the endpoint of a service
type and another policy, this call replaces that association.
Error response codes:204,
Request
-------
.. rest_parameters:: parameters.yaml
- service_id: service_id
- policy_id: policy_id
Verify a policy and service-type endpoint association
=====================================================
.. rest_method:: GET /v3/policies/{policy_id}/OS-ENDPOINT-POLICY/services/{service_id}
Verifies an association between a policy and an endpoint of a service type.
A HEAD version of this API is also supported.
Error response codes:204,
Request
-------
.. rest_parameters:: parameters.yaml
- service_id: service_id
- policy_id: policy_id
Delete a policy and service-type endpoint association
=====================================================
.. rest_method:: DELETE /v3/policies/{policy_id}/OS-ENDPOINT-POLICY/services/{service_id}
Deletes an association between a policy and an endpoint of a service type.
Error response codes:204,
Request
-------
.. rest_parameters:: parameters.yaml
- service_id: service_id
- policy_id: policy_id
Show policy for endpoint
========================
.. rest_method:: GET /v3/policies/{policy_id}/OS-ENDPOINT-POLICY/policy
Shows a policy for an endpoint.
The extension finds the policy by traversing the ordered sequence
of methods of association. The extension shows the policy for the
first association that it finds. If the region of the endpoint has
a parent, the extension examines the region associations up the
region tree in ascending order.
Normal response codes: 200
Error response codes:
Request
-------
.. rest_parameters:: parameters.yaml
- policy_id: policy_id
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- policy: policy
- type: type
- blob: blob
- links: links
- id: id
Response Example
----------------
.. literalinclude:: samples/OS-ENDPOINT-POLICY/policy-show-response.json
:language: javascript
Check policy and service endpoint association
=============================================
.. rest_method:: HEAD /v3/policies/{policy_id}/OS-ENDPOINT-POLICY/policy
Checks whether a policy is associated with an endpoint.
Normal response codes: 200
Error response codes:
Request
-------
.. rest_parameters:: parameters.yaml
- policy_id: policy_id
Associate policy and service-type endpoint in a region
======================================================
.. rest_method:: PUT /v3/policies/{policy_id}/OS-ENDPOINT-POLICY/services/regions/{region_id}
Associates a policy and an endpoint of a service type in a region.
If an association already exists between the service in a region
and another policy, this call replaces that association.
Error response codes:204,
Request
-------
.. rest_parameters:: parameters.yaml
- region_id: region_id
- policy_id: policy_id
Verify a policy and service-type endpoint in a region association
=================================================================
.. rest_method:: GET /v3/policies/{policy_id}/OS-ENDPOINT-POLICY/services/regions/{region_id}
Verifies an association between a policy and service-type endpoint in a region.
A HEAD version of this API is also supported.
Error response codes:204,
Request
-------
.. rest_parameters:: parameters.yaml
- region_id: region_id
- policy_id: policy_id
Delete a policy and service-type endpoint in a region association
=================================================================
.. rest_method:: DELETE /v3/policies/{policy_id}/OS-ENDPOINT-POLICY/services/regions/{region_id}
Deletes an association between a policy and service-type endpoint in a region.
Error response codes:204,
Request
-------
.. rest_parameters:: parameters.yaml
- region_id: region_id
- policy_id: policy_id
List policy and service endpoint associations
=============================================
.. rest_method:: GET /v3/policies/{policy_id}/OS-ENDPOINT-POLICY/endpoints
Lists all the endpoints that are currently associated with a policy through any of the association methods.
Normal response codes: 200
Error response codes:
Request
-------
.. rest_parameters:: parameters.yaml
- policy_id: policy_id
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- links: links
- url: url
- region: region
- next: next
- self: self
- interface: interface
- service_id: service_id
- endpoints: endpoints
- id: id
- previous: previous
Response Example
----------------
.. literalinclude:: samples/OS-ENDPOINT-POLICY/policy-endpoint-associations-list-response.json
:language: javascript
Associate policy and endpoint
=============================
.. rest_method:: PUT /v3/policies/{policy_id}/OS-ENDPOINT-POLICY/endpoints/{endpoint_id}
Associates a policy and an endpoint.
If an association already exists between the endpoint and another
policy, this call replaces that association.
Error response codes:204,
Request
-------
.. rest_parameters:: parameters.yaml
- endpoint_id: endpoint_id
- policy_id: policy_id
Verify a policy and endpoint association
========================================
.. rest_method:: GET /v3/policies/{policy_id}/OS-ENDPOINT-POLICY/endpoints/{endpoint_id}
Verifies an association between a policy and an endpoint.
A HEAD version of this API is also supported.
Error response codes:204,
Request
-------
.. rest_parameters:: parameters.yaml
- endpoint_id: endpoint_id
- policy_id: policy_id
Delete a policy and endpoint association
========================================
.. rest_method:: DELETE /v3/policies/{policy_id}/OS-ENDPOINT-POLICY/endpoints/{endpoint_id}
Deletes an association between a policy and an endpoint.
Error response codes:204,
Request
-------
.. rest_parameters:: parameters.yaml
- endpoint_id: endpoint_id
- policy_id: policy_id
View Git Blame Copy Permalink