Bases: keystoneclient.httpclient.HTTPClient
Client for the OpenStack Identity API v3.
Parameters: |
|
---|
Example:
>>> from keystoneclient.v3 import client
>>> keystone = client.Client(user_domain_name=DOMAIN_NAME,
... username=USER,
... password=PASS,
... project_domain_name=PROJECT_DOMAIN_NAME,
... project_name=PROJECT_NAME,
... auth_url=KEYSTONE_URL)
...
>>> keystone.projects.list()
...
>>> user = keystone.users.get(USER_ID)
>>> user.delete()
Instances of this class have the following managers:
keystoneclient.v3.contrib.endpoint_filter.EndpointFilterManager
keystoneclient.v3.contrib.endpoint_policy.EndpointPolicyManager
Authenticate against the v3 Identity API.
If password and token methods are both provided then both methods will be used in the request.
Returns: | access.AccessInfo if authentication was successful. |
---|---|
Raises: |
|
Extract and process information from the new auth_ref.
And set the relevant authentication information.
Bases: keystoneclient.base.Resource
Represents an Identity credential.
Bases: keystoneclient.base.CrudManager
Manager class for manipulating Identity credentials.
Create a credential
Parameters: |
|
---|---|
Raises ValueError: | |
if one of blob or data is not specified. |
Delete a credential
Parameters: | credential (Credential or str) – Credential |
---|
Get a credential
Parameters: | credential (Credential or str) – Credential |
---|
List credentials.
If **kwargs are provided, then filter credentials with attributes matching **kwargs.
alias of Credential
Update a credential
Parameters: |
|
---|---|
Raises ValueError: | |
if one of blob or data is not specified. |
Bases: keystoneclient.base.Resource
Represents an Identity domain.
Bases: keystoneclient.base.CrudManager
Manager class for manipulating Identity domains.
List domains.
Bases: keystoneclient.base.Resource
Represents an Identity endpoint.
Bases: keystoneclient.base.CrudManager
Manager class for manipulating Identity endpoints.
List endpoints.
If **kwargs are provided, then filter endpoints with attributes matching **kwargs.
Bases: keystoneclient.base.Resource
Represents an Identity user group.
Bases: keystoneclient.base.CrudManager
Manager class for manipulating Identity groups.
List groups.
If domain or user is provided, then filter groups with that attribute.
If **kwargs are provided, then filter groups with attributes matching **kwargs.
Bases: keystoneclient.base.Resource
Represents an Identity policy.
Bases: keystoneclient.base.CrudManager
Manager class for manipulating Identity policies.
List policies.
Bases: keystoneclient.base.Resource
Represents an Identity project.
id: a uuid that identifies the project
name: project name
description: project description
enabled: boolean to indicate if project is enabled
parent_id: a uuid representing this project’s parent in hierarchy
project in the hierarchy
project in the hierarchy
Bases: keystoneclient.base.CrudManager
Manager class for manipulating Identity projects.
Create a project.
Parameters: |
|
---|
Get a project.
Parameters: |
|
---|---|
Raises keystoneclient.exceptions.ValidationError: | |
if subtree_as_list and subtree_as_ids or parents_as_list and parents_as_ids are included at the same time in the call. |
List projects.
If domain or user are provided, then filter projects with those attributes.
If **kwargs are provided, then filter projects with attributes matching **kwargs.
Bases: keystoneclient.base.Resource
Represents a Catalog region.
Bases: keystoneclient.base.CrudManager
Manager class for manipulating Identity endpoints.
Create a Catalog region.
Parameters: |
|
---|
List regions.
If **kwargs are provided, then filter regions with attributes matching **kwargs.
Update a Catalog region.
Parameters: |
|
---|
Bases: keystoneclient.base.Resource
Represents an Identity role assignment.
role: an object which contains a role uuid
group uuid
containing an uuid
Bases: keystoneclient.base.CrudManager
Manager class for manipulating Identity roles assignments.
Lists role assignments.
If no arguments are provided, all role assignments in the system will be listed.
If both user and group are provided, a ValidationError will be raised. If both domain and project are provided, it will also raise a ValidationError.
Parameters: |
|
---|
alias of RoleAssignment
Bases: keystoneclient.base.Resource
Represents an Identity role.
Bases: keystoneclient.base.CrudManager
Manager class for manipulating Identity roles.
Checks if a user or group has a role on a domain or project.
Grants a role to a user or group on a domain or project.
Lists roles and role grants.
If no arguments are provided, all roles in the system will be listed.
If a user or group is specified, you must also specify either a domain or project to list role grants on that pair. And if **kwargs are provided, then also filter roles with attributes matching **kwargs.
Revokes a role from a user or group on a domain or project.
Bases: keystoneclient.base.Resource
Represents an Identity service.
Bases: object
Manager class for manipulating Identity tokens.
Get revoked tokens list.
Returns: | A dict containing “signed” which is a CMS formatted string. |
---|---|
Return type: | dict |
Revoke a token.
Parameters: | token – Token to be revoked. This can be an instance of keystoneclient.access.AccessInfo or a string token_id. |
---|
Validate a token.
Parameters: |
|
---|---|
Return type: |
Bases: keystoneclient.base.Resource
Represents an Identity user.
Bases: keystoneclient.base.CrudManager
Manager class for manipulating Identity users.
Create a user.
Warning
The project argument is deprecated, use default_project instead.
If both default_project and project is provided, the default_project will be used.
List users.
If project, domain or group are provided, then filter users with those attributes.
If **kwargs are provided, then filter users with attributes matching **kwargs.
Warning
The project argument is deprecated, use default_project instead.
If both default_project and project is provided, the default_project will be used.
Update a user.
Warning
The project argument is deprecated, use default_project instead.
If both default_project and project is provided, the default_project will be used.
Update the password for the user the token belongs to.