keystone.api.os_federation module¶

class keystone.api.os_federation.IDPProtocolsCRUDResource[source]¶

Bases: _IdentityProvidersProtocolsResourceBase

delete(idp_id, protocol_id)[source]¶

Delete a protocol from an IDP.

DELETE /OS-FEDERATION/identity_providers/

{idp_id}/protocols/{protocol_id}

get(idp_id, protocol_id)[source]¶

Get protocols for an IDP.

HEAD/GET /OS-FEDERATION/identity_providers/

{idp_id}/protocols/{protocol_id}

methods: t.ClassVar[t.Optional[t.Collection[str]]] = {'DELETE', 'GET', 'PATCH', 'PUT'}¶

The methods this view is registered for. Uses the same default (["GET", "HEAD", "OPTIONS"]) as route and add_url_rule by default.

patch(idp_id, protocol_id)[source]¶

Update protocol for an IDP.

PATCH /OS-FEDERATION/identity_providers/

{idp_id}/protocols/{protocol_id}

put(idp_id, protocol_id)[source]¶

Create protocol for an IDP.

PUT /OS-Federation/identity_providers/{idp_id}/protocols/{protocol_id}

class keystone.api.os_federation.IDPProtocolsListResource[source]¶

Bases: _IdentityProvidersProtocolsResourceBase

get(idp_id)[source]¶

List protocols for an IDP.

HEAD/GET /OS-FEDERATION/identity_providers/{idp_id}/protocols

methods: t.ClassVar[t.Optional[t.Collection[str]]] = {'GET'}¶

The methods this view is registered for. Uses the same default (["GET", "HEAD", "OPTIONS"]) as route and add_url_rule by default.

class keystone.api.os_federation.IdentityProvidersResource[source]¶

Bases: _ResourceBase

api_prefix = '/OS-FEDERATION'¶

collection_key = 'identity_providers'¶

delete(idp_id)[source]¶

get(idp_id=None)[source]¶

member_key = 'identity_provider'¶

methods: t.ClassVar[t.Optional[t.Collection[str]]] = {'DELETE', 'GET', 'PATCH', 'PUT'}¶

The methods this view is registered for. Uses the same default (["GET", "HEAD", "OPTIONS"]) as route and add_url_rule by default.

patch(idp_id)[source]¶

put(idp_id)[source]¶

Create an idp resource for federated authentication.

PUT /OS-FEDERATION/identity_providers/{idp_id}

class keystone.api.os_federation.MappingResource[source]¶

Bases: _ResourceBase

api_prefix = '/OS-FEDERATION'¶

collection_key = 'mappings'¶

delete(mapping_id)[source]¶

Delete a mapping.

DELETE /OS-FEDERATION/mappings/{mapping_id}

get(mapping_id=None)[source]¶

member_key = 'mapping'¶

methods: t.ClassVar[t.Optional[t.Collection[str]]] = {'DELETE', 'GET', 'PATCH', 'PUT'}¶

The methods this view is registered for. Uses the same default (["GET", "HEAD", "OPTIONS"]) as route and add_url_rule by default.

patch(mapping_id)[source]¶

Update a mapping.

PATCH /OS-FEDERATION/mappings/{mapping_id}

put(mapping_id)[source]¶

Create a mapping.

PUT /OS-FEDERATION/mappings/{mapping_id}

class keystone.api.os_federation.OSFederationAPI(blueprint_url_prefix='', api_url_prefix='', default_mediatype='application/json', decorators=None, errors=None)[source]¶

Bases: APIBase

resource_mapping = [resource_map(resource=<class 'keystone.api.os_federation.SAML2MetadataResource'>, url='/saml2/metadata', alternate_urls=None, kwargs={}, json_home_data=json_home_data(rel='https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/metadata', status='stable', path_vars={})), resource_map(resource=<class 'keystone.api.os_federation.OSFederationAuthResource'>, url='/identity_providers/<string:idp_id>/protocols/<string:protocol_id>/auth', alternate_urls=None, kwargs={}, json_home_data=json_home_data(rel='https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/identity_provider_protocol_auth', status='stable', path_vars={'idp_id': 'https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/param/idp_id', 'protocol_id': 'https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/param/protocol_id'}))]¶

