Skip to content

USERS.md

Latest commit

 

History

History
70 lines (45 loc) · 3.36 KB

USERS.md

File metadata and controls

70 lines (45 loc) · 3.36 KB

Users

Users refer to Openstack Users. A User in Openstack is an individual who has access to the Openstack API and is owned by a domain. See Openstack Docs for more info

NOTE: UserQuery will only work with admin credentials - set by clouds.yaml

Querying

To Query for Users using the Query Library, you can import UserQuery() like so:

from openstackquery import UserQuery

UserQuery() can then be used to setup and run queries - see API.md for details on API calls

Properties

A User has the following properties:

Return Type Property Name(s) (case-insensitive) Description
string "domain_id" The ID for the domain which owns the user
string "description", "desc" The description of this user.
string "email", "email_addr", "email_address", "user_email_address" The email address of this user.
string "id", "uuid" Unique ID Openstack has assigned the user
string "name", "username Unique user name (within the domain)

Any of these properties can be used for any of the API methods that takes a property - like select, where, sort_by etc

Chaining

This section details valid mappings you can use to chain onto other queries or from other queries to chain into a ProjectQuery object. This applies to API calls then and append_from - see API.md for details

Query Alias

The aliases that can be used for the query when chaining are listed below:

Aliases (case-insensitive)
"user", "users", "user_query", "userquery"

Chaining from

A UserQuery can be chained to other queries. The following shared-common properties are listed below (as well as the Query object they map to):

Prop 1 Prop 2 Type Maps
"id" "user_id" One-to-Many UserQuery to ServerQuery

Chaining to

Chaining from other UserQuery requires passing USER_QUERY or any aliases mentioned above as the query_type

From Prop 1 Prop 2 Type Documentation
ServerQuery "user_id" "id" Many-to-One SERVERS.md

run() meta-parameters

UserQuery() has the following meta-parameters that can be used when calling run() to fine-tune the query.

Parameter Definition Optional? Description
from_domain: str Yes A User Domain to limit User query to
Optional, if not given will run search on domain with name "default"