aries_cloudagent.protocols.issue_credential.v2_0 package¶

Subpackages¶

Submodules¶

aries_cloudagent.protocols.issue_credential.v2_0.manager module¶

V2.0 issue-credential protocol manager.

class aries_cloudagent.protocols.issue_credential.v2_0.manager.V20CredManager(profile: aries_cloudagent.core.profile.Profile)[source]¶

Bases: object

Class for managing credentials.

create_offer(cred_ex_record: aries_cloudagent.protocols.issue_credential.v2_0.models.cred_ex_record.V20CredExRecord, replacement_id: str = None, comment: str = None) → Tuple[aries_cloudagent.protocols.issue_credential.v2_0.models.cred_ex_record.V20CredExRecord, aries_cloudagent.protocols.issue_credential.v2_0.messages.cred_offer.V20CredOffer][source]¶

Create credential offer, update credential exchange record.

Parameters:	cred_ex_record – credential exchange record for which to create offer replacement_id – identifier to help coordinate credential replacement comment – optional human-readable comment to set in offer message
Returns:	A tuple (credential exchange record, credential offer message)

create_proposal(conn_id: str, *, auto_remove: bool = None, comment: str = None, cred_preview: aries_cloudagent.protocols.issue_credential.v2_0.messages.inner.cred_preview.V20CredPreview, fmt2filter: Mapping[aries_cloudagent.protocols.issue_credential.v2_0.messages.cred_format.V20CredFormat.Format, Mapping[str, str]], trace: bool = False) → aries_cloudagent.protocols.issue_credential.v2_0.models.cred_ex_record.V20CredExRecord[source]¶

Create a credential proposal.

Parameters:	conn_id – connection for which to create proposal auto_remove – whether to remove record automatically on completion comment – optional human-readable comment to include in proposal cred_preview – credential preview to use to create credential proposal fmt2filter – mapping between format and filter trace – whether to trace the operation
Returns:	Resulting credential exchange record including credential proposal

create_request(cred_ex_record: aries_cloudagent.protocols.issue_credential.v2_0.models.cred_ex_record.V20CredExRecord, holder_did: str, comment: str = None) → Tuple[aries_cloudagent.protocols.issue_credential.v2_0.models.cred_ex_record.V20CredExRecord, aries_cloudagent.protocols.issue_credential.v2_0.messages.cred_request.V20CredRequest][source]¶

Create a credential request.

Parameters:	cred_ex_record – credential exchange record for which to create request holder_did – holder DID comment – optional human-readable comment to set in request message
Returns:	A tuple (credential exchange record, credential request message)

delete_cred_ex_record(cred_ex_id: str) → None[source]¶: Delete credential exchange record and associated detail records.

get_detail_record(cred_ex_id: str, fmt: aries_cloudagent.protocols.issue_credential.v2_0.messages.cred_format.V20CredFormat.Format) → Union[aries_cloudagent.protocols.issue_credential.v2_0.models.detail.indy.V20CredExRecordIndy, aries_cloudagent.protocols.issue_credential.v2_0.models.detail.dif.V20CredExRecordDIF][source]¶: Retrieve credential exchange detail record by format.

issue_credential(cred_ex_record: aries_cloudagent.protocols.issue_credential.v2_0.models.cred_ex_record.V20CredExRecord, *, comment: str = None, retries: int = 5) → Tuple[aries_cloudagent.protocols.issue_credential.v2_0.models.cred_ex_record.V20CredExRecord, aries_cloudagent.protocols.issue_credential.v2_0.messages.cred_issue.V20CredIssue][source]¶

Issue a credential.

Parameters:	cred_ex_record – credential exchange record for which to issue credential comment – optional human-readable comment pertaining to credential issue retries – maximum number of retries on failure
Returns:	(Updated credential exchange record, credential issue message)
Return type:	Tuple

