openstack.identity.v3.endpoint¶
The Endpoint Class¶
The Endpoint
class inherits from Resource
.
-
class
openstack.identity.v3.endpoint.
Endpoint
(attrs=None, loaded=False)¶ Construct a Resource to interact with a service’s REST API.
The Resource class offers two class methods to construct resource objects, which are preferrable to entering through this initializer. See
Resource.new()
andResource.existing()
.Parameters: - attrs (dict) – The attributes to set when constructing this Resource.
- loaded (bool) –
True
if this Resource exists on the server,False
if it does not.
-
enabled
= None¶ Setting this value to
False
prevents the endpoint from appearing in the service catalog. Type: bool
-
interface
= None¶ 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
-
region_id
= None¶ Represents the containing region ID of the service endpoint. New in v3.2 Type: string
-
service_id
= None¶ References the service ID to which the endpoint belongs. Type: string
-
url
= None¶ Fully qualified URL of the service endpoint. Type: string