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.
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 a role
Parameters: |
|
---|---|
Returns: | None |
Find a single role
Parameters: |
|
---|---|
Returns: | One Role or None |
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. |
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 |
Update a role
Parameters: | role – Either the ID of a role or a Role instance. |
---|---|
Attrs kwargs: | The attributes to update on the role represented by value. |
Returns: | The updated role |
Return type: | Role |
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 a tenant
Parameters: |
|
---|---|
Returns: | None |
Find a single tenant
Parameters: |
|
---|---|
Returns: | One Tenant or None |
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. |
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 |
Update a tenant
Parameters: | tenant – Either the ID of a tenant or a Tenant instance. |
---|---|
Attrs kwargs: | The attributes to update on the tenant represented by value. |
Returns: | The updated tenant |
Return type: | Tenant |
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 a user
Parameters: |
|
---|---|
Returns: | None |
Find a single user
Parameters: |
|
---|---|
Returns: | One User or None |
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. |
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.
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 a credential
Parameters: |
|
---|---|
Returns: | None |
Find a single credential
Parameters: |
|
---|---|
Returns: | One Credential or None |
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. |
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 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 |
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 a domain
Parameters: |
|
---|---|
Returns: | None |
Find a single domain
Parameters: |
|
---|---|
Returns: | One Domain or None |
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. |
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 |
Update a domain
Parameters: | domain – Either the ID of a domain or a Domain instance. |
---|---|
Attrs kwargs: | The attributes to update on the domain represented by value. |
Returns: | The updated domain |
Return type: | Domain |
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 an endpoint
Parameters: |
|
---|---|
Returns: | None |
Find a single endpoint
Parameters: |
|
---|---|
Returns: | One Endpoint or None |
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. |
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 |
Update a endpoint
Parameters: | endpoint – Either the ID of a endpoint or a Endpoint instance. |
---|---|
Attrs kwargs: | The attributes to update on the endpoint represented by value. |
Returns: | The updated endpoint |
Return type: | Endpoint |
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 a group
Parameters: |
|
---|---|
Returns: | None |
Find a single group
Parameters: |
|
---|---|
Returns: | One Group or None |
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. |
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 |
Update a group
Parameters: | group – Either the ID of a group or a Group instance. |
---|---|
Attrs kwargs: | The attributes to update on the group represented by value. |
Returns: | The updated group |
Return type: | Group |
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 a policy
Parameters: |
|
---|---|
Returns: | None |
Find a single policy
Parameters: |
|
---|---|
Returns: | One Policy or None |
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. |
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 |
Update a policy
Parameters: | policy – Either the ID of a policy or a Policy instance. |
---|---|
Attrs kwargs: | The attributes to update on the policy represented by value. |
Returns: | The updated policy |
Return type: | Policy |
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 a project
Parameters: |
|
---|---|
Returns: | None |
Find a single project
Parameters: |
|
---|---|
Returns: | One Project or None |
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. |
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 |
Update a project
Parameters: | project – Either the ID of a project or a Project instance. |
---|---|
Attrs kwargs: | The attributes to update on the project represented by value. |
Returns: | The updated project |
Return type: | Project |
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 a service
Parameters: |
|
---|---|
Returns: | None |
Find a single service
Parameters: |
|
---|---|
Returns: | One Service or None |
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. |
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 |
Update a service
Parameters: | service – Either the ID of a service or a Service instance. |
---|---|
Attrs kwargs: | The attributes to update on the service represented by value. |
Returns: | The updated service |
Return type: | Service |
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 a user
Parameters: |
|
---|---|
Returns: | None |
Find a single user
Parameters: |
|
---|---|
Returns: | One User or None |
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. |
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 |
Update a user
Parameters: | user – Either the ID of a user or a User instance. |
---|---|
Attrs kwargs: | The attributes to update on the user represented by value. |
Returns: | The updated user |
Return type: | User |
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 a trust
Parameters: |
|
---|---|
Returns: | None |
Find a single trust
Parameters: |
|
---|---|
Returns: | One Trust or None |
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. |
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 |
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 a region
Parameters: |
|
---|---|
Returns: | None |
Find a single region
Parameters: |
|
---|---|
Returns: | One Region or None |
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. |
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 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 |
Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.