prepare_send(conn_id: str, cred_proposal: aries_cloudagent.protocols.issue_credential.v2_0.messages.cred_proposal.V20CredProposal, auto_remove: bool = None) → Tuple[aries_cloudagent.protocols.issue_credential.v2_0.models.cred_ex_record.V20CredExRecord, aries_cloudagent.protocols.issue_credential.v2_0.messages.cred_offer.V20CredOffer][source]¶

Set up a new credential exchange record for an automated send.

Parameters:	conn_id – connection for which to create offer cred_proposal – credential proposal with preview auto_remove – flag to remove the record automatically on completion
Returns:	A tuple of the new credential exchange record and credential offer message

profile¶

Accessor for the current profile instance.

Returns:	The profile instance for this credential manager

receive_credential(cred_issue_message: aries_cloudagent.protocols.issue_credential.v2_0.messages.cred_issue.V20CredIssue, conn_id: str) → aries_cloudagent.protocols.issue_credential.v2_0.models.cred_ex_record.V20CredExRecord[source]¶

Receive a credential issue message from an issuer.

Hold cred in storage potentially to be processed by controller before storing.

Returns:	Credential exchange record, retrieved and updated

receive_credential_ack(cred_ack_message: aries_cloudagent.protocols.issue_credential.v2_0.messages.cred_ack.V20CredAck, conn_id: str) → aries_cloudagent.protocols.issue_credential.v2_0.models.cred_ex_record.V20CredExRecord[source]¶

Receive credential ack from holder.

Parameters:	cred_ack_message – credential ack message to receive conn_id – connection identifier
Returns:	credential exchange record, retrieved and updated

receive_offer(cred_offer_message: aries_cloudagent.protocols.issue_credential.v2_0.messages.cred_offer.V20CredOffer, conn_id: str) → aries_cloudagent.protocols.issue_credential.v2_0.models.cred_ex_record.V20CredExRecord[source]¶

Receive a credential offer.

Parameters:	cred_offer_message – credential offer message conn_id – connection identifier
Returns:	The credential exchange record, updated

receive_proposal(cred_proposal_message: aries_cloudagent.protocols.issue_credential.v2_0.messages.cred_proposal.V20CredProposal, conn_id: str) → aries_cloudagent.protocols.issue_credential.v2_0.models.cred_ex_record.V20CredExRecord[source]¶

Receive a credential proposal.

Returns:	The resulting credential exchange record, created

receive_request(cred_request_message: aries_cloudagent.protocols.issue_credential.v2_0.messages.cred_request.V20CredRequest, conn_id: str) → aries_cloudagent.protocols.issue_credential.v2_0.models.cred_ex_record.V20CredExRecord[source]¶

Receive a credential request.

Parameters:	cred_request_message – credential request to receive conn_id – connection identifier
Returns:	credential exchange record, retrieved and updated

store_credential(cred_ex_record: aries_cloudagent.protocols.issue_credential.v2_0.models.cred_ex_record.V20CredExRecord, cred_id: str = None) → Tuple[aries_cloudagent.protocols.issue_credential.v2_0.models.cred_ex_record.V20CredExRecord, aries_cloudagent.protocols.issue_credential.v2_0.messages.cred_ack.V20CredAck][source]¶

Store a credential in holder wallet; send ack to issuer.

Parameters:	cred_ex_record – credential exchange record with credential to store and ack cred_id – optional credential identifier to override default on storage
Returns:	(Updated credential exchange record, credential ack message)
Return type:	Tuple

exception aries_cloudagent.protocols.issue_credential.v2_0.manager.V20CredManagerError(*args, error_code: str = None, **kwargs)[source]¶

Bases: aries_cloudagent.core.error.BaseError

Credential manager error under issue-credential protocol v2.0.

aries_cloudagent.protocols.issue_credential.v2_0.message_types module¶

Message and inner object type identifiers for Connections.

aries_cloudagent.protocols.issue_credential.v2_0.routes module¶

Credential exchange admin routes.

class aries_cloudagent.protocols.issue_credential.v2_0.routes.V20CredCreateSchema(*args, **kwargs)[source]¶

Bases: aries_cloudagent.protocols.issue_credential.v2_0.routes.V20IssueCredSchemaCore

