# keystoneclient.v3.contrib package

## Subpackages

- keystoneclient.v3.contrib.federation package
  - Submodules
  - keystoneclient.v3.contrib.federation.base module
    - `EntityManager`
      - `EntityManager.list()`
      - `EntityManager.object_type`
      - `EntityManager.resource_class`
  - keystoneclient.v3.contrib.federation.core module
    - `FederationManager`
  - keystoneclient.v3.contrib.federation.domains module
    - `DomainManager`
      - `DomainManager.object_type`
      - `DomainManager.resource_class`
  - keystoneclient.v3.contrib.federation.identity_providers module
    - `IdentityProvider`
    - `IdentityProviderManager`
      - `IdentityProviderManager.base_url`
      - `IdentityProviderManager.collection_key`
      - `IdentityProviderManager.create()`
      - `IdentityProviderManager.delete()`
      - `IdentityProviderManager.get()`
      - `IdentityProviderManager.key`
      - `IdentityProviderManager.list()`
      - `IdentityProviderManager.resource_class`
      - `IdentityProviderManager.update()`
  - keystoneclient.v3.contrib.federation.mappings module
    - `Mapping`
    - `MappingManager`
      - `MappingManager.base_url`
      - `MappingManager.collection_key`
      - `MappingManager.create()`
      - `MappingManager.delete()`
      - `MappingManager.get()`
      - `MappingManager.key`
      - `MappingManager.list()`
      - `MappingManager.resource_class`
      - `MappingManager.update()`
  - keystoneclient.v3.contrib.federation.projects module
    - `ProjectManager`
      - `ProjectManager.object_type`
      - `ProjectManager.resource_class`
  - keystoneclient.v3.contrib.federation.protocols module
    - `Protocol`
    - `ProtocolManager`
      - `ProtocolManager.base_url`
      - `ProtocolManager.build_url()`
      - `ProtocolManager.collection_key`
      - `ProtocolManager.create()`
      - `ProtocolManager.delete()`
      - `ProtocolManager.get()`
      - `ProtocolManager.key`
      - `ProtocolManager.list()`
      - `ProtocolManager.resource_class`
      - `ProtocolManager.update()`
  - keystoneclient.v3.contrib.federation.saml module
    - `SamlManager`
      - `SamlManager.create_ecp_assertion()`
      - `SamlManager.create_saml_assertion()`
  - keystoneclient.v3.contrib.federation.service_providers module
    - `ServiceProvider`
    - `ServiceProviderManager`
      - `ServiceProviderManager.base_url`
      - `ServiceProviderManager.collection_key`
      - `ServiceProviderManager.create()`
      - `ServiceProviderManager.delete()`
      - `ServiceProviderManager.get()`
      - `ServiceProviderManager.key`
      - `ServiceProviderManager.list()`
      - `ServiceProviderManager.resource_class`
      - `ServiceProviderManager.update()`
  - Module contents
- keystoneclient.v3.contrib.oauth1 package
  - Submodules
  - keystoneclient.v3.contrib.oauth1.access_tokens module
    - `AccessToken`
    - `AccessTokenManager`
      - `AccessTokenManager.create()`
      - `AccessTokenManager.resource_class`
  - keystoneclient.v3.contrib.oauth1.auth module
    - `OAuth`
    - `OAuthMethod`
      - `OAuthMethod.get_auth_data()`
  - keystoneclient.v3.contrib.oauth1.consumers module
    - `Consumer`
    - `ConsumerManager`
      - `ConsumerManager.base_url`
      - `ConsumerManager.collection_key`
      - `ConsumerManager.create()`
      - `ConsumerManager.delete()`
      - `ConsumerManager.get()`
      - `ConsumerManager.key`
      - `ConsumerManager.resource_class`
      - `ConsumerManager.update()`
  - keystoneclient.v3.contrib.oauth1.core module
    - `OAuthManager`
    - `OAuthManagerOptionalImportProxy`
    - `create_oauth_manager()`
  - keystoneclient.v3.contrib.oauth1.request_tokens module
    - `RequestToken`
      - `RequestToken.authorize()`
    - `RequestTokenManager`
      - `RequestTokenManager.authorize()`
      - `RequestTokenManager.create()`
      - `RequestTokenManager.resource_class`
  - keystoneclient.v3.contrib.oauth1.utils module
    - `get_oauth_token_from_body()`
  - Module contents

## Submodules

## keystoneclient.v3.contrib.endpoint_filter module

