aries_cloudagent.multitenant.admin package

Submodules

aries_cloudagent.multitenant.admin.routes module

Multitenant admin routes.

class aries_cloudagent.multitenant.admin.routes.CreateWalletRequestSchema(*args, **kwargs)[source]

Bases: aries_cloudagent.messaging.models.openapi.OpenAPISchema

Request schema for adding a new wallet which will be registered by the agent.

extra_settings

Used by autodoc_mock_imports.

image_url

Used by autodoc_mock_imports.

key_management_mode

Used by autodoc_mock_imports.

label

Used by autodoc_mock_imports.

validate_fields(data, **kwargs)[source]

Validate schema fields.

Parameters:data – The data to validate
Raises:ValidationError – If any of the fields do not validate
wallet_dispatch_type

Used by autodoc_mock_imports.

wallet_key

Used by autodoc_mock_imports.

wallet_key_derivation

Used by autodoc_mock_imports.

wallet_name

Used by autodoc_mock_imports.

wallet_type

Used by autodoc_mock_imports.

wallet_webhook_urls

Used by autodoc_mock_imports.

class aries_cloudagent.multitenant.admin.routes.CreateWalletResponseSchema(*args, **kwargs)[source]

Bases: aries_cloudagent.wallet.models.wallet_record.WalletRecordSchema

Response schema for creating a wallet.

token

Used by autodoc_mock_imports.

class aries_cloudagent.multitenant.admin.routes.CreateWalletTokenRequestSchema(*args, **kwargs)[source]

Bases: aries_cloudagent.messaging.models.openapi.OpenAPISchema

Request schema for creating a wallet token.

wallet_key

Used by autodoc_mock_imports.

class aries_cloudagent.multitenant.admin.routes.CreateWalletTokenResponseSchema(*args, **kwargs)[source]

Bases: aries_cloudagent.messaging.models.openapi.OpenAPISchema

Response schema for creating a wallet token.

token

Used by autodoc_mock_imports.

class aries_cloudagent.multitenant.admin.routes.MultitenantModuleResponseSchema(*args, **kwargs)[source]

Bases: aries_cloudagent.messaging.models.openapi.OpenAPISchema

Response schema for multitenant module.

class aries_cloudagent.multitenant.admin.routes.RemoveWalletRequestSchema(*args, **kwargs)[source]

Bases: aries_cloudagent.messaging.models.openapi.OpenAPISchema

Request schema for removing a wallet.

wallet_key

Used by autodoc_mock_imports.

class aries_cloudagent.multitenant.admin.routes.UpdateWalletRequestSchema(*args, **kwargs)[source]

Bases: aries_cloudagent.messaging.models.openapi.OpenAPISchema

Request schema for updating a existing wallet.

extra_settings

Used by autodoc_mock_imports.

image_url

Used by autodoc_mock_imports.

label

Used by autodoc_mock_imports.

wallet_dispatch_type

Used by autodoc_mock_imports.

wallet_webhook_urls

Used by autodoc_mock_imports.

class aries_cloudagent.multitenant.admin.routes.WalletIdMatchInfoSchema(*args, **kwargs)[source]

Bases: aries_cloudagent.messaging.models.openapi.OpenAPISchema

Path parameters and validators for request taking wallet id.

wallet_id

Used by autodoc_mock_imports.

class aries_cloudagent.multitenant.admin.routes.WalletListQueryStringSchema(*args, **kwargs)[source]

Bases: aries_cloudagent.messaging.models.openapi.OpenAPISchema

Parameters and validators for wallet list request query string.

wallet_name

Used by autodoc_mock_imports.

class aries_cloudagent.multitenant.admin.routes.WalletListSchema(*args, **kwargs)[source]

Bases: aries_cloudagent.messaging.models.openapi.OpenAPISchema

Result schema for wallet list.

results

Used by autodoc_mock_imports.

aries_cloudagent.multitenant.admin.routes.format_wallet_record(wallet_record: aries_cloudagent.wallet.models.wallet_record.WalletRecord)[source]

Serialize a WalletRecord object.

aries_cloudagent.multitenant.admin.routes.get_extra_settings_dict_per_tenant(tenant_settings: dict) → dict[source]

Get per tenant settings to be applied when creating wallet.

aries_cloudagent.multitenant.admin.routes.post_process_routes(app: <sphinx.ext.autodoc.importer._MockObject object at 0x7fc0441a9040>)[source]

Amend swagger API.

aries_cloudagent.multitenant.admin.routes.register(app: <sphinx.ext.autodoc.importer._MockObject object at 0x7fc0441a9040>)[source]

Register routes.

aries_cloudagent.multitenant.admin.routes.wallet_create(request: <sphinx.ext.autodoc.importer._MockObject object at 0x7fc0441a9040>)[source]

Request handler for adding a new subwallet for handling by the agent.

Parameters:request – aiohttp request object
aries_cloudagent.multitenant.admin.routes.wallet_create_token(request: <sphinx.ext.autodoc.importer._MockObject object at 0x7fc0441a9040>)[source]

Request handler for creating an authorization token for a specific subwallet.

Parameters:request – aiohttp request object
aries_cloudagent.multitenant.admin.routes.wallet_get(request: <sphinx.ext.autodoc.importer._MockObject object at 0x7fc0441a9040>)[source]

Request handler for getting a single subwallet.

Parameters:request – aiohttp request object
Raises:HTTPNotFound – if wallet_id does not match any known wallets
aries_cloudagent.multitenant.admin.routes.wallet_remove(request: <sphinx.ext.autodoc.importer._MockObject object at 0x7fc0441a9040>)[source]

Request handler to remove a subwallet from agent and storage.

Parameters:request – aiohttp request object.
aries_cloudagent.multitenant.admin.routes.wallet_update(request: <sphinx.ext.autodoc.importer._MockObject object at 0x7fc0441a9040>)[source]

Request handler for updating a existing subwallet for handling by the agent.

Parameters:request – aiohttp request object
aries_cloudagent.multitenant.admin.routes.wallets_list(request: <sphinx.ext.autodoc.importer._MockObject object at 0x7fc0441a9040>)[source]

Request handler for listing all internal subwallets.

Parameters:request – aiohttp request object