Request schema for creating a credential from attr values.

credential_preview = <fields.Nested(default=<marshmallow.missing>, attribute=None, validate=None, required=True, load_only=False, dump_only=False, missing=<marshmallow.missing>, allow_none=False, error_messages={'required': 'Missing data for required field.', 'null': 'Field may not be null.', 'validator_failed': 'Invalid value.', 'type': 'Invalid type.'})>¶

class aries_cloudagent.protocols.issue_credential.v2_0.routes.V20CredExIdMatchInfoSchema(*args, **kwargs)[source]¶

Bases: aries_cloudagent.messaging.models.base.OpenAPISchema

Path parameters and validators for request taking credential exchange id.

cred_ex_id = <fields.String(default=<marshmallow.missing>, attribute=None, validate=<aries_cloudagent.messaging.valid.UUIDFour object>, required=True, load_only=False, dump_only=False, missing=<marshmallow.missing>, allow_none=False, error_messages={'required': 'Missing data for required field.', 'null': 'Field may not be null.', 'validator_failed': 'Invalid value.', 'invalid': 'Not a valid string.', 'invalid_utf8': 'Not a valid utf-8 string.'})>¶

class aries_cloudagent.protocols.issue_credential.v2_0.routes.V20CredExRecordDetailSchema(*args, **kwargs)[source]¶

Bases: aries_cloudagent.messaging.models.base.OpenAPISchema

Credential exchange record and any per-format details.

cred_ex_record = <fields.Nested(default=<marshmallow.missing>, attribute=None, validate=None, required=False, load_only=False, dump_only=False, missing=<marshmallow.missing>, allow_none=False, error_messages={'required': 'Missing data for required field.', 'null': 'Field may not be null.', 'validator_failed': 'Invalid value.', 'type': 'Invalid type.'})>¶

dif = <fields.Nested(default=<marshmallow.missing>, attribute=None, validate=None, required=False, load_only=False, dump_only=False, missing=<marshmallow.missing>, allow_none=False, error_messages={'required': 'Missing data for required field.', 'null': 'Field may not be null.', 'validator_failed': 'Invalid value.', 'type': 'Invalid type.'})>¶

indy = <fields.Nested(default=<marshmallow.missing>, attribute=None, validate=None, required=False, load_only=False, dump_only=False, missing=<marshmallow.missing>, allow_none=False, error_messages={'required': 'Missing data for required field.', 'null': 'Field may not be null.', 'validator_failed': 'Invalid value.', 'type': 'Invalid type.'})>¶

class aries_cloudagent.protocols.issue_credential.v2_0.routes.V20CredExRecordListQueryStringSchema(*args, **kwargs)[source]¶

Bases: aries_cloudagent.messaging.models.base.OpenAPISchema

Parameters and validators for credential exchange record list query.

connection_id = <fields.UUID(default=<marshmallow.missing>, attribute=None, validate=None, required=False, load_only=False, dump_only=False, missing=<marshmallow.missing>, allow_none=False, error_messages={'required': 'Missing data for required field.', 'null': 'Field may not be null.', 'validator_failed': 'Invalid value.', 'invalid': 'Not a valid string.', 'invalid_utf8': 'Not a valid utf-8 string.', 'invalid_uuid': 'Not a valid UUID.'})>¶

role = <fields.String(default=<marshmallow.missing>, attribute=None, validate=<OneOf(choices=['issuer', 'holder'], labels=[], error='Must be one of: {choices}.')>, required=False, load_only=False, dump_only=False, missing=<marshmallow.missing>, allow_none=False, error_messages={'required': 'Missing data for required field.', 'null': 'Field may not be null.', 'validator_failed': 'Invalid value.', 'invalid': 'Not a valid string.', 'invalid_utf8': 'Not a valid utf-8 string.'})>¶

