openstack.identity.v3.endpoint

The Endpoint Class

The Endpoint class inherits from Resource.

class openstack.identity.v3.endpoint.Endpoint(_synchronized=False, connection=None, **attrs)

The base resource

Parameters:

  • _synchronized (bool) – This is not intended to be used directly. See new() and existing().

  • connection (openstack.connection.Connection) – Reference to the Connection being used. Defaults to None to allow Resource objects to be used without an active Connection, such as in unit tests. Use of self._connection in Resource code should protect itself with a check for None.

resource_key = 'endpoint'

Singular form of key for resource.

resources_key = 'endpoints'

Plural form of key for resource.

base_path = '/endpoints'

The base part of the URI for this resource.

allow_create = True

Allow create operation for this resource.

allow_fetch = True

Allow get operation for this resource.

allow_commit = True

Allow update operation for this resource.

allow_delete = True

Allow delete operation for this resource.

allow_list = True

Allow list operation for this resource.

commit_method = 'PATCH'

Method for committing a resource (PUT, PATCH, POST)

interface

Describes the interface of the endpoint according to one of the following values:

  • public: intended for consumption by end users, generally on a

    publicly available network interface

  • internal: not intended for consumption by end users, generally on an

    unmetered internal network interface

  • admin: intended only for consumption by those needing administrative

    access to the service, generally on a secure network interface

Type: string

is_enabled

Setting this value to False prevents the endpoint from appearing in the service catalog. Type: bool

The links for the region resource.

region_id

Represents the containing region ID of the service endpoint. New in v3.2 Type: string

service_id

References the service ID to which the endpoint belongs. Type: string

url

Fully qualified URL of the service endpoint. Type: string