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
A generator of extension instances.
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
delete_user
(user, ignore_missing=True)Delete a user
user – The value can be either the ID of a user or a
User
instance.
ignore_missing (bool) – When set to False
ResourceNotFound
will be
raised when the user does not exist.
When set to True
, no exception will be set when
attempting to delete a nonexistent user.
None
find_user
(name_or_id, ignore_missing=True)Find a single user
name_or_id – The name or ID of a user.
ignore_missing (bool) – When set to False
ResourceNotFound
will be
raised when the resource does not exist.
When set to True
, None will be returned when
attempting to find a nonexistent resource.
One User
or None
get_user
(user)Get a single user
users
(**query)Retrieve a generator of users
query (kwargs) – Optional query parameters to be sent to limit the resources being returned.
A generator of user instances.
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
delete_role
(role, ignore_missing=True)Delete a role
role – The value can be either the ID of a role or a
Role
instance.
ignore_missing (bool) – When set to False
ResourceNotFound
will be
raised when the role does not exist.
When set to True
, no exception will be set when
attempting to delete a nonexistent role.
None
find_role
(name_or_id, ignore_missing=True)Find a single role
name_or_id – The name or ID of a role.
ignore_missing (bool) – When set to False
ResourceNotFound
will be
raised when the resource does not exist.
When set to True
, None will be returned when
attempting to find a nonexistent resource.
One Role
or None
get_role
(role)Get a single role
roles
(**query)Retrieve a generator of roles
query (kwargs) – Optional query parameters to be sent to limit the resources being returned.
A generator of role instances.
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
delete_tenant
(tenant, ignore_missing=True)Delete a tenant
tenant – The value can be either the ID of a tenant or a
Tenant
instance.
ignore_missing (bool) – When set to False
ResourceNotFound
will be
raised when the tenant does not exist.
When set to True
, no exception will be set when
attempting to delete a nonexistent tenant.
None
find_tenant
(name_or_id, ignore_missing=True)Find a single tenant
name_or_id – The name or ID of a tenant.
ignore_missing (bool) – When set to False
ResourceNotFound
will be
raised when the resource does not exist.
When set to True
, None will be returned when
attempting to find a nonexistent resource.
One Tenant
or None
get_tenant
(tenant)Get a single tenant
tenants
(**query)Retrieve a generator of tenants
query (kwargs) – Optional query parameters to be sent to limit the resources being returned.
A generator of tenant instances.
Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.