state = <fields.String(default=<marshmallow.missing>, attribute=None, validate=<OneOf(choices=['proposal-sent', 'proposal-received', 'offer-sent', 'offer-received', 'request-sent', 'request-received', 'credential-issued', 'credential-received', 'done'], labels=[], error='Must be one of: {choices}.')>, required=False, load_only=False, dump_only=False, missing=<marshmallow.missing>, allow_none=False, error_messages={'required': 'Missing data for required field.', 'null': 'Field may not be null.', 'validator_failed': 'Invalid value.', 'invalid': 'Not a valid string.', 'invalid_utf8': 'Not a valid utf-8 string.'})>¶

thread_id = <fields.UUID(default=<marshmallow.missing>, attribute=None, validate=None, required=False, load_only=False, dump_only=False, missing=<marshmallow.missing>, allow_none=False, error_messages={'required': 'Missing data for required field.', 'null': 'Field may not be null.', 'validator_failed': 'Invalid value.', 'invalid': 'Not a valid string.', 'invalid_utf8': 'Not a valid utf-8 string.', 'invalid_uuid': 'Not a valid UUID.'})>¶

class aries_cloudagent.protocols.issue_credential.v2_0.routes.V20CredExRecordListResultSchema(*args, **kwargs)[source]¶

Bases: aries_cloudagent.messaging.models.base.OpenAPISchema

Result schema for credential exchange record list query.

results = <fields.List(default=<marshmallow.missing>, attribute=None, validate=None, required=False, load_only=False, dump_only=False, missing=<marshmallow.missing>, allow_none=False, error_messages={'required': 'Missing data for required field.', 'null': 'Field may not be null.', 'validator_failed': 'Invalid value.', 'invalid': 'Not a valid list.'})>¶

class aries_cloudagent.protocols.issue_credential.v2_0.routes.V20CredFilter(*args, **kwargs)[source]¶

Bases: aries_cloudagent.messaging.models.base.OpenAPISchema

Credential filtration criteria.

dif = <fields.Nested(default=<marshmallow.missing>, attribute=None, validate=None, required=False, load_only=False, dump_only=False, missing=<marshmallow.missing>, allow_none=False, error_messages={'required': 'Missing data for required field.', 'null': 'Field may not be null.', 'validator_failed': 'Invalid value.', 'type': 'Invalid type.'})>¶

indy = <fields.Nested(default=<marshmallow.missing>, attribute=None, validate=None, required=False, load_only=False, dump_only=False, missing=<marshmallow.missing>, allow_none=False, error_messages={'required': 'Missing data for required field.', 'null': 'Field may not be null.', 'validator_failed': 'Invalid value.', 'type': 'Invalid type.'})>¶

validate_fields(data, **kwargs)[source]¶

Validate schema fields.

Data must have indy, dif, or both.

Parameters:	data – The data to validate
Raises:	`ValidationError` – if data has neither indy nor dif

class aries_cloudagent.protocols.issue_credential.v2_0.routes.V20CredFilterDIF(*args, **kwargs)[source]¶

Bases: aries_cloudagent.messaging.models.base.OpenAPISchema

DIF credential filtration criteria.

some_dif_criterion = <fields.String(default=<marshmallow.missing>, attribute=None, validate=None, required=False, load_only=False, dump_only=False, missing=<marshmallow.missing>, allow_none=False, error_messages={'required': 'Missing data for required field.', 'null': 'Field may not be null.', 'validator_failed': 'Invalid value.', 'invalid': 'Not a valid string.', 'invalid_utf8': 'Not a valid utf-8 string.'})>¶

class aries_cloudagent.protocols.issue_credential.v2_0.routes.V20CredFilterIndy(*args, **kwargs)[source]¶

Bases: aries_cloudagent.messaging.models.base.OpenAPISchema

Indy credential filtration criteria.

cred_def_id = <fields.String(default=<marshmallow.missing>, attribute=None, validate=<aries_cloudagent.messaging.valid.IndyCredDefId object>, required=False, load_only=False, dump_only=False, missing=<marshmallow.missing>, allow_none=False, error_messages={'required': 'Missing data for required field.', 'null': 'Field may not be null.', 'validator_failed': 'Invalid value.', 'invalid': 'Not a valid string.', 'invalid_utf8': 'Not a valid utf-8 string.'})>¶

