aries_cloudagent.messaging.credential_definitions package

Submodules

aries_cloudagent.messaging.credential_definitions.routes module

Credential definition admin routes.

class aries_cloudagent.messaging.credential_definitions.routes.CreateCredDefTxnForEndorserOptionSchema(*args, **kwargs)

Bases: aries_cloudagent.messaging.models.openapi.OpenAPISchema

Class for user to input whether to create a transaction for endorser or not.

create_transaction_for_endorser

Used by autodoc_mock_imports.

class aries_cloudagent.messaging.credential_definitions.routes.CredDefConnIdMatchInfoSchema(*args, **kwargs)

Bases: aries_cloudagent.messaging.models.openapi.OpenAPISchema

Path parameters and validators for request taking connection id.

conn_id

Used by autodoc_mock_imports.

class aries_cloudagent.messaging.credential_definitions.routes.CredDefIdMatchInfoSchema(*args, **kwargs)

Bases: aries_cloudagent.messaging.models.openapi.OpenAPISchema

Path parameters and validators for request taking cred def id.

cred_def_id

Used by autodoc_mock_imports.

class aries_cloudagent.messaging.credential_definitions.routes.CredentialDefinitionGetResultSchema(*args, **kwargs)

Bases: aries_cloudagent.messaging.models.openapi.OpenAPISchema

Result schema for schema get request.

credential_definition

Used by autodoc_mock_imports.

class aries_cloudagent.messaging.credential_definitions.routes.CredentialDefinitionSendRequestSchema(*args, **kwargs)

Bases: aries_cloudagent.messaging.models.openapi.OpenAPISchema

Request schema for schema send request.

revocation_registry_size

Used by autodoc_mock_imports.

schema_id

Used by autodoc_mock_imports.

support_revocation

Used by autodoc_mock_imports.

tag

Used by autodoc_mock_imports.

class aries_cloudagent.messaging.credential_definitions.routes.CredentialDefinitionSendResultSchema(*args, **kwargs)

Bases: aries_cloudagent.messaging.models.openapi.OpenAPISchema

Result schema content for schema send request with auto-endorse.

credential_definition_id

Used by autodoc_mock_imports.

class aries_cloudagent.messaging.credential_definitions.routes.CredentialDefinitionsCreatedResultSchema(*args, **kwargs)

Bases: aries_cloudagent.messaging.models.openapi.OpenAPISchema

Result schema for cred-defs-created request.

credential_definition_ids

Used by autodoc_mock_imports.

class aries_cloudagent.messaging.credential_definitions.routes.TxnOrCredentialDefinitionSendResultSchema(*args, **kwargs)

Bases: aries_cloudagent.messaging.models.openapi.OpenAPISchema

Result schema for credential definition send request.

sent

Used by autodoc_mock_imports.

txn

Used by autodoc_mock_imports.

aries_cloudagent.messaging.credential_definitions.routes.add_cred_def_non_secrets_record(profile: aries_cloudagent.core.profile.Profile, schema_id: str, issuer_did: str, credential_definition_id: str)

Write the wallet non-secrets record for cred def (already written to the ledger).

Note that the cred def private key signing informtion must already exist in the wallet.

Parameters:

• schema_id – The schema id (or stringified sequence number)
• issuer_did – The DID of the issuer
• credential_definition_id – The credential definition id

aries_cloudagent.messaging.credential_definitions.routes.credential_definitions_created(request: <sphinx.ext.autodoc.importer._MockObject object at 0x7fc044940310>)

Request handler for retrieving credential definitions that current agent created.

Parameters:request – aiohttp request object Returns:The identifiers of matching credential definitions.

aries_cloudagent.messaging.credential_definitions.routes.credential_definitions_fix_cred_def_wallet_record(request: <sphinx.ext.autodoc.importer._MockObject object at 0x7fc044940310>)

Request handler for fixing a credential definition wallet non-secret record.

Parameters:request – aiohttp request object Returns:The credential definition details.

aries_cloudagent.messaging.credential_definitions.routes.credential_definitions_get_credential_definition(request: <sphinx.ext.autodoc.importer._MockObject object at 0x7fc044940310>)

Request handler for getting a credential definition from the ledger.

Parameters:request – aiohttp request object Returns:The credential definition details.

aries_cloudagent.messaging.credential_definitions.routes.credential_definitions_send_credential_definition(request: <sphinx.ext.autodoc.importer._MockObject object at 0x7fc044940310>)

Request handler for sending a credential definition to the ledger.

Parameters:request – aiohttp request object Returns:The credential definition identifier

aries_cloudagent.messaging.credential_definitions.routes.on_cred_def_event(profile: aries_cloudagent.core.profile.Profile, event: aries_cloudagent.core.event_bus.Event)

Handle any events we need to support.

aries_cloudagent.messaging.credential_definitions.routes.post_process_routes(app: <sphinx.ext.autodoc.importer._MockObject object at 0x7fc044940310>)

Amend swagger API.

aries_cloudagent.messaging.credential_definitions.routes.register(app: <sphinx.ext.autodoc.importer._MockObject object at 0x7fc044940310>)

Register routes.

aries_cloudagent.messaging.credential_definitions.routes.register_events(event_bus: aries_cloudagent.core.event_bus.EventBus)

Subscribe to any events we need to support.

aries_cloudagent.messaging.credential_definitions.util module

Credential definition utilities.

class aries_cloudagent.messaging.credential_definitions.util.CredDefQueryStringSchema(*args, **kwargs)

Bases: aries_cloudagent.messaging.models.openapi.OpenAPISchema

Query string parameters for credential definition searches.

cred_def_id

Used by autodoc_mock_imports.

issuer_did

Used by autodoc_mock_imports.

schema_id

Used by autodoc_mock_imports.

schema_issuer_did

Used by autodoc_mock_imports.

schema_name

Used by autodoc_mock_imports.

schema_version

Used by autodoc_mock_imports.

aries_cloudagent.messaging.credential_definitions.util.notify_cred_def_event(profile: aries_cloudagent.core.profile.Profile, cred_def_id: str, meta_data: dict)

Send notification for a cred def post-process event.