resources = []¶

class keystone.api.os_federation.OSFederationAuthResource[source]¶

Bases: Resource

get(idp_id, protocol_id)[source]¶

Authenticate from dedicated uri endpoint.

GET/HEAD /OS-FEDERATION/identity_providers/

{idp_id}/protocols/{protocol_id}/auth

methods: t.ClassVar[t.Optional[t.Collection[str]]] = {'GET', 'POST'}¶

The methods this view is registered for. Uses the same default (["GET", "HEAD", "OPTIONS"]) as route and add_url_rule by default.

post(idp_id, protocol_id)[source]¶

Authenticate from dedicated uri endpoint.

POST /OS-FEDERATION/identity_providers/

{idp_id}/protocols/{protocol_id}/auth

class keystone.api.os_federation.OSFederationIdentityProvidersAPI(blueprint_url_prefix='', api_url_prefix='', default_mediatype='application/json', decorators=None, errors=None)[source]¶

Bases: APIBase

resource_mapping = []¶

resources = [<class 'keystone.api.os_federation.IdentityProvidersResource'>]¶

class keystone.api.os_federation.OSFederationIdentityProvidersProtocolsAPI(blueprint_url_prefix='', api_url_prefix='', default_mediatype='application/json', decorators=None, errors=None)[source]¶

Bases: APIBase

resource_mapping = [resource_map(resource=<class 'keystone.api.os_federation.IDPProtocolsCRUDResource'>, url='/OS-FEDERATION/identity_providers/<string:idp_id>/protocols/<string:protocol_id>', alternate_urls=None, kwargs={}, json_home_data=json_home_data(rel='https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/identity_provider_protocol', status='stable', path_vars={'idp_id': 'https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/param/idp_id', 'protocol_id': 'https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/param/protocol_id'})), resource_map(resource=<class 'keystone.api.os_federation.IDPProtocolsListResource'>, url='/OS-FEDERATION/identity_providers/<string:idp_id>/protocols', alternate_urls=None, kwargs={}, json_home_data=json_home_data(rel='https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/identity_provider_protocols', status='stable', path_vars={'idp_id': 'https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/param/idp_id'}))]¶

resources = []¶

class keystone.api.os_federation.OSFederationMappingsAPI(blueprint_url_prefix='', api_url_prefix='', default_mediatype='application/json', decorators=None, errors=None)[source]¶

Bases: APIBase

resource_mapping = []¶

resources = [<class 'keystone.api.os_federation.MappingResource'>]¶

class keystone.api.os_federation.OSFederationServiceProvidersAPI(blueprint_url_prefix='', api_url_prefix='', default_mediatype='application/json', decorators=None, errors=None)[source]¶

Bases: APIBase

resource_mapping = []¶

resources = [<class 'keystone.api.os_federation.ServiceProvidersResource'>]¶

class keystone.api.os_federation.SAML2MetadataResource[source]¶

Bases: Resource

get()[source]¶

Get SAML2 metadata.

GET/HEAD /OS-FEDERATION/saml2/metadata

methods: t.ClassVar[t.Optional[t.Collection[str]]] = {'GET'}¶

The methods this view is registered for. Uses the same default (["GET", "HEAD", "OPTIONS"]) as route and add_url_rule by default.

class keystone.api.os_federation.ServiceProvidersResource[source]¶

Bases: _ResourceBase

api_prefix = '/OS-FEDERATION'¶

collection_key = 'service_providers'¶

delete(sp_id)[source]¶

Delete a service provider.

DELETE /OS-FEDERATION/service_providers/{sp_id}

get(sp_id=None)[source]¶

member_key = 'service_provider'¶

methods: t.ClassVar[t.Optional[t.Collection[str]]] = {'DELETE', 'GET', 'PATCH', 'PUT'}¶

The methods this view is registered for. Uses the same default (["GET", "HEAD", "OPTIONS"]) as route and add_url_rule by default.

patch(sp_id)[source]¶

Update a service provider.

PATCH /OS-FEDERATION/service_providers/{sp_id}

put(sp_id)[source]¶

Create a service provider.

PUT /OS-FEDERATION/service_providers/{sp_id}