issuer_did = <fields.String(default=<marshmallow.missing>, attribute=None, validate=<aries_cloudagent.messaging.valid.IndyDID object>, required=False, load_only=False, dump_only=False, missing=<marshmallow.missing>, allow_none=False, error_messages={'required': 'Missing data for required field.', 'null': 'Field may not be null.', 'validator_failed': 'Invalid value.', 'invalid': 'Not a valid string.', 'invalid_utf8': 'Not a valid utf-8 string.'})>¶

schema_id = <fields.String(default=<marshmallow.missing>, attribute=None, validate=<aries_cloudagent.messaging.valid.IndySchemaId object>, required=False, load_only=False, dump_only=False, missing=<marshmallow.missing>, allow_none=False, error_messages={'required': 'Missing data for required field.', 'null': 'Field may not be null.', 'validator_failed': 'Invalid value.', 'invalid': 'Not a valid string.', 'invalid_utf8': 'Not a valid utf-8 string.'})>¶

schema_issuer_did = <fields.String(default=<marshmallow.missing>, attribute=None, validate=<aries_cloudagent.messaging.valid.IndyDID object>, required=False, load_only=False, dump_only=False, missing=<marshmallow.missing>, allow_none=False, error_messages={'required': 'Missing data for required field.', 'null': 'Field may not be null.', 'validator_failed': 'Invalid value.', 'invalid': 'Not a valid string.', 'invalid_utf8': 'Not a valid utf-8 string.'})>¶

schema_name = <fields.String(default=<marshmallow.missing>, attribute=None, validate=None, required=False, load_only=False, dump_only=False, missing=<marshmallow.missing>, allow_none=False, error_messages={'required': 'Missing data for required field.', 'null': 'Field may not be null.', 'validator_failed': 'Invalid value.', 'invalid': 'Not a valid string.', 'invalid_utf8': 'Not a valid utf-8 string.'})>¶

schema_version = <fields.String(default=<marshmallow.missing>, attribute=None, validate=<aries_cloudagent.messaging.valid.IndyVersion object>, required=False, load_only=False, dump_only=False, missing=<marshmallow.missing>, allow_none=False, error_messages={'required': 'Missing data for required field.', 'null': 'Field may not be null.', 'validator_failed': 'Invalid value.', 'invalid': 'Not a valid string.', 'invalid_utf8': 'Not a valid utf-8 string.'})>¶

class aries_cloudagent.protocols.issue_credential.v2_0.routes.V20CredIdMatchInfoSchema(*args, **kwargs)[source]¶

Bases: aries_cloudagent.messaging.models.base.OpenAPISchema

Path parameters and validators for request taking credential id.

credential_id = <fields.String(default=<marshmallow.missing>, attribute=None, validate=None, required=True, load_only=False, dump_only=False, missing=<marshmallow.missing>, allow_none=False, error_messages={'required': 'Missing data for required field.', 'null': 'Field may not be null.', 'validator_failed': 'Invalid value.', 'invalid': 'Not a valid string.', 'invalid_utf8': 'Not a valid utf-8 string.'})>¶

class aries_cloudagent.protocols.issue_credential.v2_0.routes.V20CredIssueProblemReportRequestSchema(*args, **kwargs)[source]¶

Bases: aries_cloudagent.messaging.models.base.OpenAPISchema

Request schema for sending problem report.

explain_ltxt = <fields.String(default=<marshmallow.missing>, attribute=None, validate=None, required=True, load_only=False, dump_only=False, missing=<marshmallow.missing>, allow_none=False, error_messages={'required': 'Missing data for required field.', 'null': 'Field may not be null.', 'validator_failed': 'Invalid value.', 'invalid': 'Not a valid string.', 'invalid_utf8': 'Not a valid utf-8 string.'})>¶

class aries_cloudagent.protocols.issue_credential.v2_0.routes.V20CredIssueRequestSchema(*args, **kwargs)[source]¶

