openstack.identity.v3.user

openstack.identity.v3.user

The User Class

The User class inherits from Resource.

class openstack.identity.v3.user.User(attrs=None, loaded=False)

Construct a Resource to interact with a service’s REST API.

The Resource class offers two class methods to construct resource objects, which are preferrable to entering through this initializer. See Resource.new() and Resource.existing().

Parameters:
  • attrs (dict) – The attributes to set when constructing this Resource.
  • loaded (bool) – True if this Resource exists on the server, False if it does not.
default_project_id = None

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 = None

The description of this user. Type: string

domain_id = None

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 = None

The email of this user. Type: string

enabled = None

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

name = None

Unique user name, within the owning domain. Type: string

password = None

The default form of credential used during authentication. Type: string

Creative Commons Attribution 3.0 License

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