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, **kwargs)[source]

Bases: aries_cloudagent.messaging.models.base.BaseModelSchema

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 VerifiableCredential

unknown

Used by autodoc_mock_imports.

add_unknown_properties(data: dict, original, **kwargs)[source]

Add back unknown properties before outputting.

context

Used by autodoc_mock_imports.

credential_subject

Dict or Dict List field for Marshmallow.

expiration_date

Used by autodoc_mock_imports.

id

Used by autodoc_mock_imports.

issuance_date

Used by autodoc_mock_imports.

issuer

URI or Dict field for Marshmallow.

proof

Used by autodoc_mock_imports.

type

Used by autodoc_mock_imports.

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: Union[dict, str, None] = None, issuance_date: Optional[str] = None, expiration_date: Optional[str] = None, credential_subject: Union[dict, List[dict], None] = None, proof: Union[dict, aries_cloudagent.vc.vc_ld.models.linked_data_proof.LDProof, None] = 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.

context

Getter for context.

context_urls

Getter for context urls.

credential_subject

Getter for credential subject.

credential_subject_ids

Getter for credential subject ids.

expiration_date

Getter for expiration date.

id

Getter for id.

issuance_date

Getter for issuance date.

issuer

Getter for issuer.

issuer_id

Getter for issuer id.

proof

Getter for proof.

type

Getter for type.

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

Bases: aries_cloudagent.vc.vc_ld.models.credential.CredentialSchema

Linked data verifiable credential schema.

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

proof

Used by autodoc_mock_imports.

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, **kwargs)[source]

Bases: aries_cloudagent.messaging.models.base.BaseModelSchema

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 LDProof

unknown

Used by autodoc_mock_imports.

add_unknown_properties(data: dict, original, **kwargs)[source]

Add back unknown properties before outputting.

challenge

Used by autodoc_mock_imports.

created

Used by autodoc_mock_imports.

domain

Used by autodoc_mock_imports.

jws

Used by autodoc_mock_imports.

nonce

Used by autodoc_mock_imports.

proof_purpose

Used by autodoc_mock_imports.

proof_value

Used by autodoc_mock_imports.

type

Used by autodoc_mock_imports.

verification_method

Used by autodoc_mock_imports.