Bases: aries_cloudagent.messaging.models.base.OpenAPISchema

Request schema for sending credential issue admin message.

comment = <fields.String(default=<marshmallow.missing>, attribute=None, validate=None, required=False, load_only=False, dump_only=False, missing=<marshmallow.missing>, allow_none=True, error_messages={'required': 'Missing data for required field.', 'null': 'Field may not be null.', 'validator_failed': 'Invalid value.', 'invalid': 'Not a valid string.', 'invalid_utf8': 'Not a valid utf-8 string.'})>¶

class aries_cloudagent.protocols.issue_credential.v2_0.routes.V20CredOfferRequestSchema(*args, **kwargs)[source]¶

Bases: aries_cloudagent.protocols.issue_credential.v2_0.routes.V20IssueCredSchemaCore

Request schema for sending credential offer admin message.

auto_issue = <fields.Boolean(default=<marshmallow.missing>, attribute=None, validate=None, required=False, load_only=False, dump_only=False, missing=<marshmallow.missing>, allow_none=False, error_messages={'required': 'Missing data for required field.', 'null': 'Field may not be null.', 'validator_failed': 'Invalid value.', 'invalid': 'Not a valid boolean.'})>¶

connection_id = <fields.UUID(default=<marshmallow.missing>, attribute=None, validate=None, required=True, load_only=False, dump_only=False, missing=<marshmallow.missing>, allow_none=False, error_messages={'required': 'Missing data for required field.', 'null': 'Field may not be null.', 'validator_failed': 'Invalid value.', 'invalid': 'Not a valid string.', 'invalid_utf8': 'Not a valid utf-8 string.', 'invalid_uuid': 'Not a valid UUID.'})>¶

credential_preview = <fields.Nested(default=<marshmallow.missing>, attribute=None, validate=None, required=True, load_only=False, dump_only=False, missing=<marshmallow.missing>, allow_none=False, error_messages={'required': 'Missing data for required field.', 'null': 'Field may not be null.', 'validator_failed': 'Invalid value.', 'type': 'Invalid type.'})>¶

class aries_cloudagent.protocols.issue_credential.v2_0.routes.V20CredProposalRequestPreviewMandSchema(*args, **kwargs)[source]¶

Bases: aries_cloudagent.protocols.issue_credential.v2_0.routes.V20CredProposalRequestSchemaBase

Request schema for sending credential proposal on mandatory proposal preview.

credential_preview = <fields.Nested(default=<marshmallow.missing>, attribute=None, validate=None, required=True, load_only=False, dump_only=False, missing=<marshmallow.missing>, allow_none=False, error_messages={'required': 'Missing data for required field.', 'null': 'Field may not be null.', 'validator_failed': 'Invalid value.', 'type': 'Invalid type.'})>¶

class aries_cloudagent.protocols.issue_credential.v2_0.routes.V20CredProposalRequestPreviewOptSchema(*args, **kwargs)[source]¶

Bases: aries_cloudagent.protocols.issue_credential.v2_0.routes.V20CredProposalRequestSchemaBase

Request schema for sending credential proposal on optional proposal preview.

credential_preview = <fields.Nested(default=<marshmallow.missing>, attribute=None, validate=None, required=False, load_only=False, dump_only=False, missing=<marshmallow.missing>, allow_none=False, error_messages={'required': 'Missing data for required field.', 'null': 'Field may not be null.', 'validator_failed': 'Invalid value.', 'type': 'Invalid type.'})>¶

class aries_cloudagent.protocols.issue_credential.v2_0.routes.V20CredProposalRequestSchemaBase(*args, **kwargs)[source]¶

Bases: aries_cloudagent.protocols.issue_credential.v2_0.routes.V20IssueCredSchemaCore

Base class for request schema for sending credential proposal admin message.

