# keystone.common.policies.consumer

# Source code for keystone.common.policies.consumer

    # 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 OAUTH1 consumer API is now aware of system scope and default roles."
    )

    deprecated_get_consumer = policy.DeprecatedRule(
        name=base.IDENTITY % 'get_consumer',
        check_str=base.RULE_ADMIN_REQUIRED,
        deprecated_reason=DEPRECATED_REASON,
        deprecated_since=versionutils.deprecated.TRAIN,
    )
    deprecated_list_consumers = policy.DeprecatedRule(
        name=base.IDENTITY % 'list_consumers',
        check_str=base.RULE_ADMIN_REQUIRED,
        deprecated_reason=DEPRECATED_REASON,
        deprecated_since=versionutils.deprecated.TRAIN,
    )
    deprecated_create_consumer = policy.DeprecatedRule(
        name=base.IDENTITY % 'create_consumer',
        check_str=base.RULE_ADMIN_REQUIRED,
        deprecated_reason=DEPRECATED_REASON,
        deprecated_since=versionutils.deprecated.TRAIN,
    )
    deprecated_update_consumer = policy.DeprecatedRule(
        name=base.IDENTITY % 'update_consumer',
        check_str=base.RULE_ADMIN_REQUIRED,
        deprecated_reason=DEPRECATED_REASON,
        deprecated_since=versionutils.deprecated.TRAIN,
    )
    deprecated_delete_consumer = policy.DeprecatedRule(
        name=base.IDENTITY % 'delete_consumer',
        check_str=base.RULE_ADMIN_REQUIRED,
        deprecated_reason=DEPRECATED_REASON,
        deprecated_since=versionutils.deprecated.TRAIN,
    )

    consumer_policies = [
        policy.DocumentedRuleDefault(
            name=base.IDENTITY % 'get_consumer',
            check_str=base.RULE_ADMIN_OR_SYSTEM_READER,
            scope_types=['system', 'project'],
            description='Show OAUTH1 consumer details.',
            operations=[
                {'path': '/v3/OS-OAUTH1/consumers/{consumer_id}', 'method': 'GET'}
            ],
            deprecated_rule=deprecated_get_consumer,
        ),
        policy.DocumentedRuleDefault(
            name=base.IDENTITY % 'list_consumers',
            check_str=base.RULE_ADMIN_OR_SYSTEM_READER,
            scope_types=['system', 'project'],
            description='List OAUTH1 consumers.',
            operations=[{'path': '/v3/OS-OAUTH1/consumers', 'method': 'GET'}],
            deprecated_rule=deprecated_list_consumers,
        ),
        policy.DocumentedRuleDefault(
            name=base.IDENTITY % 'create_consumer',
            check_str=base.RULE_ADMIN_REQUIRED,
            scope_types=['system', 'project'],
            description='Create OAUTH1 consumer.',
            operations=[{'path': '/v3/OS-OAUTH1/consumers', 'method': 'POST'}],
            deprecated_rule=deprecated_create_consumer,
        ),
        policy.DocumentedRuleDefault(
            name=base.IDENTITY % 'update_consumer',
            check_str=base.RULE_ADMIN_REQUIRED,
            scope_types=['system', 'project'],
            description='Update OAUTH1 consumer.',
            operations=[
                {
                    'path': '/v3/OS-OAUTH1/consumers/{consumer_id}',
                    'method': 'PATCH',
                }
            ],
            deprecated_rule=deprecated_update_consumer,
        ),
        policy.DocumentedRuleDefault(
            name=base.IDENTITY % 'delete_consumer',
            check_str=base.RULE_ADMIN_REQUIRED,
            scope_types=['system', 'project'],
            description='Delete OAUTH1 consumer.',
            operations=[
                {
                    'path': '/v3/OS-OAUTH1/consumers/{consumer_id}',
                    'method': 'DELETE',
                }
            ],
            deprecated_rule=deprecated_delete_consumer,
        ),
    ]

    def list_rules():
        return consumer_policies

this page last updated: 2026-04-01 20:09:17

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