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.Collection[str] | None] = {'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.Collection[str] | None] = {'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.IdentityProviderResource[source]

Bases: _ResourceBase

api_prefix: str = '/OS-FEDERATION'
collection_key: str = 'identity_providers'
delete(idp_id)[source]
get(idp_id=None)[source]

Get an IDP resource.

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

member_key: str = 'identity_provider'
methods: t.ClassVar[t.Collection[str] | None] = {'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.IdentityProvidersResource[source]

Bases: _ResourceBase

api_prefix: str = '/OS-FEDERATION'
collection_key: str = 'identity_providers'
get()[source]

List all identity providers.

GET/HEAD /OS-FEDERATION/identity_providers

member_key: str = 'identity_provider'
methods: t.ClassVar[t.Collection[str] | None] = {'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.MappingResource[source]

Bases: _ResourceBase

api_prefix: str = '/OS-FEDERATION'
collection_key: str = 'mappings'
delete(mapping_id)[source]

Delete a mapping.

DELETE /OS-FEDERATION/mappings/{mapping_id}

get(mapping_id=None)[source]
member_key: str = 'mapping'
methods: t.ClassVar[t.Collection[str] | None] = {'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 an attribute mapping for identity federation.

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 = [(<class 'keystone.api.os_federation.SAML2MetadataResource'>, '/saml2/metadata', None, {}, ('https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/metadata', 'stable', {})), (<class 'keystone.api.os_federation.OSFederationAuthResource'>, '/identity_providers/<string:idp_id>/protocols/<string:protocol_id>/auth', None, {}, ('https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/identity_provider_protocol_auth', 'stable', {'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.Collection[str] | None] = {'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 = [(<class 'keystone.api.os_federation.IdentityProvidersResource'>, '/identity_providers', None, {}, ('https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/identity_providers', 'stable', {})), (<class 'keystone.api.os_federation.IdentityProviderResource'>, '/identity_providers/<string:idp_id>', None, {}, ('https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/identity_provider', 'stable', {'idp_id': 'https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/param/idp_id'}))]
resources = []
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 = [(<class 'keystone.api.os_federation.IDPProtocolsCRUDResource'>, '/OS-FEDERATION/identity_providers/<string:idp_id>/protocols/<string:protocol_id>', None, {}, ('https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/identity_provider_protocol', 'stable', {'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'})), (<class 'keystone.api.os_federation.IDPProtocolsListResource'>, '/OS-FEDERATION/identity_providers/<string:idp_id>/protocols', None, {}, ('https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/identity_provider_protocols', 'stable', {'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 = [(<class 'keystone.api.os_federation.ServiceProvidersResource'>, '/service_providers', None, {}, ('https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/service_providers', 'stable', {})), (<class 'keystone.api.os_federation.ServiceProviderResource'>, '/service_providers/<string:service_provider_id>', None, {}, ('https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/service_provider', 'stable', {'service_provider_id': 'https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/param/service_provider_id'}))]
class keystone.api.os_federation.SAML2MetadataResource[source]

Bases: Resource

get()[source]

Get SAML2 metadata.

GET/HEAD /OS-FEDERATION/saml2/metadata

methods: t.ClassVar[t.Collection[str] | None] = {'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.ServiceProviderResource[source]

Bases: _ResourceBase

api_prefix: str = '/OS-FEDERATION'
collection_key: str = 'service_providers'
delete(service_provider_id)[source]

Delete a service provider.

DELETE /OS-FEDERATION/service_providers/{service_provider_id}

get(service_provider_id)[source]

Get a service provider.

GET/HEAD /OS-FEDERATION/service_providers/{service_provider_id}

member_key: str = 'service_provider'
methods: t.ClassVar[t.Collection[str] | None] = {'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(service_provider_id)[source]

Update a service provider.

PATCH /OS-FEDERATION/service_providers/{service_provider_id}

put(service_provider_id)[source]

Create a service provider.

PUT /OS-FEDERATION/service_providers/{service_provider_id}

class keystone.api.os_federation.ServiceProvidersResource[source]

Bases: _ResourceBase

api_prefix: str = '/OS-FEDERATION'
collection_key: str = 'service_providers'
get()[source]

List service providers.

GET/HEAD /OS-FEDERATION/service_providers

member_key: str = 'service_provider'
methods: t.ClassVar[t.Collection[str] | None] = {'GET'}

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