connection_id = <fields.UUID(default=<marshmallow.missing>, attribute=None, validate=None, required=True, load_only=False, dump_only=False, missing=<marshmallow.missing>, allow_none=False, error_messages={'required': 'Missing data for required field.', 'null': 'Field may not be null.', 'validator_failed': 'Invalid value.', 'invalid': 'Not a valid string.', 'invalid_utf8': 'Not a valid utf-8 string.', 'invalid_uuid': 'Not a valid UUID.'})>¶

class aries_cloudagent.protocols.issue_credential.v2_0.routes.V20CredStoreRequestSchema(*args, **kwargs)[source]¶

Bases: aries_cloudagent.messaging.models.base.OpenAPISchema

Request schema for sending a credential store admin message.

credential_id = <fields.String(default=<marshmallow.missing>, attribute=None, validate=None, required=False, load_only=False, dump_only=False, missing=<marshmallow.missing>, allow_none=False, error_messages={'required': 'Missing data for required field.', 'null': 'Field may not be null.', 'validator_failed': 'Invalid value.', 'invalid': 'Not a valid string.', 'invalid_utf8': 'Not a valid utf-8 string.'})>¶

class aries_cloudagent.protocols.issue_credential.v2_0.routes.V20IssueCredSchemaCore(*args, **kwargs)[source]¶

Bases: aries_cloudagent.utils.tracing.AdminAPIMessageTracingSchema

Filter, auto-remove, comment, trace.

auto_remove = <fields.Boolean(default=<marshmallow.missing>, attribute=None, validate=None, required=False, load_only=False, dump_only=False, missing=<marshmallow.missing>, allow_none=False, error_messages={'required': 'Missing data for required field.', 'null': 'Field may not be null.', 'validator_failed': 'Invalid value.', 'invalid': 'Not a valid boolean.'})>¶

comment = <fields.String(default=<marshmallow.missing>, attribute=None, validate=None, required=False, load_only=False, dump_only=False, missing=<marshmallow.missing>, allow_none=True, error_messages={'required': 'Missing data for required field.', 'null': 'Field may not be null.', 'validator_failed': 'Invalid value.', 'invalid': 'Not a valid string.', 'invalid_utf8': 'Not a valid utf-8 string.'})>¶

filter_ = <fields.Nested(default=<marshmallow.missing>, attribute=None, validate=None, required=True, load_only=False, dump_only=False, missing=<marshmallow.missing>, allow_none=False, error_messages={'required': 'Missing data for required field.', 'null': 'Field may not be null.', 'validator_failed': 'Invalid value.', 'type': 'Invalid type.'})>¶

trace = <fields.Boolean(default=<marshmallow.missing>, attribute=None, validate=None, required=False, load_only=False, dump_only=False, missing=<marshmallow.missing>, allow_none=False, error_messages={'required': 'Missing data for required field.', 'null': 'Field may not be null.', 'validator_failed': 'Invalid value.', 'invalid': 'Not a valid boolean.'})>¶

class aries_cloudagent.protocols.issue_credential.v2_0.routes.V20IssueCredentialModuleResponseSchema(*args, **kwargs)[source]¶

Bases: aries_cloudagent.messaging.models.base.OpenAPISchema

Response schema for v2.0 Issue Credential Module.

aries_cloudagent.protocols.issue_credential.v2_0.routes.credential_exchange_create(request: <sphinx.ext.autodoc.importer._MockObject object at 0x7f760dc51850>)[source]¶

Request handler for creating a credential from attr values.

The internal credential record will be created without the credential being sent to any connection. This can be used in conjunction with the oob protocols to bind messages to an out of band message.

Parameters:	request – aiohttp request object
Returns:	The credential exchange record

aries_cloudagent.protocols.issue_credential.v2_0.routes.credential_exchange_create_free_offer(request: <sphinx.ext.autodoc.importer._MockObject object at 0x7f760dc51850>)[source]¶

Request handler for creating free credential offer.

Unlike with send-offer, this credential exchange is not tied to a specific connection. It must be dispatched out-of-band by the controller.

Parameters:	request – aiohttp request object
Returns:	The credential exchange record

aries_cloudagent.protocols.issue_credential.v2_0.routes.credential_exchange_issue(request: <sphinx.ext.autodoc.importer._MockObject object at 0x7f760dc51850>)[source]¶

