keystone.api.system module

class keystone.api.system.SystemAPI(blueprint_url_prefix='', api_url_prefix='', default_mediatype='application/json', decorators=None, errors=None)

Bases: keystone.server.flask.common.APIBase

resource_mapping = [resource_map(resource=<class 'keystone.api.system.SystemUsersListResource'>, url='/system/users/<string:user_id>/roles', alternate_urls=None, kwargs={}, json_home_data=json_home_data(rel='https://docs.openstack.org/api/openstack-identity/3/rel/system_user_roles', status='stable', path_vars={'user_id': 'https://docs.openstack.org/api/openstack-identity/3/param/user_id'})), resource_map(resource=<class 'keystone.api.system.SystemUsersResource'>, url='/system/users/<string:user_id>/roles/<string:role_id>', alternate_urls=None, kwargs={}, json_home_data=json_home_data(rel='https://docs.openstack.org/api/openstack-identity/3/rel/system_user_role', status='stable', path_vars={'role_id': 'https://docs.openstack.org/api/openstack-identity/3/param/role_id', 'user_id': 'https://docs.openstack.org/api/openstack-identity/3/param/user_id'})), resource_map(resource=<class 'keystone.api.system.SystemGroupsRolesListResource'>, url='/system/groups/<string:group_id>/roles', alternate_urls=None, kwargs={}, json_home_data=json_home_data(rel='https://docs.openstack.org/api/openstack-identity/3/rel/system_group_roles', status='stable', path_vars={'group_id': 'https://docs.openstack.org/api/openstack-identity/3/param/group_id'})), resource_map(resource=<class 'keystone.api.system.SystemGroupsRolestResource'>, url='/system/groups/<string:group_id>/roles/<string:role_id>', alternate_urls=None, kwargs={}, json_home_data=json_home_data(rel='https://docs.openstack.org/api/openstack-identity/3/rel/system_group_role', status='stable', path_vars={'role_id': 'https://docs.openstack.org/api/openstack-identity/3/param/role_id', 'group_id': 'https://docs.openstack.org/api/openstack-identity/3/param/group_id'}))]

resources = []

class keystone.api.system.SystemGroupsRolesListResource

Bases: flask_restful.Resource

get(group_id)

List all system grants for a specific group.

GET/HEAD /system/groups/{group_id}/roles

methods: t.ClassVar[t.Optional[t.Collection[str]]] = {'GET'}

The methods this view is registered for. Uses the same default (["GET", "HEAD", "OPTIONS"]) as route and add_url_rule by default.

class keystone.api.system.SystemGroupsRolestResource

Bases: flask_restful.Resource

delete(group_id, role_id)

Revoke a role from the group on the system.

DELETE /system/groups/{group_id}/roles/{role_id}

get(group_id, role_id)

Check if a group has a specific role on the system.

GET/HEAD /system/groups/{group_id}/roles/{role_id}

methods: t.ClassVar[t.Optional[t.Collection[str]]] = {'DELETE', 'GET', 'PUT'}

The methods this view is registered for. Uses the same default (["GET", "HEAD", "OPTIONS"]) as route and add_url_rule by default.

put(group_id, role_id)

Grant a role to a group on the system.

PUT /system/groups/{group_id}/roles/{role_id}

class keystone.api.system.SystemUsersListResource

Bases: flask_restful.Resource

get(user_id)

List all system grants for a specific user.

GET/HEAD /system/users/{user_id}/roles

methods: t.ClassVar[t.Optional[t.Collection[str]]] = {'GET'}

The methods this view is registered for. Uses the same default (["GET", "HEAD", "OPTIONS"]) as route and add_url_rule by default.

class keystone.api.system.SystemUsersResource

Bases: flask_restful.Resource

delete(user_id, role_id)

Revoke a role from user on the system.

DELETE /system/users/{user_id}/roles/{role_id}

get(user_id, role_id)

Check if a user has a specific role on the system.

GET/HEAD /system/users/{user_id}/roles/{role_id}

methods: t.ClassVar[t.Optional[t.Collection[str]]] = {'DELETE', 'GET', 'PUT'}

The methods this view is registered for. Uses the same default (["GET", "HEAD", "OPTIONS"]) as route and add_url_rule by default.

put(user_id, role_id)

Grant a role to a user on the system.

PUT /system/users/{user_id}/roles/{role_id}