openstack.identity.v3.user¶
The User Class¶
The User
class inherits from Resource
.
- class openstack.identity.v3.user.User(_synchronized=False, connection=None, **attrs)¶
The base resource
- Parameters
_synchronized (bool) – This is not intended to be used directly. See
new()
andexisting()
.connection (openstack.connection.Connection) – Reference to the Connection being used. Defaults to None to allow Resource objects to be used without an active Connection, such as in unit tests. Use of
self._connection
in Resource code should protect itself with a check for None.
- default_project_id¶
References the user’s default project ID against which to authorize, if the API user does not explicitly specify one when creating a token. Setting this attribute does not grant any actual authorization on the project, and is merely provided for the user’s convenience. Therefore, the referenced project does not need to exist within the user’s domain.
New in version 3.1 If the user does not have authorization to their default project, the default project will be ignored at token creation. Type: string
- description¶
The description of this user. Type: string
- domain_id¶
References the domain ID which owns the user; if a domain ID is not specified by the client, the Identity service implementation will default it to the domain ID to which the client’s token is scoped. Type: string
- email¶
The email of this user. Type: string
- is_enabled¶
Setting this value to
False
prevents the user from authenticating or receiving authorization. Additionally, all pre-existing tokens held by the user are immediately invalidated. Re-enabling a user does not re-enable pre-existing tokens. Type: bool
- links¶
The links for the user resource.
- name¶
Unique user name, within the owning domain. Type: string
- password¶
The default form of credential used during authentication. Type: string
- password_expires_at¶
The date and time when the password expires. The time zone is UTC. A None value means the password never expires. This is a response object attribute, not valid for requests. New in version 3.7