Request handler for sending credential.

Parameters:	request – aiohttp request object
Returns:	The credential exchange record

aries_cloudagent.protocols.issue_credential.v2_0.routes.credential_exchange_list(request: <sphinx.ext.autodoc.importer._MockObject object at 0x7f760dc51850>)[source]¶

Request handler for searching credential exchange records.

Parameters:	request – aiohttp request object
Returns:	The connection list response

aries_cloudagent.protocols.issue_credential.v2_0.routes.credential_exchange_problem_report(request: <sphinx.ext.autodoc.importer._MockObject object at 0x7f760dc51850>)[source]¶

Request handler for sending problem report.

Parameters:	request – aiohttp request object

aries_cloudagent.protocols.issue_credential.v2_0.routes.credential_exchange_remove(request: <sphinx.ext.autodoc.importer._MockObject object at 0x7f760dc51850>)[source]¶

Request handler for removing a credential exchange record.

Parameters:	request – aiohttp request object

aries_cloudagent.protocols.issue_credential.v2_0.routes.credential_exchange_retrieve(request: <sphinx.ext.autodoc.importer._MockObject object at 0x7f760dc51850>)[source]¶

Request handler for fetching single credential exchange record.

Parameters:	request – aiohttp request object
Returns:	The credential exchange record

aries_cloudagent.protocols.issue_credential.v2_0.routes.credential_exchange_send(request: <sphinx.ext.autodoc.importer._MockObject object at 0x7f760dc51850>)[source]¶

Request handler for sending credential from issuer to holder from attr values.

If both issuer and holder are configured for automatic responses, the operation ultimately results in credential issue; otherwise, the result waits on the first response not automated; the credential exchange record retains state regardless.

Parameters:	request – aiohttp request object
Returns:	The credential exchange record

aries_cloudagent.protocols.issue_credential.v2_0.routes.credential_exchange_send_bound_offer(request: <sphinx.ext.autodoc.importer._MockObject object at 0x7f760dc51850>)[source]¶

Request handler for sending bound credential offer.

A holder initiates this sequence with a credential proposal; this message responds with an offer bound to the proposal.

Parameters:	request – aiohttp request object
Returns:	The credential exchange record

aries_cloudagent.protocols.issue_credential.v2_0.routes.credential_exchange_send_free_offer(request: <sphinx.ext.autodoc.importer._MockObject object at 0x7f760dc51850>)[source]¶

Request handler for sending free credential offer.

An issuer initiates a such a credential offer, free from any holder-initiated corresponding credential proposal with preview.

Parameters:	request – aiohttp request object
Returns:	The credential exchange record

aries_cloudagent.protocols.issue_credential.v2_0.routes.credential_exchange_send_proposal(request: <sphinx.ext.autodoc.importer._MockObject object at 0x7f760dc51850>)[source]¶

Request handler for sending credential proposal.

Parameters:	request – aiohttp request object
Returns:	The credential exchange record

aries_cloudagent.protocols.issue_credential.v2_0.routes.credential_exchange_send_request(request: <sphinx.ext.autodoc.importer._MockObject object at 0x7f760dc51850>)[source]¶

Request handler for sending credential request.

Parameters:	request – aiohttp request object
Returns:	The credential exchange record

aries_cloudagent.protocols.issue_credential.v2_0.routes.credential_exchange_store(request: <sphinx.ext.autodoc.importer._MockObject object at 0x7f760dc51850>)[source]¶

Request handler for storing credential.

Parameters:	request – aiohttp request object
Returns:	The credential exchange record

aries_cloudagent.protocols.issue_credential.v2_0.routes.post_process_routes(app: <sphinx.ext.autodoc.importer._MockObject object at 0x7f760dc51850>)[source]¶: Amend swagger API.

aries_cloudagent.protocols.issue_credential.v2_0.routes.register(app: <sphinx.ext.autodoc.importer._MockObject object at 0x7f760dc51850>)[source]¶: Register routes.