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
Parameters: | attrs (dict) – Keyword arguments which will be used to create
a Credential ,
comprised of the properties on the Credential class. |
---|---|
Returns: | The results of credential creation |
Return type: | Credential |
delete_credential
(credential, ignore_missing=True)Delete a credential
Parameters: |
|
---|---|
Returns: |
|
find_credential
(name_or_id, ignore_missing=True)Find a single credential
Parameters: |
|
---|---|
Returns: | One |
get_credential
(credential)Get a single credential
Parameters: | credential – The value can be the ID of a credential or a
Credential instance. |
---|---|
Returns: | One Credential |
Raises: | ResourceNotFound
when no resource can be found. |
credentials
(**query)Retrieve a generator of credentials
Parameters: | query (kwargs) – Optional query parameters to be sent to limit the resources being returned. |
---|---|
Returns: | A generator of credentials instances. |
Return type: | Credential |
update_credential
(credential, **attrs)Update a credential
Parameters: | credential – Either the ID of a credential or a
Credential instance. |
---|---|
Attrs kwargs: | The attributes to update on the credential represented
by value . |
Returns: | The updated credential |
Return type: | 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
Parameters: | attrs (dict) – Keyword arguments which will be used to create
a Domain ,
comprised of the properties on the Domain class. |
---|---|
Returns: | The results of domain creation |
Return type: | Domain |
delete_domain
(domain, ignore_missing=True)Delete a domain
Parameters: |
|
---|---|
Returns: |
|
find_domain
(name_or_id, ignore_missing=True)Find a single domain
Parameters: |
|
---|---|
Returns: | One |
get_domain
(domain)Get a single domain
Parameters: | domain – The value can be the ID of a domain or a
Domain instance. |
---|---|
Returns: | One Domain |
Raises: | ResourceNotFound
when no resource can be found. |
domains
(**query)Retrieve a generator of domains
Parameters: | query (kwargs) – Optional query parameters to be sent to limit the resources being returned. |
---|---|
Returns: | A generator of domain instances. |
Return type: | Domain |
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
Parameters: | attrs (dict) – Keyword arguments which will be used to create
a Endpoint ,
comprised of the properties on the Endpoint class. |
---|---|
Returns: | The results of endpoint creation |
Return type: | Endpoint |
delete_endpoint
(endpoint, ignore_missing=True)Delete an endpoint
Parameters: |
|
---|---|
Returns: |
|
find_endpoint
(name_or_id, ignore_missing=True)Find a single endpoint
Parameters: |
|
---|---|
Returns: | One |
get_endpoint
(endpoint)Get a single endpoint
Parameters: | endpoint – The value can be the ID of an endpoint or a
Endpoint
instance. |
---|---|
Returns: | One Endpoint |
Raises: | ResourceNotFound
when no resource can be found. |
endpoints
(**query)Retrieve a generator of endpoints
Parameters: | query (kwargs) – Optional query parameters to be sent to limit the resources being returned. |
---|---|
Returns: | A generator of endpoint instances. |
Return type: | Endpoint |
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
Parameters: | attrs (dict) – Keyword arguments which will be used to create
a Group ,
comprised of the properties on the Group class. |
---|---|
Returns: | The results of group creation |
Return type: | Group |
delete_group
(group, ignore_missing=True)Delete a group
Parameters: |
|
---|---|
Returns: |
|
find_group
(name_or_id, ignore_missing=True)Find a single group
Parameters: |
|
---|---|
Returns: | One |
get_group
(group)Get a single group
Parameters: | group – The value can be the ID of a group or a
Group
instance. |
---|---|
Returns: | One Group |
Raises: | ResourceNotFound
when no resource can be found. |
groups
(**query)Retrieve a generator of groups
Parameters: | query (kwargs) – Optional query parameters to be sent to limit the resources being returned. |
---|---|
Returns: | A generator of group instances. |
Return type: | 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
Parameters: | attrs (dict) – Keyword arguments which will be used to create
a Policy ,
comprised of the properties on the Policy class. |
---|---|
Returns: | The results of policy creation |
Return type: | Policy |
delete_policy
(policy, ignore_missing=True)Delete a policy
Parameters: |
|
---|---|
Returns: |
|
find_policy
(name_or_id, ignore_missing=True)Find a single policy
Parameters: |
|
---|---|
Returns: | One |
get_policy
(policy)Get a single policy
Parameters: | policy – The value can be the ID of a policy or a
Policy instance. |
---|---|
Returns: | One Policy |
Raises: | ResourceNotFound
when no resource can be found. |
policies
(**query)Retrieve a generator of policies
Parameters: | query (kwargs) – Optional query parameters to be sent to limit the resources being returned. |
---|---|
Returns: | A generator of policy instances. |
Return type: | Policy |
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
Parameters: | attrs (dict) – Keyword arguments which will be used to create
a Project ,
comprised of the properties on the Project class. |
---|---|
Returns: | The results of project creation |
Return type: | Project |
delete_project
(project, ignore_missing=True)Delete a project
Parameters: |
|
---|---|
Returns: |
|
find_project
(name_or_id, ignore_missing=True, **attrs)Find a single project
Parameters: |
|
---|---|
Returns: | One |
get_project
(project)Get a single project
Parameters: | project – The value can be the ID of a project or a
Project instance. |
---|---|
Returns: | One Project |
Raises: | ResourceNotFound
when no resource can be found. |
projects
(**query)Retrieve a generator of projects
Parameters: | query (kwargs) – Optional query parameters to be sent to limit the resources being returned. |
---|---|
Returns: | A generator of project instances. |
Return type: | Project |
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
Parameters: | attrs (dict) – Keyword arguments which will be used to create
a Region ,
comprised of the properties on the Region class. |
---|---|
Returns: | The results of region creation. |
Return type: | Region |
delete_region
(region, ignore_missing=True)Delete a region
Parameters: |
|
---|---|
Returns: |
|
find_region
(name_or_id, ignore_missing=True)Find a single region
Parameters: |
|
---|---|
Returns: | One |
get_region
(region)Get a single region
Parameters: | region – The value can be the ID of a region or a
Region instance. |
---|---|
Returns: | One Region |
Raises: | ResourceNotFound
when no matching region can be found. |
regions
(**query)Retrieve a generator of regions
Parameters: | query (kwargs) – Optional query parameters to be sent to limit the regions being returned. |
---|---|
Returns: | A generator of region instances. |
Return type: | Region |
update_region
(region, **attrs)Update a region
Parameters: | region – Either the ID of a region or a
Region instance. |
---|---|
Attrs kwargs: | The attributes to update on the region represented
by value . |
Returns: | The updated region. |
Return type: | 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
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 matching role 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. The options are: domain_id, name. |
---|---|
Returns: | A generator of role instances. |
Return type: | Role |
update_role
(role, **attrs)Update a role
Parameters: |
|
---|---|
Returns: | The updated role. |
Return type: |
|
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, group=None, user=None)Retrieve a generator of roles assigned to user/group
Parameters: | |
---|---|
Returns: | A generator of role instances. |
Return type: |
|
role_assignments
(**query)Retrieve a generator of role assignments
Parameters: | 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. |
---|---|
Returns: | RoleAssignment |
assign_project_role_to_user
(project, user, role)Assign role to user on a project
Parameters: | |
---|---|
Returns: |
|
unassign_project_role_from_user
(project, user, role)Unassign role from user on a project
Parameters: | |
---|---|
Returns: |
|
validate_user_has_role
(project, user, role)Validates that a user has a role on a project
Parameters: | |
---|---|
Returns: | True if user has role in project |
assign_project_role_to_group
(project, group, role)Assign role to group on a project
Parameters: | |
---|---|
Returns: |
|
unassign_project_role_from_group
(project, group, role)Unassign role from group on a project
Parameters: | |
---|---|
Returns: |
|
validate_group_has_role
(project, group, role)Validates that a group has a role on a project
Parameters: | |
---|---|
Returns: | True if group has role in project |
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
Parameters: | attrs (dict) – Keyword arguments which will be used to create
a Service ,
comprised of the properties on the Service class. |
---|---|
Returns: | The results of service creation |
Return type: | Service |
delete_service
(service, ignore_missing=True)Delete a service
Parameters: |
|
---|---|
Returns: |
|
find_service
(name_or_id, ignore_missing=True)Find a single service
Parameters: |
|
---|---|
Returns: | One |
get_service
(service)Get a single service
Parameters: | service – The value can be the ID of a service or a
Service instance. |
---|---|
Returns: | One Service |
Raises: | ResourceNotFound
when no resource can be found. |
services
(**query)Retrieve a generator of services
Parameters: | query (kwargs) – Optional query parameters to be sent to limit the resources being returned. |
---|---|
Returns: | A generator of service instances. |
Return type: | Service |
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
Parameters: | attrs (dict) – Keyword arguments which will be used to create
a Trust ,
comprised of the properties on the Trust class. |
---|---|
Returns: | The results of trust creation |
Return type: | Trust |
delete_trust
(trust, ignore_missing=True)Delete a trust
Parameters: |
|
---|---|
Returns: |
|
find_trust
(name_or_id, ignore_missing=True)Find a single trust
Parameters: |
|
---|---|
Returns: | One |
get_trust
(trust)Get a single trust
Parameters: | trust – The value can be the ID of a trust or a
Trust instance. |
---|---|
Returns: | One Trust |
Raises: | ResourceNotFound
when no resource can be found. |
trusts
(**query)Retrieve a generator of trusts
Parameters: | query (kwargs) – Optional query parameters to be sent to limit the resources being returned. |
---|---|
Returns: | A generator of trust instances. |
Return type: | Trust |
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)Parameters: |
|
---|---|
Returns: | A generator of project instances. |
Return type: |
|
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, **attrs)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 |
Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.