endpoint_policy Package

endpoint_policy Package

controllers Module

core Module

class keystone.contrib.endpoint_policy.core.Driver[source]

Bases: object

Interface description for an Endpoint Policy driver.

check_policy_association(policy_id, endpoint_id=None, service_id=None, region_id=None)[source]

Checks existence a policy association.

Parameters:
  • policy_id (string) – identity of policy that is being associated
  • endpoint_id (string) – identity of endpoint to associate
  • service_id (string) – identity of the service to associate
  • region_id (string) – identity of the region to associate
Raises :

keystone.exception.PolicyAssociationNotFound if there is no match for the specified association

Returns:

None

create_policy_association(policy_id, endpoint_id=None, service_id=None, region_id=None)[source]

Creates a policy association.

Parameters:
  • policy_id (string) – identity of policy that is being associated
  • endpoint_id (string) – identity of endpoint to associate
  • service_id (string) – identity of the service to associate
  • region_id (string) – identity of the region to associate
Returns:

None

There are three types of association permitted:

  • Endpoint (in which case service and region must be None)
  • Service and region (in which endpoint must be None)
  • Service (in which case endpoint and region must be None)
delete_association_by_endpoint(endpoint_id)[source]

Removes all the policy associations with the specific endpoint.

Parameters:endpoint_id (string) – identity of endpoint to check
Returns:None
delete_association_by_policy(policy_id)[source]

Removes all the policy associations with the specific policy.

Parameters:policy_id (string) – identity of endpoint to check
Returns:None
delete_association_by_region(region_id)[source]

Removes all the policy associations with the specific region.

Parameters:region_id (string) – identity of endpoint to check
Returns:None
delete_association_by_service(service_id)[source]

Removes all the policy associations with the specific service.

Parameters:service_id (string) – identity of endpoint to check
Returns:None
delete_policy_association(policy_id, endpoint_id=None, service_id=None, region_id=None)[source]

Deletes a policy association.

Parameters:
  • policy_id (string) – identity of policy that is being associated
  • endpoint_id (string) – identity of endpoint to associate
  • service_id (string) – identity of the service to associate
  • region_id (string) – identity of the region to associate
Returns:

None

get_policy_association(endpoint_id=None, service_id=None, region_id=None)[source]

Gets the policy for an explicit association.

This method is not exposed as a public API, but is used by get_policy_for_endpoint().

Parameters:
  • endpoint_id (string) – identity of endpoint
  • service_id (string) – identity of the service
  • region_id (string) – identity of the region
Raises :

keystone.exception.PolicyAssociationNotFound if there is no match for the specified association

Returns:

dict containing policy_id

get_policy_for_endpoint(endpoint_id)[source]

Get the appropriate policy for a given endpoint.

Parameters:endpoint_id (string) – identity of endpoint
Returns:Policy entity for the endpoint
list_associations_for_policy(policy_id)[source]

List the associations for a policy.

This method is not exposed as a public API, but is used by list_endpoints_for_policy().

Parameters:policy_id (string) – identity of policy
Returns:List of association dicts
list_endpoints_for_policy(policy_id)[source]

List all the endpoints using a given policy.

Parameters:policy_id (string) – identity of policy that is being associated
Returns:list of endpoints that have an effective association with that policy
class keystone.contrib.endpoint_policy.core.Manager(*args, **kwargs)[source]

Bases: keystone.common.manager.Manager

Default pivot point for the Endpoint Policy backend.

See keystone.common.manager.Manager for more details on how this dynamically calls the backend.

check_policy_association(policy_id, endpoint_id=None, service_id=None, region_id=None)[source]
create_policy_association(policy_id, endpoint_id=None, service_id=None, region_id=None)[source]
delete_policy_association(policy_id, endpoint_id=None, service_id=None, region_id=None)[source]
get_policy_for_endpoint(endpoint_id)[source]
list_endpoints_for_policy(policy_id)[source]

routers Module

Table Of Contents

Previous topic

versions Package

Next topic

backends Package

This Page