# keystone.common.policies.endpoint_group

# Source code for keystone.common.policies.endpoint_group

    # Licensed under the Apache License, Version 2.0 (the "License"); you may
    # not use this file except in compliance with the License. You may obtain
    # a copy of the License at
    #
    #      http://www.apache.org/licenses/LICENSE-2.0
    #
    # Unless required by applicable law or agreed to in writing, software
    # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
    # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
    # License for the specific language governing permissions and limitations
    # under the License.

    from oslo_log import versionutils
    from oslo_policy import policy

    from keystone.common.policies import base

    DEPRECATED_REASON = (
        "The endpoint groups API is now aware of system scope and default roles."
    )

    deprecated_list_endpoint_groups = policy.DeprecatedRule(
        name=base.IDENTITY % 'list_endpoint_groups',
        check_str=base.RULE_ADMIN_REQUIRED,
        deprecated_reason=DEPRECATED_REASON,
        deprecated_since=versionutils.deprecated.TRAIN,
    )

    deprecated_get_endpoint_group = policy.DeprecatedRule(
        name=base.IDENTITY % 'get_endpoint_group',
        check_str=base.RULE_ADMIN_REQUIRED,
        deprecated_reason=DEPRECATED_REASON,
        deprecated_since=versionutils.deprecated.TRAIN,
    )

    deprecated_list_projects_assoc_with_endpoint_group = policy.DeprecatedRule(
        name=base.IDENTITY % 'list_projects_associated_with_endpoint_group',
        check_str=base.RULE_ADMIN_REQUIRED,
        deprecated_reason=DEPRECATED_REASON,
        deprecated_since=versionutils.deprecated.TRAIN,
    )

    deprecated_list_endpoints_assoc_with_endpoint_group = policy.DeprecatedRule(
        name=base.IDENTITY % 'list_endpoints_associated_with_endpoint_group',
        check_str=base.RULE_ADMIN_REQUIRED,
        deprecated_reason=DEPRECATED_REASON,
        deprecated_since=versionutils.deprecated.TRAIN,
    )

    deprecated_get_endpoint_group_in_project = policy.DeprecatedRule(
        name=base.IDENTITY % 'get_endpoint_group_in_project',
        check_str=base.RULE_ADMIN_REQUIRED,
        deprecated_reason=DEPRECATED_REASON,
        deprecated_since=versionutils.deprecated.TRAIN,
    )

    deprecated_list_endpoint_groups_for_project = policy.DeprecatedRule(
        name=base.IDENTITY % 'list_endpoint_groups_for_project',
        check_str=base.RULE_ADMIN_REQUIRED,
        deprecated_reason=DEPRECATED_REASON,
        deprecated_since=versionutils.deprecated.TRAIN,
    )

    deprecated_create_endpoint_group = policy.DeprecatedRule(
        name=base.IDENTITY % 'create_endpoint_group',
        check_str=base.RULE_ADMIN_REQUIRED,
        deprecated_reason=DEPRECATED_REASON,
        deprecated_since=versionutils.deprecated.TRAIN,
    )

    deprecated_update_endpoint_group = policy.DeprecatedRule(
        name=base.IDENTITY % 'update_endpoint_group',
        check_str=base.RULE_ADMIN_REQUIRED,
        deprecated_reason=DEPRECATED_REASON,
        deprecated_since=versionutils.deprecated.TRAIN,
    )

    deprecated_delete_endpoint_group = policy.DeprecatedRule(
        name=base.IDENTITY % 'delete_endpoint_group',
        check_str=base.RULE_ADMIN_REQUIRED,
        deprecated_reason=DEPRECATED_REASON,
        deprecated_since=versionutils.deprecated.TRAIN,
    )

    deprecated_add_endpoint_group_to_project = policy.DeprecatedRule(
        name=base.IDENTITY % 'add_endpoint_group_to_project',
        check_str=base.RULE_ADMIN_REQUIRED,
        deprecated_reason=DEPRECATED_REASON,
        deprecated_since=versionutils.deprecated.TRAIN,
    )

    deprecated_remove_endpoint_group_from_project = policy.DeprecatedRule(
        name=base.IDENTITY % 'remove_endpoint_group_from_project',
        check_str=base.RULE_ADMIN_REQUIRED,
        deprecated_reason=DEPRECATED_REASON,
        deprecated_since=versionutils.deprecated.TRAIN,
    )

    group_endpoint_policies = [
        policy.DocumentedRuleDefault(
            name=base.IDENTITY % 'create_endpoint_group',
            check_str=base.RULE_ADMIN_REQUIRED,
            scope_types=['system', 'project'],
            description='Create endpoint group.',
            operations=[
                {'path': '/v3/OS-EP-FILTER/endpoint_groups', 'method': 'POST'}
            ],
            deprecated_rule=deprecated_create_endpoint_group,
        ),
        policy.DocumentedRuleDefault(
            name=base.IDENTITY % 'list_endpoint_groups',
            check_str=base.RULE_ADMIN_OR_SYSTEM_READER,
            scope_types=['system', 'project'],
            description='List endpoint groups.',
            operations=[
                {'path': '/v3/OS-EP-FILTER/endpoint_groups', 'method': 'GET'}
            ],
            deprecated_rule=deprecated_list_endpoint_groups,
        ),
        policy.DocumentedRuleDefault(
            name=base.IDENTITY % 'get_endpoint_group',
            check_str=base.RULE_ADMIN_OR_SYSTEM_READER,
            scope_types=['system', 'project'],
            description='Get endpoint group.',
            operations=[
                {
                    'path': (
                        '/v3/OS-EP-FILTER/endpoint_groups/{endpoint_group_id}'
                    ),
                    'method': 'GET',
                },
                {
                    'path': (
                        '/v3/OS-EP-FILTER/endpoint_groups/{endpoint_group_id}'
                    ),
                    'method': 'HEAD',
                },
            ],
            deprecated_rule=deprecated_get_endpoint_group,
        ),
        policy.DocumentedRuleDefault(
            name=base.IDENTITY % 'update_endpoint_group',
            check_str=base.RULE_ADMIN_REQUIRED,
            scope_types=['system', 'project'],
            description='Update endpoint group.',
            operations=[
                {
                    'path': (
                        '/v3/OS-EP-FILTER/endpoint_groups/{endpoint_group_id}'
                    ),
                    'method': 'PATCH',
                }
            ],
            deprecated_rule=deprecated_update_endpoint_group,
        ),
        policy.DocumentedRuleDefault(
            name=base.IDENTITY % 'delete_endpoint_group',
            check_str=base.RULE_ADMIN_REQUIRED,
            scope_types=['system', 'project'],
            description='Delete endpoint group.',
            operations=[
                {
                    'path': (
                        '/v3/OS-EP-FILTER/endpoint_groups/{endpoint_group_id}'
                    ),
                    'method': 'DELETE',
                }
            ],
            deprecated_rule=deprecated_delete_endpoint_group,
        ),
        policy.DocumentedRuleDefault(
            name=base.IDENTITY % 'list_projects_associated_with_endpoint_group',
            check_str=base.RULE_ADMIN_OR_SYSTEM_READER,
            scope_types=['system', 'project'],
            description=(
                'List all projects associated with a specific endpoint group.'
            ),
            operations=[
                {
                    'path': (
                        '/v3/OS-EP-FILTER/endpoint_groups/'
                        '{endpoint_group_id}/projects'
                    ),
                    'method': 'GET',
                }
            ],
            deprecated_rule=deprecated_list_projects_assoc_with_endpoint_group,
        ),
        policy.DocumentedRuleDefault(
            name=base.IDENTITY % 'list_endpoints_associated_with_endpoint_group',
            check_str=base.RULE_ADMIN_OR_SYSTEM_READER,
            scope_types=['system', 'project'],
            description='List all endpoints associated with an endpoint group.',
            operations=[
                {
                    'path': (
                        '/v3/OS-EP-FILTER/endpoint_groups/'
                        '{endpoint_group_id}/endpoints'
                    ),
                    'method': 'GET',
                }
            ],
            deprecated_rule=deprecated_list_endpoints_assoc_with_endpoint_group,
        ),
        policy.DocumentedRuleDefault(
            name=base.IDENTITY % 'get_endpoint_group_in_project',
            check_str=base.RULE_ADMIN_OR_SYSTEM_READER,
            scope_types=['system', 'project'],
            description=(
                'Check if an endpoint group is associated with a project.'
            ),
            operations=[
                {
                    'path': (
                        '/v3/OS-EP-FILTER/endpoint_groups/'
                        '{endpoint_group_id}/projects/{project_id}'
                    ),
                    'method': 'GET',
                },
                {
                    'path': (
                        '/v3/OS-EP-FILTER/endpoint_groups/'
                        '{endpoint_group_id}/projects/{project_id}'
                    ),
                    'method': 'HEAD',
                },
            ],
            deprecated_rule=deprecated_get_endpoint_group_in_project,
        ),
        policy.DocumentedRuleDefault(
            name=base.IDENTITY % 'list_endpoint_groups_for_project',
            check_str=base.RULE_ADMIN_OR_SYSTEM_READER,
            scope_types=['system', 'project'],
            description='List endpoint groups associated with a specific project.',
            operations=[
                {
                    'path': (
                        '/v3/OS-EP-FILTER/projects/{project_id}/endpoint_groups'
                    ),
                    'method': 'GET',
                }
            ],
            deprecated_rule=deprecated_list_endpoint_groups_for_project,
        ),
        policy.DocumentedRuleDefault(
            name=base.IDENTITY % 'add_endpoint_group_to_project',
            check_str=base.RULE_ADMIN_REQUIRED,
            scope_types=['system', 'project'],
            description='Allow a project to access an endpoint group.',
            operations=[
                {
                    'path': (
                        '/v3/OS-EP-FILTER/endpoint_groups/'
                        '{endpoint_group_id}/projects/{project_id}'
                    ),
                    'method': 'PUT',
                }
            ],
            deprecated_rule=deprecated_add_endpoint_group_to_project,
        ),
        policy.DocumentedRuleDefault(
            name=base.IDENTITY % 'remove_endpoint_group_from_project',
            check_str=base.RULE_ADMIN_REQUIRED,
            scope_types=['system', 'project'],
            description='Remove endpoint group from project.',
            operations=[
                {
                    'path': (
                        '/v3/OS-EP-FILTER/endpoint_groups/'
                        '{endpoint_group_id}/projects/{project_id}'
                    ),
                    'method': 'DELETE',
                }
            ],
            deprecated_rule=deprecated_remove_endpoint_group_from_project,
        ),
    ]

    def list_rules():
        return group_endpoint_policies

this page last updated: 2026-06-11 21:52:50

Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.

found an error? report a bug