openbankproject_client.api_management module

API Management endpoints for the OpenBankProject API Client.

class openbankproject_client.api_management.ApiManagementEndpoints(client)[source]

Bases: object

API Management-related API endpoints.

__init__(client)[source]

Initialize the endpoint group.

Parameters:

client – OpenBankProjectClient instance

create_bank_level_endpoint_tag(bank_id: str, data: Dict) → Dict[source]

Create a bank level endpoint tag.

Parameters:

  • bank_id – Bank identifier

  • data – Endpoint tag data

Returns:

Dict containing created endpoint tag information

create_system_level_endpoint_tag(data: Dict) → Dict[source]

Create a system level endpoint tag.

Parameters:

data – Endpoint tag data

Returns:

Dict containing created endpoint tag information

delete_bank_level_endpoint_tag(bank_id: str, tag_id: str) → Dict[source]

Delete a bank level endpoint tag.

Parameters:

  • bank_id – Bank identifier

  • tag_id – Tag identifier

Returns:

Dict containing deletion status

delete_system_level_endpoint_tag(tag_id: str) → Dict[source]

Delete a system level endpoint tag.

Parameters:

tag_id – Tag identifier

Returns:

Dict containing deletion status

get_api_configuration() → Dict[source]

Get API configuration.

Returns:

Dict containing API configuration information

get_api_info() → Dict[source]

Get API info (root).

Returns:

Dict containing API information

get_api_tags() → Dict[source]

Get API tags.

Returns:

Dict containing API tag information

get_adapter_info_for_bank(bank_id: str) → Dict[source]

Get adapter info for a bank.

Parameters:

bank_id – Bank identifier

Returns:

Dict containing adapter information for the bank

get_bank_level_endpoint_tags(bank_id: str) → Dict[source]

Get bank level endpoint tags.

Parameters:

bank_id – Bank identifier

Returns:

Dict containing bank level endpoint tag information

get_connector_status() → Dict[source]

Get connector status (Loopback).

Returns:

Dict containing connector status information

get_json_web_key() → Dict[source]

Get JSON Web Key (JWK).

Returns:

Dict containing JWK information

get_json_web_key_uris() → Dict[source]

Get JSON Web Key (JWK) URIs.

Returns:

Dict containing JWK URI information

get_mapper_database_info() → Dict[source]

Get mapper database info.

Returns:

Dict containing mapper database information

get_rate_limiting_info() → Dict[source]

Get rate limiting info.

Returns:

Dict containing rate limiting information

get_suggested_session_timeout() → Dict[source]

Get suggested session timeout.

Returns:

Dict containing suggested session timeout information

get_system_level_endpoint_tags() → Dict[source]

Get system level endpoint tags.

Returns:

Dict containing system level endpoint tag information

get_call_context() → Dict[source]

Get the call context of a current call.

Returns:

Dict containing call context information

update_bank_level_endpoint_tag(bank_id: str, tag_id: str, data: Dict) → Dict[source]

Update a bank level endpoint tag.

Parameters:

  • bank_id – Bank identifier

  • tag_id – Tag identifier

  • data – Updated endpoint tag data

Returns:

Dict containing updated endpoint tag information

update_system_level_endpoint_tag(tag_id: str, data: Dict) → Dict[source]

Update a system level endpoint tag.

Parameters:

  • tag_id – Tag identifier

  • data – Updated endpoint tag data

Returns:

Dict containing updated endpoint tag information

verify_request_and_sign_response(data: Dict) → Dict[source]

Verify request and sign response of a current call.

Parameters:

data – Verification data

Returns:

Dict containing verification and signature information