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.v3._proxy.
Proxy
(session, statsd_client=None, statsd_prefix=None, prometheus_counter=None, prometheus_histogram=None, influxdb_config=None, influxdb_client=None, *args, **kwargs)create_credential
(**attrs)Create a new credential from attributes
attrs (dict) – Keyword arguments which will be used to create
a Credential
,
comprised of the properties on the Credential class.
The results of credential creation
delete_credential
(credential, ignore_missing=True)Delete a credential
credential – The value can be either the ID of a credential or a
Credential
instance.
ignore_missing (bool) – When set to False
ResourceNotFound
will be
raised when the credential does not exist.
When set to True
, no exception will be set when
attempting to delete a nonexistent credential.
None
find_credential
(name_or_id, ignore_missing=True)Find a single credential
name_or_id – The name or ID of a credential.
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 Credential
or None
get_credential
(credential)Get a single credential
credential – The value can be the ID of a credential or a
Credential
instance.
One Credential
ResourceNotFound
when no resource can be found.
credentials
(**query)Retrieve a generator of credentials
query (kwargs) – Optional query parameters to be sent to limit the resources being returned.
A generator of credentials instances.
update_credential
(credential, **attrs)Update a credential
credential – Either the ID of a credential or a
Credential
instance.
The attributes to update on the credential represented
by value
.
The updated credential
openstack.identity.v3._proxy.
Proxy
(session, statsd_client=None, statsd_prefix=None, prometheus_counter=None, prometheus_histogram=None, influxdb_config=None, influxdb_client=None, *args, **kwargs)create_domain
(**attrs)Create a new domain from attributes
delete_domain
(domain, ignore_missing=True)Delete a domain
domain – The value can be either the ID of a domain or a
Domain
instance.
ignore_missing (bool) – When set to False
ResourceNotFound
will be
raised when the domain does not exist.
When set to True
, no exception will be set when
attempting to delete a nonexistent domain.
None
find_domain
(name_or_id, ignore_missing=True)Find a single domain
name_or_id – The name or ID of a domain.
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 Domain
or None
get_domain
(domain)Get a single domain
domains
(**query)Retrieve a generator of domains
query (kwargs) – Optional query parameters to be sent to limit the resources being returned.
A generator of domain instances.
openstack.identity.v3._proxy.
Proxy
(session, statsd_client=None, statsd_prefix=None, prometheus_counter=None, prometheus_histogram=None, influxdb_config=None, influxdb_client=None, *args, **kwargs)create_endpoint
(**attrs)Create a new endpoint from attributes
delete_endpoint
(endpoint, ignore_missing=True)Delete an endpoint
endpoint – The value can be either the ID of an endpoint or a
Endpoint
instance.
ignore_missing (bool) – When set to False
ResourceNotFound
will be
raised when the endpoint does not exist.
When set to True
, no exception will be set when
attempting to delete a nonexistent endpoint.
None
find_endpoint
(name_or_id, ignore_missing=True)Find a single endpoint
name_or_id – The name or ID of a endpoint.
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 Endpoint
or None
get_endpoint
(endpoint)Get a single endpoint
endpoints
(**query)Retrieve a generator of endpoints
query (kwargs) – Optional query parameters to be sent to limit the resources being returned.
A generator of endpoint instances.
openstack.identity.v3._proxy.
Proxy
(session, statsd_client=None, statsd_prefix=None, prometheus_counter=None, prometheus_histogram=None, influxdb_config=None, influxdb_client=None, *args, **kwargs)create_group
(**attrs)Create a new group from attributes
delete_group
(group, ignore_missing=True)Delete a group
group – The value can be either the ID of a group or a
Group
instance.
ignore_missing (bool) – When set to False
ResourceNotFound
will be
raised when the group does not exist.
When set to True
, no exception will be set when
attempting to delete a nonexistent group.
None
find_group
(name_or_id, ignore_missing=True, **kwargs)Find a single group
name_or_id – The name or ID of a group.
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 Group
or None
get_group
(group)Get a single group
groups
(**query)Retrieve a generator of groups
query (kwargs) – Optional query parameters to be sent to limit the resources being returned.
A generator of group instances.
update_group
(group, **attrs)Update a group
add_user_to_group
(user, group)Add user to group
remove_user_from_group
(user, group)Remove user to group
openstack.identity.v3._proxy.
Proxy
(session, statsd_client=None, statsd_prefix=None, prometheus_counter=None, prometheus_histogram=None, influxdb_config=None, influxdb_client=None, *args, **kwargs)create_policy
(**attrs)Create a new policy from attributes
delete_policy
(policy, ignore_missing=True)Delete a policy
policy – The value can be either the ID of a policy or a
Policy
instance.
ignore_missing (bool) – When set to False
ResourceNotFound
will be
raised when the policy does not exist.
When set to True
, no exception will be set when
attempting to delete a nonexistent policy.
None
find_policy
(name_or_id, ignore_missing=True)Find a single policy
name_or_id – The name or ID of a policy.
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 Policy
or None
get_policy
(policy)Get a single policy
policies
(**query)Retrieve a generator of policies
query (kwargs) – Optional query parameters to be sent to limit the resources being returned.
A generator of policy instances.
openstack.identity.v3._proxy.
Proxy
(session, statsd_client=None, statsd_prefix=None, prometheus_counter=None, prometheus_histogram=None, influxdb_config=None, influxdb_client=None, *args, **kwargs)create_project
(**attrs)Create a new project from attributes
delete_project
(project, ignore_missing=True)Delete a project
project – The value can be either the ID of a project or a
Project
instance.
ignore_missing (bool) – When set to False
ResourceNotFound
will be
raised when the project does not exist.
When set to True
, no exception will be set when
attempting to delete a nonexistent project.
None
find_project
(name_or_id, ignore_missing=True, **attrs)Find a single project
name_or_id – The name or ID of a project.
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 Project
or None
get_project
(project)Get a single project
projects
(**query)Retrieve a generator of projects
query (kwargs) – Optional query parameters to be sent to limit the resources being returned.
A generator of project instances.
openstack.identity.v3._proxy.
Proxy
(session, statsd_client=None, statsd_prefix=None, prometheus_counter=None, prometheus_histogram=None, influxdb_config=None, influxdb_client=None, *args, **kwargs)create_region
(**attrs)Create a new region from attributes
attrs (dict) – Keyword arguments which will be used to create
a Region
,
comprised of the properties on the Region class.
The results of region creation.
Region
delete_region
(region, ignore_missing=True)Delete a region
region – The value can be either the ID of a region or a
Region
instance.
ignore_missing (bool) – When set to False
ResourceNotFound
will be
raised when the region does not exist.
When set to True
, no exception will be thrown when
attempting to delete a nonexistent region.
None
find_region
(name_or_id, ignore_missing=True)Find a single region
name_or_id – The name or ID of a region.
ignore_missing (bool) – When set to False
ResourceNotFound
will be
raised when the region does not exist.
When set to True
, None will be returned when
attempting to find a nonexistent region.
One Region
or None
get_region
(region)Get a single region
region – The value can be the ID of a region or a
Region
instance.
One Region
ResourceNotFound
when no matching region can be found.
regions
(**query)Retrieve a generator of regions
query (kwargs) – Optional query parameters to be sent to limit the regions being returned.
A generator of region instances.
Region
update_region
(region, **attrs)Update a region
region – Either the ID of a region or a
Region
instance.
The attributes to update on the region represented
by value
.
The updated region.
Region
openstack.identity.v3._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
attrs (dict) – Keyword arguments which will be used to create
a Role
,
comprised of the properties on the Role class.
The results of role creation.
Role
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 thrown when
attempting to delete a nonexistent role.
None
find_role
(name_or_id, ignore_missing=True, **kwargs)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 role does not exist.
When set to True
, None will be returned when
attempting to find a nonexistent role.
One Role
or None
get_role
(role)Get a single role
role – The value can be the ID of a role or a
Role
instance.
One Role
ResourceNotFound
when no matching role can be found.
roles
(**query)Retrieve a generator of roles
query (kwargs) – Optional query parameters to be sent to limit the resources being returned. The options are: domain_id, name.
A generator of role instances.
Role
update_role
(role, **attrs)Update a role
role – Either the ID of a role or a
Role
instance.
kwargs (dict) – The attributes to update on the role represented
by value
. Only name can be updated
The updated role.
Role
openstack.identity.v3._proxy.
Proxy
(session, statsd_client=None, statsd_prefix=None, prometheus_counter=None, prometheus_histogram=None, influxdb_config=None, influxdb_client=None, *args, **kwargs)role_assignments_filter
(domain=None, project=None, system=None, group=None, user=None)Retrieve a generator of roles assigned to user/group
A generator of role instances.
Role
role_assignments
(**query)Retrieve a generator of role assignments
query (kwargs) – Optional query parameters to be sent to limit the resources being returned. The options are: group_id, role_id, scope_domain_id, scope_project_id, user_id, include_names, include_subtree.
RoleAssignment
assign_domain_role_to_user
(domain, user, role)Assign role to user on a domain
unassign_domain_role_from_user
(domain, user, role)Unassign role from user on a domain
validate_user_has_domain_role
(domain, user, role)Validates that a user has a role on a domain
assign_domain_role_to_group
(domain, group, role)Assign role to group on a domain
unassign_domain_role_from_group
(domain, group, role)Unassign role from group on a domain
validate_group_has_domain_role
(domain, group, role)Validates that a group has a role on a domain
assign_project_role_to_user
(project, user, role)Assign role to user on a project
unassign_project_role_from_user
(project, user, role)Unassign role from user on a project
validate_user_has_project_role
(project, user, role)Validates that a user has a role on a project
assign_project_role_to_group
(project, group, role)Assign role to group on a project
unassign_project_role_from_group
(project, group, role)Unassign role from group on a project
validate_group_has_project_role
(project, group, role)Validates that a group has a role on a project
assign_system_role_to_user
(user, role, system)Assign a role to user on a system
user – Either the ID of a user or a
User
instance.
role – Either the ID of a role or a
Role
instance.
system – The system name
None
unassign_system_role_from_user
(user, role, system)Unassign a role from user on a system
user – Either the ID of a user or a
User
instance.
role – Either the ID of a role or a
Role
instance.
system – The system name
None
validate_user_has_system_role
(user, role, system)Validates that a user has a role on a system
user – Either the ID of a user or a
User
instance.
role – Either the ID of a role or a
Role
instance.
system – The system name
True if user has role in system
assign_system_role_to_group
(group, role, system)Assign a role to group on a system
group – Either the ID of a group or a
Group
instance.
role – Either the ID of a role or a
Role
instance.
system – The system name
None
unassign_system_role_from_group
(group, role, system)Unassign a role from group on a system
group – Either the ID of a group or a
Group
instance.
role – Either the ID of a role or a
Role
instance.
system – The system name
None
validate_group_has_system_role
(group, role, system)Validates that a group has a role on a system
group – Either the ID of a group or a
Group
instance.
role – Either the ID of a role or a
Role
instance.
system – The system name
True if group has role on system
openstack.identity.v3._proxy.
Proxy
(session, statsd_client=None, statsd_prefix=None, prometheus_counter=None, prometheus_histogram=None, influxdb_config=None, influxdb_client=None, *args, **kwargs)create_service
(**attrs)Create a new service from attributes
delete_service
(service, ignore_missing=True)Delete a service
service – The value can be either the ID of a service or a
Service
instance.
ignore_missing (bool) – When set to False
ResourceNotFound
will be
raised when the service does not exist.
When set to True
, no exception will be set when
attempting to delete a nonexistent service.
None
find_service
(name_or_id, ignore_missing=True)Find a single service
name_or_id – The name or ID of a service.
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 Service
or None
get_service
(service)Get a single service
services
(**query)Retrieve a generator of services
query (kwargs) – Optional query parameters to be sent to limit the resources being returned.
A generator of service instances.
openstack.identity.v3._proxy.
Proxy
(session, statsd_client=None, statsd_prefix=None, prometheus_counter=None, prometheus_histogram=None, influxdb_config=None, influxdb_client=None, *args, **kwargs)create_trust
(**attrs)Create a new trust from attributes
delete_trust
(trust, ignore_missing=True)Delete a trust
trust – The value can be either the ID of a trust or a
Trust
instance.
ignore_missing (bool) – When set to False
ResourceNotFound
will be
raised when the credential does not exist.
When set to True
, no exception will be set when
attempting to delete a nonexistent credential.
None
find_trust
(name_or_id, ignore_missing=True)Find a single trust
name_or_id – The name or ID of a trust.
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 Trust
or None
get_trust
(trust)Get a single trust
trusts
(**query)Retrieve a generator of trusts
query (kwargs) – Optional query parameters to be sent to limit the resources being returned.
A generator of trust instances.
openstack.identity.v3._proxy.
Proxy
(session, statsd_client=None, statsd_prefix=None, prometheus_counter=None, prometheus_histogram=None, influxdb_config=None, influxdb_client=None, *args, **kwargs)user_projects
(user, **query)to access.
user – Either the user id or an instance of
User
query (kwargs) – Optional query parameters to be sent to limit the resources being returned.
A generator of project instances.
UserProject
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, **attrs)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.
Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.