For details on how to use identity, see Using OpenStack Identity
The identity high-level interface is available through the identity
member of a Connection
object. The
identity
member will only be added if the service is detected.
openstack.identity.v2._proxy.
Proxy
(session, statsd_client=None, statsd_prefix=None, prometheus_counter=None, prometheus_histogram=None, influxdb_config=None, influxdb_client=None, *args, **kwargs)extensions
()Retrieve a generator of extensions
Returns: | A generator of extension instances. |
---|---|
Return type: | Extension |
openstack.identity.v2._proxy.
Proxy
(session, statsd_client=None, statsd_prefix=None, prometheus_counter=None, prometheus_histogram=None, influxdb_config=None, influxdb_client=None, *args, **kwargs)create_user
(**attrs)Create a new user from attributes
Parameters: | attrs (dict) – Keyword arguments which will be used to create
a User ,
comprised of the properties on the User class. |
---|---|
Returns: | The results of user creation |
Return type: | User |
delete_user
(user, ignore_missing=True)Delete a user
Parameters: |
|
---|---|
Returns: |
|
find_user
(name_or_id, ignore_missing=True)Find a single user
Parameters: |
|
---|---|
Returns: | One |
get_user
(user)Get a single user
Parameters: | user – The value can be the ID of a user or a
User instance. |
---|---|
Returns: | One User |
Raises: | ResourceNotFound
when no resource can be found. |
users
(**query)Retrieve a generator of users
Parameters: | query (kwargs) – Optional query parameters to be sent to limit the resources being returned. |
---|---|
Returns: | A generator of user instances. |
Return type: | User |
openstack.identity.v2._proxy.
Proxy
(session, statsd_client=None, statsd_prefix=None, prometheus_counter=None, prometheus_histogram=None, influxdb_config=None, influxdb_client=None, *args, **kwargs)create_role
(**attrs)Create a new role from attributes
Parameters: | attrs (dict) – Keyword arguments which will be used to create
a Role ,
comprised of the properties on the Role class. |
---|---|
Returns: | The results of role creation |
Return type: | Role |
delete_role
(role, ignore_missing=True)Delete a role
Parameters: |
|
---|---|
Returns: |
|
find_role
(name_or_id, ignore_missing=True)Find a single role
Parameters: |
|
---|---|
Returns: | One |
get_role
(role)Get a single role
Parameters: | role – The value can be the ID of a role or a
Role instance. |
---|---|
Returns: | One Role |
Raises: | ResourceNotFound
when no resource can be found. |
roles
(**query)Retrieve a generator of roles
Parameters: | query (kwargs) – Optional query parameters to be sent to limit the resources being returned. |
---|---|
Returns: | A generator of role instances. |
Return type: | Role |
openstack.identity.v2._proxy.
Proxy
(session, statsd_client=None, statsd_prefix=None, prometheus_counter=None, prometheus_histogram=None, influxdb_config=None, influxdb_client=None, *args, **kwargs)create_tenant
(**attrs)Create a new tenant from attributes
Parameters: | attrs (dict) – Keyword arguments which will be used to create
a Tenant ,
comprised of the properties on the Tenant class. |
---|---|
Returns: | The results of tenant creation |
Return type: | Tenant |
delete_tenant
(tenant, ignore_missing=True)Delete a tenant
Parameters: |
|
---|---|
Returns: |
|
find_tenant
(name_or_id, ignore_missing=True)Find a single tenant
Parameters: |
|
---|---|
Returns: | One |
get_tenant
(tenant)Get a single tenant
Parameters: | tenant – The value can be the ID of a tenant or a
Tenant instance. |
---|---|
Returns: | One Tenant |
Raises: | ResourceNotFound
when no resource can be found. |
tenants
(**query)Retrieve a generator of tenants
Parameters: | query (kwargs) – Optional query parameters to be sent to limit the resources being returned. |
---|---|
Returns: | A generator of tenant instances. |
Return type: | Tenant |
Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.