keystone.api.users module¶

class keystone.api.users.OAuth1AccessTokenCRUDResource[source]¶

Bases: _OAuth1ResourceBase

delete(user_id, access_token_id)[source]¶

Delete specific access token.

DELETE /v3/users/{user_id}/OS-OAUTH1/access_tokens/{access_token_id}

get(user_id, access_token_id)[source]¶

Get specific access token.

GET/HEAD /v3/users/{user_id}/OS-OAUTH1/access_tokens/{access_token_id}

methods: t.ClassVar[t.Optional[t.Collection[str]]] = {'DELETE', '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.users.OAuth1AccessTokenRoleListResource[source]¶

Bases: ResourceBase

collection_key = 'roles'¶

get(user_id, access_token_id)[source]¶

List roles for a user access token.

GET/HEAD /v3/users/{user_id}/OS-OAUTH1/access_tokens/

{access_token_id}/roles

member_key = 'role'¶

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.users.OAuth1AccessTokenRoleResource[source]¶

Bases: ResourceBase

collection_key = 'roles'¶

get(user_id, access_token_id, role_id)[source]¶

Get role for access token.

GET/HEAD /v3/users/{user_id}/OS-OAUTH1/access_tokens/

{access_token_id}/roles/{role_id}

member_key = 'role'¶

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.users.OAuth1ListAccessTokensResource[source]¶

Bases: _OAuth1ResourceBase

get(user_id)[source]¶

List OAuth1 Access Tokens for user.

GET /v3/users/{user_id}/OS-OAUTH1/access_tokens

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.users.UserAPI(blueprint_url_prefix='', api_url_prefix='', default_mediatype='application/json', decorators=None, errors=None)[source]¶

Bases: APIBase

resource_mapping = [resource_map(resource=<class 'keystone.api.users.UserChangePasswordResource'>, url='/users/<string:user_id>/password', alternate_urls=None, kwargs={}, json_home_data=json_home_data(rel='https://docs.openstack.org/api/openstack-identity/3/rel/user_change_password', status='stable', path_vars={'user_id': 'https://docs.openstack.org/api/openstack-identity/3/param/user_id'})), resource_map(resource=<class 'keystone.api.users.UserGroupsResource'>, url='/users/<string:user_id>/groups', alternate_urls=None, kwargs={}, json_home_data=json_home_data(rel='https://docs.openstack.org/api/openstack-identity/3/rel/user_groups', status='stable', path_vars={'user_id': 'https://docs.openstack.org/api/openstack-identity/3/param/user_id'})), resource_map(resource=<class 'keystone.api.users.UserProjectsResource'>, url='/users/<string:user_id>/projects', alternate_urls=None, kwargs={}, json_home_data=json_home_data(rel='https://docs.openstack.org/api/openstack-identity/3/rel/user_projects', status='stable', path_vars={'user_id': 'https://docs.openstack.org/api/openstack-identity/3/param/user_id'})), resource_map(resource=<class 'keystone.api.users.UserOSEC2CredentialsResourceListCreate'>, url='/users/<string:user_id>/credentials/OS-EC2', alternate_urls=None, kwargs={}, json_home_data=json_home_data(rel='https://docs.openstack.org/api/openstack-identity/3/ext/OS-EC2/1.0/rel/user_credentials', status='stable', path_vars={'user_id': 'https://docs.openstack.org/api/openstack-identity/3/param/user_id'})), resource_map(resource=<class 'keystone.api.users.UserOSEC2CredentialsResourceGetDelete'>, url='/users/<string:user_id>/credentials/OS-EC2/<string:credential_id>', alternate_urls=None, kwargs={}, json_home_data=json_home_data(rel='https://docs.openstack.org/api/openstack-identity/3/ext/OS-EC2/1.0/rel/user_credential', status='stable', path_vars={'credential_id': 'https://docs.openstack.org/api/openstack-identity/3/param/credential_id', 'user_id': 'https://docs.openstack.org/api/openstack-identity/3/param/user_id'})), resource_map(resource=<class 'keystone.api.users.OAuth1ListAccessTokensResource'>, url='/users/<string:user_id>/OS-OAUTH1/access_tokens', alternate_urls=None, kwargs={}, json_home_data=json_home_data(rel='https://docs.openstack.org/api/openstack-identity/3/ext/OS-OAUTH1/1.0/rel/user_access_tokens', status='stable', path_vars={'user_id': 'https://docs.openstack.org/api/openstack-identity/3/param/user_id'})), resource_map(resource=<class 'keystone.api.users.OAuth1AccessTokenCRUDResource'>, url='/users/<string:user_id>/OS-OAUTH1/access_tokens/<string:access_token_id>', alternate_urls=None, kwargs={}, json_home_data=json_home_data(rel='https://docs.openstack.org/api/openstack-identity/3/ext/OS-OAUTH1/1.0/rel/user_access_token', status='stable', path_vars={'access_token_id': 'https://docs.openstack.org/api/openstack-identity/3/ext/OS-OAUTH1/1.0/param/access_token_id', 'user_id': 'https://docs.openstack.org/api/openstack-identity/3/param/user_id'})), resource_map(resource=<class 'keystone.api.users.OAuth1AccessTokenRoleListResource'>, url='/users/<string:user_id>/OS-OAUTH1/access_tokens/<string:access_token_id>/roles', alternate_urls=None, kwargs={}, json_home_data=json_home_data(rel='https://docs.openstack.org/api/openstack-identity/3/ext/OS-OAUTH1/1.0/rel/user_access_token_roles', status='stable', path_vars={'access_token_id': 'https://docs.openstack.org/api/openstack-identity/3/ext/OS-OAUTH1/1.0/param/access_token_id', 'user_id': 'https://docs.openstack.org/api/openstack-identity/3/param/user_id'})), resource_map(resource=<class 'keystone.api.users.OAuth1AccessTokenRoleResource'>, url='/users/<string:user_id>/OS-OAUTH1/access_tokens/<string:access_token_id>/roles/<string:role_id>', alternate_urls=None, kwargs={}, json_home_data=json_home_data(rel='https://docs.openstack.org/api/openstack-identity/3/ext/OS-OAUTH1/1.0/rel/user_access_token_role', status='stable', path_vars={'access_token_id': 'https://docs.openstack.org/api/openstack-identity/3/ext/OS-OAUTH1/1.0/param/access_token_id', '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.users.UserAppCredListCreateResource'>, url='/users/<string:user_id>/application_credentials', alternate_urls=None, kwargs={}, json_home_data=json_home_data(rel='https://docs.openstack.org/api/openstack-identity/3/rel/application_credentials', status='stable', path_vars={'user_id': 'https://docs.openstack.org/api/openstack-identity/3/param/user_id'})), resource_map(resource=<class 'keystone.api.users.UserAppCredGetDeleteResource'>, url='/users/<string:user_id>/application_credentials/<string:application_credential_id>', alternate_urls=None, kwargs={}, json_home_data=json_home_data(rel='https://docs.openstack.org/api/openstack-identity/3/rel/application_credential', status='stable', path_vars={'user_id': 'https://docs.openstack.org/api/openstack-identity/3/param/user_id', 'application_credential_id': 'https://docs.openstack.org/api/openstack-identity/3/param/application_credential_id'})), resource_map(resource=<class 'keystone.api.users.UserAccessRuleListResource'>, url='/users/<string:user_id>/access_rules', alternate_urls=None, kwargs={}, json_home_data=json_home_data(rel='https://docs.openstack.org/api/openstack-identity/3/rel/access_rules', status='stable', path_vars={'user_id': 'https://docs.openstack.org/api/openstack-identity/3/param/user_id'})), resource_map(resource=<class 'keystone.api.users.UserAccessRuleGetDeleteResource'>, url='/users/<string:user_id>/access_rules/<string:access_rule_id>', alternate_urls=None, kwargs={}, json_home_data=json_home_data(rel='https://docs.openstack.org/api/openstack-identity/3/rel/access_rule', status='stable', path_vars={'user_id': 'https://docs.openstack.org/api/openstack-identity/3/param/user_id', 'access_rule_id': 'https://docs.openstack.org/api/openstack-identity/3/param/access_rule_id'}))]¶

resources = [<class 'keystone.api.users.UserResource'>]¶

class keystone.api.users.UserAccessRuleGetDeleteResource[source]¶

Bases: ResourceBase

collection_key = 'access_rules'¶

delete(user_id, access_rule_id)[source]¶

Delete access rule resource.

DELETE /v3/users/{user_id}/access_rules/{access_rule_id}

get(user_id, access_rule_id)[source]¶

Get access rule resource.

GET/HEAD /v3/users/{user_id}/access_rules/{access_rule_id}

member_key = 'access_rule'¶

methods: t.ClassVar[t.Optional[t.Collection[str]]] = {'DELETE', '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.users.UserAccessRuleListResource[source]¶

Bases: ResourceBase

collection_key = 'access_rules'¶

get(user_id)[source]¶

List access rules for user.

GET/HEAD /v3/users/{user_id}/access_rules

member_key = 'access_rule'¶

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.users.UserAppCredGetDeleteResource[source]¶

Bases: ResourceBase

collection_key = 'application_credentials'¶

delete(user_id, application_credential_id)[source]¶

Delete application credential resource.

DELETE /v3/users/{user_id}/application_credentials/

{application_credential_id}

get(user_id, application_credential_id)[source]¶

Get application credential resource.

GET/HEAD /v3/users/{user_id}/application_credentials/

{application_credential_id}

member_key = 'application_credential'¶

methods: t.ClassVar[t.Optional[t.Collection[str]]] = {'DELETE', '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.users.UserAppCredListCreateResource[source]¶

Bases: ResourceBase

collection_key = 'application_credentials'¶

get(user_id)[source]¶

List application credentials for user.

GET/HEAD /v3/users/{user_id}/application_credentials

member_key = 'application_credential'¶

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

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

post(user_id)[source]¶

Create application credential.

POST /v3/users/{user_id}/application_credentials

class keystone.api.users.UserChangePasswordResource[source]¶

Bases: ResourceBase

get(user_id)[source]¶

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

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

post(user_id)[source]¶

Change a user’s own password.

POST /v3/users/{user_id}/password

This endpoint is self-service and requires no token, only the current password – if the account has MFA rules configured, a current TOTP passcode is also required (see keystone.api._shared.mfa_reverification). Without that, a stolen password alone could change the password and lock the legitimate, MFA-protected owner out. See LP#2158970.

class keystone.api.users.UserGroupsResource[source]¶

Bases: ResourceBase

collection_key = 'groups'¶

get(user_id)[source]¶

Get groups for a user.

GET/HEAD /v3/users/{user_id}/groups

get_member_from_driver¶

member_key = 'group'¶

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.users.UserOSEC2CredentialsResourceGetDelete[source]¶

Bases: _UserOSEC2CredBaseResource

delete(user_id, credential_id)[source]¶

Delete a specific EC2 credential.

DELETE /users/{user_id}/credentials/OS-EC2/{credential_id}

get(user_id, credential_id)[source]¶

Get a specific EC2 credential.

GET/HEAD /users/{user_id}/credentials/OS-EC2/{credential_id}

methods: t.ClassVar[t.Optional[t.Collection[str]]] = {'DELETE', '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.users.UserOSEC2CredentialsResourceListCreate[source]¶

Bases: _UserOSEC2CredBaseResource

get(user_id)[source]¶

List EC2 Credentials for user.

GET/HEAD /v3/users/{user_id}/credentials/OS-EC2

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

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

post(user_id)[source]¶

Create EC2 Credential for user.

POST /v3/users/{user_id}/credentials/OS-EC2

class keystone.api.users.UserProjectsResource[source]¶

Bases: ResourceBase

collection_key = 'projects'¶

get(user_id)[source]¶

get_member_from_driver¶

member_key = 'project'¶

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.users.UserResource[source]¶

Bases: ResourceBase

collection_key = 'users'¶

delete(user_id)[source]¶

Delete a user.

DELETE /v3/users/{user_id}

get(user_id=None)[source]¶

Get a user resource or list users.

GET/HEAD /v3/users GET/HEAD /v3/users/{user_id}

get_member_from_driver¶

member_key = 'user'¶

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

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

patch(user_id)[source]¶

Update a user.

PATCH /v3/users/{user_id}

post()[source]¶

Create a user.

POST /v3/users