class keystoneclient.v3.contrib.endpoint_filter.EndpointFilterManager(client)

  Bases: `Manager`

  Manager class for manipulating project-endpoint associations.

  Project-endpoint associations can be with endpoints directly or via endpoint groups.

  OS_EP_FILTER_EXT = '/OS-EP-FILTER'
  add_endpoint_group_to_project(endpoint_group, project)

    Create a project-endpoint group association.

  add_endpoint_to_project(project, endpoint)

    Create a project-endpoint association.

  check_endpoint_group_in_project(endpoint_group, project)

    Check if project-endpoint group association exists.

  check_endpoint_in_project(project, endpoint)

    Check if project-endpoint association exists.

  delete_endpoint_from_project(project, endpoint)

    Remove a project-endpoint association.

  delete_endpoint_group_from_project(endpoint_group, project)

    Remove a project-endpoint group association.

  list_endpoint_groups_for_project(project)

    List all endpoint groups for a given project.

  list_endpoints_for_project(project)

    List all endpoints for a given project.

  list_projects_for_endpoint(endpoint)

    List all projects for a given endpoint.

  list_projects_for_endpoint_group(endpoint_group)

    List all projects associated with a given endpoint group.

## keystoneclient.v3.contrib.endpoint_policy module

class keystoneclient.v3.contrib.endpoint_policy.EndpointPolicyManager(client)

  Bases: `Manager`

  Manager class for manipulating endpoint-policy associations.

  OS_EP_POLICY_EXT = 'OS-ENDPOINT-POLICY'
  check_policy_association_for_endpoint(policy, endpoint)

    Check an association between a policy and an endpoint.

  check_policy_association_for_region_and_service(policy, region, service)

    Check an association between a policy and a service in a region.

  check_policy_association_for_service(policy, service)

    Check an association between a policy and a service.

  create_policy_association_for_endpoint(policy, endpoint)

    Create an association between a policy and an endpoint.

  create_policy_association_for_region_and_service(policy, region, service)

    Create an association between a policy and a service in a region.

  create_policy_association_for_service(policy, service)

    Create an association between a policy and a service.

  delete_policy_association_for_endpoint(policy, endpoint)

    Delete an association between a policy and an endpoint.

  delete_policy_association_for_region_and_service(policy, region, service)

    Delete an association between a policy and a service in a region.

  delete_policy_association_for_service(policy, service)

    Delete an association between a policy and a service.

  get_policy_for_endpoint(endpoint)

    Get the effective policy for an endpoint.

    Parameters:

      endpoint – endpoint object or ID

    Returns:

      policies.Policy object

  list_endpoints_for_policy(policy)

    List endpoints with the effective association to a policy.

    Parameters:

      policy – policy object or ID

    Returns:

      list of endpoints that are associated with the policy

## keystoneclient.v3.contrib.simple_cert module

class keystoneclient.v3.contrib.simple_cert.SimpleCertManager(client)

  Bases: `object`

  Manager for the OS-SIMPLE-CERT extension.

  get_ca_certificates()

    Get CA certificates.

    Returns:

      PEM-formatted string.

    Return type:

      str

  get_certificates()

    Get signing certificates.

    Returns:

      PEM-formatted string.

    Return type:

      str

## keystoneclient.v3.contrib.trusts module

class keystoneclient.v3.contrib.trusts.Trust(manager, info, loaded=False)

  Bases: `Resource`

  Represents a Trust.

  Attributes:

    - id: a uuid that identifies the trust

    - impersonation: allow explicit impersonation

    - project_id: project ID

    - trustee_user_id: a uuid that identifies the trustee

    - trustor_user_id: a uuid that identifies the trustor

class keystoneclient.v3.contrib.trusts.TrustManager(client)

  Bases: `CrudManager`

  Manager class for manipulating Trusts.

  base_url = '/OS-TRUST'
  collection_key = 'trusts'
  create(trustee_user, trustor_user, role_names=None, role_ids=None, project=None, impersonation=False, expires_at=None, remaining_uses=None, **kwargs)

    Create a Trust.

    Parameters:

      - trustee_user (string) – user who is capable of consuming the trust

      - trustor_user (string) – user who’s authorization is being delegated

      - role_names (string) – subset of trustor’s roles to be granted

      - role_ids (string) – subset of trustor’s roles to be granted

      - project (string) – project which the trustor is delegating

      - impersonation (boolean) – enable explicit impersonation

      - expires_at (datetime.datetime) – expiry time

      - remaining_uses (integer) – how many times this trust can be used to generate a token. None means unlimited tokens.

  delete(trust)

    Delete a trust.

  get(trust)

    Get a specific trust.

  key = 'trust'
  list(trustee_user=None, trustor_user=None, **kwargs)

    List Trusts.

  resource_class

    alias of `Trust`

  update()

## Module contents

this page last updated: 2026-04-01 09:38:00

Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.

found an error? report a bug