aries_cloudagent.vc.vc_ld.models package

Submodules

aries_cloudagent.vc.vc_ld.models.credential module

Verifiable Credential marshmallow schema classes.

class aries_cloudagent.vc.vc_ld.models.credential.CredentialSchema(*args: Any, **kwargs: Any)[source]

Bases: marshmallow.

Linked data credential schema.

Based on https://www.w3.org/TR/vc-data-model

class Meta[source]

Bases: object

Accept parameter overload.

model_class

alias of aries_cloudagent.vc.vc_ld.models.credential.VerifiableCredential

add_unknown_properties(data: dict, original, **kwargs)

Add back unknown properties before outputting.

context
credential_subject

Dict or Dict List field for Marshmallow.

expiration_date
id
issuance_date
issuer

URI or Dict field for Marshmallow.

proof
type
class aries_cloudagent.vc.vc_ld.models.credential.VerifiableCredential(context: Optional[List[Union[str, dict]]] = None, id: Optional[str] = None, type: Optional[List[str]] = None, issuer: Optional[Union[dict, str]] = None, issuance_date: Optional[str] = None, expiration_date: Optional[str] = None, credential_subject: Optional[Union[dict, List[dict]]] = None, proof: Optional[Union[dict, aries_cloudagent.vc.vc_ld.models.linked_data_proof.LDProof]] = None, **kwargs)[source]

Bases: aries_cloudagent.messaging.models.base.BaseModel

Verifiable Credential model.

class Meta[source]

Bases: object

VerifiableCredential metadata.

schema_class = 'CredentialSchema'
add_context(context: Union[str, dict])[source]

Add a context to this credential.

add_type(type: str)[source]

Add a type to this credential.

property context

Getter for context.

property context_urls: List[str]

Getter for context urls.

property credential_subject

Getter for credential subject.

property credential_subject_ids: List[str]

Getter for credential subject ids.

property expiration_date

Getter for expiration date.

property id

Getter for id.

property issuance_date

Getter for issuance date.

property issuer

Getter for issuer.

property issuer_id: Optional[str]

Getter for issuer id.

property proof

Getter for proof.

property type: List[str]

Getter for type.

class aries_cloudagent.vc.vc_ld.models.credential.VerifiableCredentialSchema(*args: Any, **kwargs: Any)[source]

Bases: marshmallow.

Linked data verifiable credential schema.

Based on https://www.w3.org/TR/vc-data-model

proof

aries_cloudagent.vc.vc_ld.models.linked_data_proof module

LinkedDataProof.

class aries_cloudagent.vc.vc_ld.models.linked_data_proof.LDProof(type: Optional[str] = None, proof_purpose: Optional[str] = None, verification_method: Optional[str] = None, created: Optional[str] = None, domain: Optional[str] = None, challenge: Optional[str] = None, jws: Optional[str] = None, proof_value: Optional[str] = None, nonce: Optional[str] = None, **kwargs)[source]

Bases: aries_cloudagent.messaging.models.base.BaseModel

Linked Data Proof model.

class Meta[source]

Bases: object

LinkedDataProof metadata.

schema_class = 'LinkedDataProofSchema'
class aries_cloudagent.vc.vc_ld.models.linked_data_proof.LinkedDataProofSchema(*args: Any, **kwargs: Any)[source]

Bases: marshmallow.

Linked data proof schema.

Based on https://w3c-ccg.github.io/ld-proofs

class Meta[source]

Bases: object

Accept parameter overload.

model_class

alias of aries_cloudagent.vc.vc_ld.models.linked_data_proof.LDProof

add_unknown_properties(data: dict, original, **kwargs)

Add back unknown properties before outputting.

challenge
created
domain
jws
nonce
proof_purpose
proof_value
type
verification_method