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: 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

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

Add back unknown properties before outputting.

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, credential_status: Optional[Union[dict, List[dict]]] = None, proof: Optional[Union[dict, LDProof]] = None, **kwargs)[source]

Bases: 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_status

Getter for credential status.

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: CredentialSchema

Linked data verifiable credential schema.

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

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: 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: 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

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

Add back unknown properties before outputting.

aries_cloudagent.vc.vc_ld.models.options module

Options for specifying how the linked data proof is created.

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

Bases: Schema

Linked data proof credential status options schema.

class Meta[source]

Bases: object

Accept parameter overload.

class aries_cloudagent.vc.vc_ld.models.options.LDProofVCOptions(verification_method: Optional[str] = None, proof_type: Optional[str] = None, proof_purpose: Optional[str] = None, created: Optional[str] = None, domain: Optional[str] = None, challenge: Optional[str] = None, credential_status: Optional[dict] = None)[source]

Bases: BaseModel

Linked Data Proof verifiable credential options model.

class Meta[source]

Bases: object

LDProofVCDetailOptions metadata.

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

Bases: BaseModelSchema

Linked data proof verifiable credential options schema.

class Meta[source]

Bases: object

Accept parameter overload.

model_class

alias of LDProofVCOptions

aries_cloudagent.vc.vc_ld.models.presentation module

Verifiable Presentation model.

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

Bases: BaseModelSchema

Linked data presentation schema.

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

class Meta[source]

Bases: object

Accept parameter overload.

model_class

alias of VerifiablePresentation

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

Add back unknown properties before outputting.

class aries_cloudagent.vc.vc_ld.models.presentation.VerifiablePresentation(context: Optional[List[Union[str, dict]]] = None, id: Optional[str] = None, type: Optional[List[str]] = None, holder: Optional[Union[dict, str]] = None, verifiable_credential: Optional[List[dict]] = None, proof: Optional[Union[dict, LDProof]] = None, **kwargs)[source]

Bases: BaseModel

Single VerifiablePresentation object.

class Meta[source]

Bases: object

VerifiablePresentation metadata.

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

Add a context to this presentation.

add_type(type: str)[source]

Add a type to this presentation.

property context

Getter for context.

property context_urls: List[str]

Getter for context urls.

property holder

Getter for holder.

property holder_id: Optional[str]

Getter for holder id.

property id

Getter for id.

property proof

Getter for proof.

property type: List[str]

Getter for type.

property verifiable_credential

Getter for verifiable credential.

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

Bases: PresentationSchema

Single Verifiable Presentation Schema.

aries_cloudagent.vc.vc_ld.models.web_schemas module

VC-API routes web requests schemas.

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

Bases: OpenAPISchema

Response schema for fetching a credential.

results

alias of VerifiableCredentialSchema

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

Bases: Schema

Linked data proof verifiable credential options schema.

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

Bases: OpenAPISchema

Request schema for issuing a credential.

credential

alias of CredentialSchema

options

alias of IssuanceOptionsSchema

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

Bases: OpenAPISchema

Request schema for issuing a credential.

verifiableCredential

alias of VerifiableCredentialSchema

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

Bases: OpenAPISchema

Response schema for listing credentials.

results = [marshmallow.fields.Nested]
class aries_cloudagent.vc.vc_ld.models.web_schemas.ProvePresentationRequest(*args: Any, **kwargs: Any)[source]

Bases: OpenAPISchema

Request schema for proving a presentation.

options

alias of IssuanceOptionsSchema

presentation

alias of PresentationSchema

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

Bases: OpenAPISchema

Request schema for proving a presentation.

verifiablePresentation

alias of VerifiablePresentationSchema

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

Bases: OpenAPISchema

Request schema for verifying a credential.

options

alias of LDProofVCOptionsSchema

verifiableCredential

alias of VerifiableCredentialSchema

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

Bases: OpenAPISchema

Request schema for verifying an LDP VP.

results

alias of PresentationVerificationResultSchema

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

Bases: OpenAPISchema

Request schema for verifying a credential.

options

alias of LDProofVCOptionsSchema

verifiablePresentation

alias of VerifiablePresentationSchema

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

Bases: OpenAPISchema

Request schema for verifying an LDP VP.

results

alias of PresentationVerificationResultSchema