acapy_agent.anoncreds.models package

Submodules

acapy_agent.anoncreds.models.credential module

Credential artifacts.

class acapy_agent.anoncreds.models.credential.AnonCredsAttrValue(raw: str | None = None, encoded: str | None = None, **kwargs)[source]

Bases: BaseModel

AnonCreds attribute value.

class Meta[source]

Bases: object

AnonCreds attribute value.

schema_class = 'AnonCredsAttrValueSchema'

class acapy_agent.anoncreds.models.credential.AnonCredsAttrValueSchema(*args: Any, **kwargs: Any)[source]

Bases: BaseModelSchema

AnonCreds attribute value schema.

class Meta[source]

Bases: object

AnonCreds attribute value schema metadata.

model_class: alias of AnonCredsAttrValue

class acapy_agent.anoncreds.models.credential.AnonCredsCredential(schema_id: str | None = None, cred_def_id: str | None = None, rev_reg_id: str | None = None, values: Mapping[str, AnonCredsAttrValue] = None, signature: Mapping | None = None, signature_correctness_proof: Mapping | None = None, rev_reg: Mapping | None = None, witness: Mapping | None = None)[source]

Bases: BaseModel

AnonCreds credential.

class Meta[source]

Bases: object

AnonCreds credential metadata.

schema_class = 'AnonCredsCredentialSchema'

class acapy_agent.anoncreds.models.credential.AnonCredsCredentialSchema(*args: Any, **kwargs: Any)[source]

Bases: BaseModelSchema

AnonCreds credential schema.

class Meta[source]

Bases: object

AnonCreds credential schemametadata.

model_class: alias of AnonCredsCredential

class acapy_agent.anoncreds.models.credential.DictWithAnonCredsAttrValueSchema(*args: Any, **kwargs: Any)[source]

Bases: Dict

Dict with anoncreds attribute value schema.

acapy_agent.anoncreds.models.credential_definition module

AnonCreds cred def OpenAPI validators.

class acapy_agent.anoncreds.models.credential_definition.CredDef(issuer_id: str, schema_id: str, type: typing_extensions.Literal.CL, tag: str, value: CredDefValue, **kwargs)[source]

Bases: BaseModel

AnonCredsCredDef.

class Meta[source]

Bases: object

AnonCredsCredDef metadata.

schema_class = 'CredDefSchema'

classmethod from_native(cred_def: anoncreds.CredentialDefinition)[source]: Convert a native credential definition to a CredDef object.

to_native() → anoncreds.CredentialDefinition[source]: Convert to native anoncreds credential definition.

class acapy_agent.anoncreds.models.credential_definition.CredDefResult(job_id: str | None, credential_definition_state: CredDefState, registration_metadata: dict, credential_definition_metadata: dict, **kwargs)[source]

Bases: BaseModel

Cred def result.

class Meta[source]

Bases: object

CredDefResult metadata.

schema_class = 'CredDefResultSchema'

class acapy_agent.anoncreds.models.credential_definition.CredDefResultSchema(*args: Any, **kwargs: Any)[source]

Bases: BaseModelSchema

Cred def result schema.

class Meta[source]

Bases: object

CredDefResultSchema metadata.

model_class: alias of CredDefResult

class acapy_agent.anoncreds.models.credential_definition.CredDefSchema(*args: Any, **kwargs: Any)[source]

Bases: BaseModelSchema

CredDefSchema.

class Meta[source]

Bases: object

CredDefSchema metadata.

model_class: alias of CredDef

class acapy_agent.anoncreds.models.credential_definition.CredDefState(state: str, credential_definition_id: str | None, credential_definition: CredDef)[source]

Bases: BaseModel

CredDefState.

class Meta[source]

Bases: object

CredDefState metadata.

schema_class = 'CredDefStateSchema'

STATE_ACTION = 'action'

STATE_FAILED = 'failed'

STATE_FINISHED = 'finished'

STATE_WAIT = 'wait'

class acapy_agent.anoncreds.models.credential_definition.CredDefStateSchema(*args: Any, **kwargs: Any)[source]

Bases: BaseModelSchema

CredDefStateSchema.

class Meta[source]

Bases: object

CredDefStateSchema metadata.

model_class: alias of CredDefState

class acapy_agent.anoncreds.models.credential_definition.CredDefValue(primary: CredDefValuePrimary, revocation: CredDefValueRevocation | None = None, **kwargs)[source]

Bases: BaseModel

Cred def value.

class Meta[source]

Bases: object

CredDefValue metadata.

schema_class = 'CredDefValueSchemaAnonCreds'

class acapy_agent.anoncreds.models.credential_definition.CredDefValuePrimary(n: str, s: str, r: dict, rctxt: str, z: str, **kwargs)[source]

Bases: BaseModel

PrimarySchema.

class Meta[source]

Bases: object

PrimarySchema metadata.

schema_class = 'CredDefValuePrimarySchemaAnonCreds'

class acapy_agent.anoncreds.models.credential_definition.CredDefValuePrimarySchemaAnonCreds(*args: Any, **kwargs: Any)[source]

Bases: BaseModelSchema

Cred def value primary schema.

class Meta[source]

Bases: object

CredDefValuePrimarySchema metadata.

model_class: alias of CredDefValuePrimary

class acapy_agent.anoncreds.models.credential_definition.CredDefValueRevocation(g: str, g_dash: str, h: str, h0: str, h1: str, h2: str, htilde: str, h_cap: str, u: str, pk: str, y: str)[source]

Bases: BaseModel

Cred def value revocation.

class Meta[source]

Bases: object

CredDefValueRevocation metadata.

schema_class = 'CredDefValueRevocationSchemaAnonCreds'

class acapy_agent.anoncreds.models.credential_definition.CredDefValueRevocationSchemaAnonCreds(*args: Any, **kwargs: Any)[source]

Bases: BaseModelSchema

Cred def value revocation schema.

class Meta[source]

Bases: object

Metadata.

model_class: alias of CredDefValueRevocation

class acapy_agent.anoncreds.models.credential_definition.CredDefValueSchemaAnonCreds(*args: Any, **kwargs: Any)[source]

Bases: BaseModelSchema

Cred def value schema.

class Meta[source]

Bases: object

CredDefValueSchema metadata.

model_class: alias of CredDefValue

class acapy_agent.anoncreds.models.credential_definition.GetCredDefResult(credential_definition_id: str, credential_definition: CredDef, resolution_metadata: dict, credential_definition_metadata: dict, **kwargs)[source]

Bases: BaseModel

Get cred def result.

class Meta[source]

Bases: object

AnonCredsRegistryGetCredDef metadata.

schema_class = 'GetCredDefResultSchema'

class acapy_agent.anoncreds.models.credential_definition.GetCredDefResultSchema(*args: Any, **kwargs: Any)[source]

Bases: BaseModelSchema

GetCredDefResultSchema.

class Meta[source]

Bases: object

GetCredDefResultSchema metadata.

model_class: alias of GetCredDefResult

acapy_agent.anoncreds.models.credential_offer module

AnonCreds Credential Offer format for v2.0 of the issue-credential protocol.

class acapy_agent.anoncreds.models.credential_offer.AnonCredsCorrectnessProofSchema(*args: Any, **kwargs: Any)[source]

Bases: BaseModelSchema

AnonCreds key correctness proof schema.

class Meta[source]

Bases: object

AnonCreds key correctness proof schema metadata.

model_class: alias of AnonCredsKeyCorrectnessProof

class acapy_agent.anoncreds.models.credential_offer.AnonCredsCredentialOffer(schema_id: str | None = None, cred_def_id: str | None = None, nonce: str | None = None, key_correctness_proof: str | None = None, **kwargs)[source]

Bases: BaseModel

AnonCreds Credential Offer.

class Meta[source]

Bases: object

AnonCredsCredentialOffer metadata.

schema_class = 'AnonCredsCredentialOfferSchema'

class acapy_agent.anoncreds.models.credential_offer.AnonCredsCredentialOfferSchema(*args: Any, **kwargs: Any)[source]

Bases: BaseModelSchema

AnonCreds Credential Offer Schema.

class Meta[source]

Bases: object

AnonCredsCredentialOffer schema metadata.

model_class: alias of AnonCredsCredentialOffer

class acapy_agent.anoncreds.models.credential_offer.AnonCredsKeyCorrectnessProof(c: str | None = None, xz_cap: str | None = None, xr_cap: Sequence[Sequence[str]] | None = None, **kwargs)[source]

Bases: BaseModel

AnonCreds key correctness proof.

class Meta[source]

Bases: object

AnonCredsKeyCorrectnessProof metadata.

schema_class = 'AnonCredsKeyCorrectnessProofSchema'

acapy_agent.anoncreds.models.credential_proposal module

AnonCreds credential definition proposal.

class acapy_agent.anoncreds.models.credential_proposal.AnonCredsCredentialDefinitionProposal(*args: Any, **kwargs: Any)[source]

Bases: OpenAPISchema

Query string parameters for credential definition searches.

async acapy_agent.anoncreds.models.credential_proposal.notify_cred_def_event(profile: Profile, cred_def_id: str, meta_data: dict) → None[source]: Send notification for a cred def post-process event.

acapy_agent.anoncreds.models.credential_request module

Cred request artifacts to attach to RFC 453 messages.

class acapy_agent.anoncreds.models.credential_request.AnonCredsCredRequest(entropy: str | None = None, prover_did: str | None = None, cred_def_id: str | None = None, blinded_ms: Mapping | None = None, blinded_ms_correctness_proof: Mapping | None = None, nonce: str | None = None, **kwargs)[source]

Bases: BaseModel

AnonCreds credential request.

class Meta[source]

Bases: object

AnonCreds credential request metadata.

schema_class = 'AnonCredsCredRequestSchema'

class acapy_agent.anoncreds.models.credential_request.AnonCredsCredRequestSchema(*args: Any, **kwargs: Any)[source]

Bases: BaseModelSchema

AnonCreds credential request schema.

class Meta[source]

Bases: object

AnonCreds credential request schema metadata.

model_class: alias of AnonCredsCredRequest

acapy_agent.anoncreds.models.issuer_cred_rev_record module

Issuer credential revocation information.

Bases: IssuerCredRevRecord

Represents credential revocation information to retain post-issue.

class Meta[source]

Bases: object

IssuerCredRevRecord metadata.

schema_class = 'IssuerCredRevRecordSchemaAnonCreds'

async classmethod query_by_ids(session: ProfileSession, *, cred_def_id: str | None = None, rev_reg_id: str | None = None, state: str | None = None) → Sequence[IssuerCredRevRecord][source]

Retrieve issuer cred rev records by cred def id and/or rev reg id.

Parameters:

session – the profile session to use
cred_def_id – the cred def id by which to filter
rev_reg_id – the rev reg id by which to filter
state – a state value by which to filter

async classmethod retrieve_by_ids(session: ProfileSession, rev_reg_id: str, cred_rev_id: str | List[str], *, for_update: bool = False) → Sequence[IssuerCredRevRecord][source]: Retrieve a list of issuer cred rev records by rev reg id and cred rev ids.

class acapy_agent.anoncreds.models.issuer_cred_rev_record.IssuerCredRevRecordSchemaAnonCreds(*args: Any, **kwargs: Any)[source]

Bases: BaseRecordSchema

Schema to allow de/serialization of credential revocation records.

class Meta[source]

Bases: object

IssuerCredRevRecordSchemaAnonCreds metadata.

model_class: alias of IssuerCredRevRecord

acapy_agent.anoncreds.models.non_rev_interval module

AnonCreds non-revocation interval.

class acapy_agent.anoncreds.models.non_rev_interval.AnonCredsNonRevocationInterval(fro: int | None = None, to: int | None = None, **kwargs)[source]

Bases: BaseModel

AnonCreds non-revocation interval.

class Meta[source]

Bases: object

NonRevocationInterval metadata.

schema_class = 'AnonCredsNonRevocationIntervalSchema'

covers(timestamp: int | None = None) → bool[source]

Whether input timestamp (default now) lies within non-revocation interval.

Parameters:: timestamp – time of interest
Returns:: whether input time satisfies non-revocation interval

timestamp() → int[source]: Return a timestamp that the non-revocation interval covers.

class acapy_agent.anoncreds.models.non_rev_interval.AnonCredsNonRevocationIntervalSchema(*args: Any, **kwargs: Any)[source]

Bases: BaseModelSchema

Schema to allow serialization/deserialization of non-revocation intervals.

class Meta[source]

Bases: object

AnonCredsNonRevocationIntervalSchema metadata.

model_class: alias of AnonCredsNonRevocationInterval

acapy_agent.anoncreds.models.predicate module

Utilities for dealing with predicates.

class acapy_agent.anoncreds.models.predicate.Predicate(*values)[source]

Bases: Enum

Enum for predicate types that anoncreds-sdk supports.

GE = ('GE', '$gte', '>=', <function Predicate.<lambda>>, <function Predicate.<lambda>>)

GT = ('GT', '$gt', '>', <function Predicate.<lambda>>, <function Predicate.<lambda>>)

LE = ('LE', '$lte', '<=', <function Predicate.<lambda>>, <function Predicate.<lambda>>)

LT = ('LT', '$lt', '<', <function Predicate.<lambda>>, <function Predicate.<lambda>>)

property fortran: str: Fortran nomenclature.

static get(relation: str) → Predicate | None[source]: Return enum instance corresponding to input relation string.

property math: str: Mathematical nomenclature.

static to_int(value: Any) → int[source]

Cast a value as its equivalent int for anoncreds predicate argument.

Raise ValueError for any input but int, stringified int, or boolean.

Parameters:: value – value to coerce

property wql: str: WQL nomenclature.

class acapy_agent.anoncreds.models.predicate.Relation(fortran, wql, math, yes, no)

Bases: tuple

fortran: Alias for field number 0

math: Alias for field number 2

no: Alias for field number 4

wql: Alias for field number 1

yes: Alias for field number 3

acapy_agent.anoncreds.models.presentation_request module

Classes to represent anoncreds presentation request.

class acapy_agent.anoncreds.models.presentation_request.AnonCredsPresentationReqAttrSpecSchema(*args: Any, **kwargs: Any)[source]

Bases: OpenAPISchema

Schema for attribute specification in anoncreds proof request.

validate_fields(data: dict, **kwargs) → None

Validate schema fields.

Data must have exactly one of name or names; if names then restrictions are mandatory.

Parameters:

data – The data to validate
kwargs – Additional keyword arguments

Raises:

ValidationError – if data has both or neither of name and names

class acapy_agent.anoncreds.models.presentation_request.AnonCredsPresentationReqPredSpecSchema(*args: Any, **kwargs: Any)[source]

Bases: OpenAPISchema

Schema for predicate specification in anoncreds proof request.

class acapy_agent.anoncreds.models.presentation_request.AnonCredsPresentationRequest(nonce: str | None = None, name: str | None = None, version: str | None = None, requested_attributes: Mapping | None = None, requested_predicates: Mapping | None = None, non_revoked: Mapping | None = None, **kwargs)[source]

Bases: BaseModel

anoncreds proof request.

class Meta[source]

Bases: object

AnonCreds proof request metadata.

schema_class = 'AnonCredsPresentationRequestSchema'

class acapy_agent.anoncreds.models.presentation_request.AnonCredsPresentationRequestSchema(*args: Any, **kwargs: Any)[source]

Bases: BaseModelSchema

Schema for anoncreds proof request.

class Meta[source]

Bases: object

AnonCreds proof request schema metadata.

model_class: alias of AnonCredsPresentationRequest

acapy_agent.anoncreds.models.proof module

Marshmallow bindings for anoncreds proofs.

class acapy_agent.anoncreds.models.proof.AnonCredsEQProof(revealed_attrs: Mapping[str, str] = None, a_prime: str | None = None, e: str | None = None, v: str | None = None, m: Mapping[str, str] = None, m2: str | None = None, **kwargs)[source]

Bases: BaseModel

Equality proof for anoncreds primary proof.

class Meta[source]

Bases: object

Equality proof metadata.

schema_class = 'AnonCredsEQProofMeta'

class acapy_agent.anoncreds.models.proof.AnonCredsEQProofSchema(*args: Any, **kwargs: Any)[source]

Bases: BaseModelSchema

AnonCreds equality proof schema.

class Meta[source]

Bases: object

AnonCreds equality proof metadata.

model_class: alias of AnonCredsEQProof

class acapy_agent.anoncreds.models.proof.AnonCredsGEProof(u: Mapping[str, str] = None, r: Mapping[str, str] = None, mj: str | None = None, alpha: str | None = None, t: Mapping[str, str] = None, predicate: AnonCredsGEProofPred | None = None, **kwargs)[source]

Bases: BaseModel

Greater-than-or-equal-to proof for anoncreds primary proof.

class Meta[source]

Bases: object

GE proof metadata.

schema_class = 'AnonCredsGEProofMeta'

class acapy_agent.anoncreds.models.proof.AnonCredsGEProofPred(attr_name: str | None = None, p_type: str | None = None, value: int | None = None, **kwargs)[source]

Bases: BaseModel

AnonCreds GE proof predicate.

class Meta[source]

Bases: object

AnonCreds GE proof predicate metadata.

schema_class = 'AnonCredsGEProofPredSchema'

class acapy_agent.anoncreds.models.proof.AnonCredsGEProofPredSchema(*args: Any, **kwargs: Any)[source]

Bases: BaseModelSchema

AnonCreds GE proof predicate schema.

class Meta[source]

Bases: object

AnonCreds GE proof predicate metadata.

model_class: alias of AnonCredsGEProofPred

class acapy_agent.anoncreds.models.proof.AnonCredsGEProofSchema(*args: Any, **kwargs: Any)[source]

Bases: BaseModelSchema

AnonCreds GE proof schema.

class Meta[source]

Bases: object

AnonCreds GE proof schema metadata.

model_class: alias of AnonCredsGEProof

predicate: alias of AnonCredsGEProofPredSchema

class acapy_agent.anoncreds.models.proof.AnonCredsNonRevocProof(x_list: Mapping | None = None, c_list: Mapping | None = None, **kwargs)[source]

Bases: BaseModel

AnonCreds non-revocation proof.

class Meta[source]

Bases: object

AnonCreds non-revocation proof metadata.

schema_class = 'AnonCredsNonRevocProofSchema'

class acapy_agent.anoncreds.models.proof.AnonCredsNonRevocProofSchema(*args: Any, **kwargs: Any)[source]

Bases: BaseModelSchema

AnonCreds non-revocation proof schema.

class Meta[source]

Bases: object

AnonCreds non-revocation proof schema metadata.

model_class: alias of AnonCredsNonRevocProof

class acapy_agent.anoncreds.models.proof.AnonCredsPresSpecSchema(*args: Any, **kwargs: Any)[source]

Bases: AdminAPIMessageTracingSchema

Request schema for anoncreds proof specification to send as presentation.

class acapy_agent.anoncreds.models.proof.AnonCredsPrimaryProof(eq_proof: AnonCredsEQProof | None = None, ge_proofs: Sequence[AnonCredsGEProof] = None, **kwargs)[source]

Bases: BaseModel

AnonCreds primary proof.

class Meta[source]

Bases: object

AnonCreds primary proof metadata.

schema_class = 'AnonCredsPrimaryProofSchema'

class acapy_agent.anoncreds.models.proof.AnonCredsPrimaryProofSchema(*args: Any, **kwargs: Any)[source]

Bases: BaseModelSchema

AnonCreds primary proof schema.

class Meta[source]

Bases: object

AnonCreds primary proof schema metadata.

model_class: alias of AnonCredsPrimaryProof

eq_proof: alias of AnonCredsEQProofSchema

ge_proofs: alias of AnonCredsGEProofSchema

class acapy_agent.anoncreds.models.proof.AnonCredsProof(proof: AnonCredsProofProof | None = None, requested_proof: AnonCredsProofRequestedProof | None = None, identifiers: Sequence[AnonCredsProofIdentifier] = None, **kwargs)[source]

Bases: BaseModel

AnonCreds proof.

class Meta[source]

Bases: object

AnonCreds proof metadata.

schema_class = 'AnonCredsProofSchema'

class acapy_agent.anoncreds.models.proof.AnonCredsProofIdentifier(schema_id: str | None = None, cred_def_id: str | None = None, rev_reg_id: str | None = None, timestamp: int | None = None, **kwargs)[source]

Bases: BaseModel

AnonCreds proof identifier.

class Meta[source]

Bases: object

AnonCreds proof identifier metadata.

schema_class = 'AnonCredsProofIdentifierSchema'

class acapy_agent.anoncreds.models.proof.AnonCredsProofIdentifierSchema(*args: Any, **kwargs: Any)[source]

Bases: BaseModelSchema

AnonCreds proof identifier schema.

class Meta[source]

Bases: object

AnonCreds proof identifier schema metadata.

model_class: alias of AnonCredsProofIdentifier

class acapy_agent.anoncreds.models.proof.AnonCredsProofProof(proofs: Sequence[AnonCredsProofProofProofsProof] = None, aggregated_proof: AnonCredsProofProofAggregatedProof | None = None, **kwargs)[source]

Bases: BaseModel

AnonCreds proof.proof content.

class Meta[source]

Bases: object

AnonCreds proof.proof content metadata.

schema_class = 'AnonCredsProofProofSchema'

class acapy_agent.anoncreds.models.proof.AnonCredsProofProofAggregatedProof(c_hash: str | None = None, c_list: Sequence[Sequence[int]] = None, **kwargs)[source]

Bases: BaseModel

AnonCreds proof.proof aggregated proof.

class Meta[source]

Bases: object

AnonCreds proof.proof aggregated proof metadata.

schema_class = 'AnonCredsProofProofAggregatedProofSchema'

class acapy_agent.anoncreds.models.proof.AnonCredsProofProofAggregatedProofSchema(*args: Any, **kwargs: Any)[source]

Bases: BaseModelSchema

AnonCreds proof.proof aggregated proof schema.

class Meta[source]

Bases: object

AnonCreds proof.proof aggregated proof schema metadata.

model_class: alias of AnonCredsProofProofAggregatedProof

class acapy_agent.anoncreds.models.proof.AnonCredsProofProofProofsProof(primary_proof: AnonCredsPrimaryProof | None = None, non_revoc_proof: AnonCredsNonRevocProof | None = None, **kwargs)[source]

Bases: BaseModel

AnonCreds proof.proof.proofs constituent proof.

class Meta[source]

Bases: object

AnonCreds proof.proof.proofs constituent proof schema.

schema_class = 'AnonCredsProofProofProofsProofSchema'

class acapy_agent.anoncreds.models.proof.AnonCredsProofProofProofsProofSchema(*args: Any, **kwargs: Any)[source]

Bases: BaseModelSchema

AnonCreds proof.proof.proofs constituent proof schema.

class Meta[source]

Bases: object

AnonCreds proof.proof.proofs constituent proof schema metadata.

model_class: alias of AnonCredsProofProofProofsProof

non_revoc_proof: alias of AnonCredsNonRevocProofSchema

primary_proof: alias of AnonCredsPrimaryProofSchema

class acapy_agent.anoncreds.models.proof.AnonCredsProofProofSchema(*args: Any, **kwargs: Any)[source]

Bases: BaseModelSchema

AnonCreds proof.proof content schema.

class Meta[source]

Bases: object

AnonCreds proof.proof content schema metadata.

model_class: alias of AnonCredsProofProof

aggregated_proof: alias of AnonCredsProofProofAggregatedProofSchema

proofs: alias of AnonCredsProofProofProofsProofSchema

class acapy_agent.anoncreds.models.proof.AnonCredsProofRequestedProof(revealed_attrs: Mapping[str, AnonCredsProofRequestedProofRevealedAttr] = None, revealed_attr_groups: Mapping[str, AnonCredsProofRequestedProofRevealedAttrGroup] = None, self_attested_attrs: Mapping | None = None, unrevealed_attrs: Mapping | None = None, predicates: Mapping[str, AnonCredsProofRequestedProofPredicate] = None, **kwargs)[source]

Bases: BaseModel

AnonCreds proof.requested_proof content.

class Meta[source]

Bases: object

AnonCreds proof.requested_proof content metadata.

schema_class = 'AnonCredsProofRequestedProofSchema'

class acapy_agent.anoncreds.models.proof.AnonCredsProofRequestedProofPredicate(sub_proof_index: int | None = None, **kwargs)[source]

Bases: BaseModel

AnonCreds proof requested proof predicate.

class Meta[source]

Bases: object

AnonCreds proof requested proof requested proof predicate metadata.

schema_class = 'AnonCredsProofRequestedProofPredicateSchema'

class acapy_agent.anoncreds.models.proof.AnonCredsProofRequestedProofPredicateSchema(*args: Any, **kwargs: Any)[source]

Bases: BaseModelSchema

AnonCreds proof requested prrof predicate schema.

class Meta[source]

Bases: object

AnonCreds proof requested proof requested proof predicate schema metadata.

model_class: alias of AnonCredsProofRequestedProofPredicate

class acapy_agent.anoncreds.models.proof.AnonCredsProofRequestedProofRevealedAttr(sub_proof_index: int | None = None, **kwargs)[source]

Bases: RawEncoded

AnonCreds proof requested proof revealed attr.

class Meta[source]

Bases: object

AnonCreds proof requested proof revealed attr metadata.

schema_class = 'AnonCredsProofRequestedProofRevealedAttrSchema'

class acapy_agent.anoncreds.models.proof.AnonCredsProofRequestedProofRevealedAttrGroup(sub_proof_index: int | None = None, values: Mapping[str, RawEncoded] = None, **kwargs)[source]

Bases: BaseModel

AnonCreds proof requested proof revealed attr group.

class Meta[source]

Bases: object

AnonCreds proof requested proof revealed attr group metadata.

schema_class = 'AnonCredsProofRequestedProofRevealedAttrGroupSchema'

class acapy_agent.anoncreds.models.proof.AnonCredsProofRequestedProofRevealedAttrGroupSchema(*args: Any, **kwargs: Any)[source]

Bases: BaseModelSchema

AnonCreds proof requested proof revealed attr group schema.

class Meta[source]

Bases: object

AnonCreds proof requested proof revealed attr group schema metadata.

model_class: alias of AnonCredsProofRequestedProofRevealedAttrGroup

class acapy_agent.anoncreds.models.proof.AnonCredsProofRequestedProofRevealedAttrSchema(*args: Any, **kwargs: Any)[source]

Bases: RawEncodedSchema

AnonCreds proof requested proof revealed attr schema.

class Meta[source]

Bases: object

AnonCreds proof requested proof revealed attr schema metadata.

model_class: alias of AnonCredsProofRequestedProofRevealedAttr

class acapy_agent.anoncreds.models.proof.AnonCredsProofRequestedProofSchema(*args: Any, **kwargs: Any)[source]

Bases: BaseModelSchema

AnonCreds proof requested proof schema.

class Meta[source]

Bases: object

AnonCreds proof requested proof schema metadata.

model_class: alias of AnonCredsProofRequestedProof

class acapy_agent.anoncreds.models.proof.AnonCredsProofSchema(*args: Any, **kwargs: Any)[source]

Bases: BaseModelSchema

AnonCreds proof schema.

class Meta[source]

Bases: object

AnonCreds proof schema metadata.

model_class: alias of AnonCredsProof

identifiers: alias of AnonCredsProofIdentifierSchema

proof: alias of AnonCredsProofProofSchema

requested_proof: alias of AnonCredsProofRequestedProofSchema

class acapy_agent.anoncreds.models.proof.RawEncoded(raw: str | None = None, encoded: str | None = None, **kwargs)[source]

Bases: BaseModel

Raw and encoded attribute values.

class Meta[source]

Bases: object

Raw and encoded attribute values metadata.

schema_class = 'RawEncodedSchema'

class acapy_agent.anoncreds.models.proof.RawEncodedSchema(*args: Any, **kwargs: Any)[source]

Bases: BaseModelSchema

Raw and encoded attribute values schema.

class Meta[source]

Bases: object

Raw and encoded attribute values schema metadata.

model_class: alias of RawEncoded

acapy_agent.anoncreds.models.requested_credentials module

Admin routes for presentations.

class acapy_agent.anoncreds.models.requested_credentials.AnonCredsRequestedCredsRequestedAttrSchema(*args: Any, **kwargs: Any)[source]

Bases: OpenAPISchema

Schema for requested attributes within anoncreds requested creds structure.

class acapy_agent.anoncreds.models.requested_credentials.AnonCredsRequestedCredsRequestedPredSchema(*args: Any, **kwargs: Any)[source]

Bases: OpenAPISchema

Schema for requested predicates within anoncreds requested creds structure.

acapy_agent.anoncreds.models.revocation module

AnonCreds cred def OpenAPI validators.

class acapy_agent.anoncreds.models.revocation.GetRevListResult(revocation_list: RevList, resolution_metadata: Dict[str, Any], revocation_registry_metadata: Dict[str, Any], **kwargs)[source]

Bases: BaseModel

GetRevListResult.

class Meta[source]

Bases: object

GetRevListResult metadata.

schema_class = 'GetRevListResultSchema'

class acapy_agent.anoncreds.models.revocation.GetRevListResultSchema(*args: Any, **kwargs: Any)[source]

Bases: BaseModelSchema

GetRevListResultSchema.

class Meta[source]

Bases: object

GetRevListResultSchema metadata.

model_class: alias of GetRevListResult

revocation_list: alias of RevListSchema

class acapy_agent.anoncreds.models.revocation.GetRevRegDefResult(revocation_registry: RevRegDef, revocation_registry_id: str, resolution_metadata: Dict[str, Any], revocation_registry_metadata: Dict[str, Any], **kwargs)[source]

Bases: BaseModel

GetRevRegDefResult.

class Meta[source]

Bases: object

GetRevRegDefResult metadata.

schema_class = 'GetRevRegDefResultSchema'

class acapy_agent.anoncreds.models.revocation.GetRevRegDefResultSchema(*args: Any, **kwargs: Any)[source]

Bases: BaseModelSchema

GetRevRegDefResultSchema.

class Meta[source]

Bases: object

GetRevRegDefResultSchema metadata.

model_class: alias of GetRevRegDefResult

class acapy_agent.anoncreds.models.revocation.RevList(issuer_id: str, rev_reg_def_id: str, revocation_list: List[int], current_accumulator: str, timestamp: int | None = None, **kwargs)[source]

Bases: BaseModel

RevList.

class Meta[source]

Bases: object

RevList metadata.

schema_class = 'RevListSchema'

classmethod from_native(rev_list: anoncreds.RevocationStatusList)[source]: Convert from native revocation list.

to_native() → anoncreds.RevocationStatusList[source]: Convert to native revocation list.

class acapy_agent.anoncreds.models.revocation.RevListResult(job_id: str | None, revocation_list_state: RevListState, registration_metadata: dict, revocation_list_metadata: dict, **kwargs)[source]

Bases: BaseModel

Cred def result.

class Meta[source]

Bases: object

RevListResult metadata.

schema_class = 'RevListResultSchema'

property rev_reg_def_id: str: Rev reg def id.

class acapy_agent.anoncreds.models.revocation.RevListResultSchema(*args: Any, **kwargs: Any)[source]

Bases: BaseModelSchema

Cred def result schema.

class Meta[source]

Bases: object

RevListResultSchema metadata.

model_class: alias of RevListResult

class acapy_agent.anoncreds.models.revocation.RevListSchema(*args: Any, **kwargs: Any)[source]

Bases: BaseModelSchema

RevListSchema.

class Meta[source]

Bases: object

RevListSchema metadata.

model_class: alias of RevList

class acapy_agent.anoncreds.models.revocation.RevListState(state: str, revocation_list: RevList)[source]

Bases: BaseModel

RevListState.

class Meta[source]

Bases: object

RevListState metadata.

schema_class = 'RevListStateSchema'

STATE_ACTION = 'action'

STATE_FAILED = 'failed'

STATE_FINISHED = 'finished'

STATE_WAIT = 'wait'

class acapy_agent.anoncreds.models.revocation.RevListStateSchema(*args: Any, **kwargs: Any)[source]

Bases: BaseModelSchema

RevListStateSchema.

class Meta[source]

Bases: object

RevListStateSchema metadata.

model_class: alias of RevListState

class acapy_agent.anoncreds.models.revocation.RevRegDef(issuer_id: str, type: typing_extensions.Literal.CL_ACCUM, cred_def_id: str, tag: str, value: RevRegDefValue, **kwargs)[source]

Bases: BaseModel

RevRegDef.

class Meta[source]

Bases: object

RevRegDef metadata.

schema_class = 'RevRegDefSchema'

classmethod from_native(rev_reg_def: anoncreds.RevocationRegistryDefinition)[source]: Convert a native revocation registry definition to a RevRegDef object.

to_native() → anoncreds.RevocationRegistryDefinition[source]: Convert to native anoncreds revocation registry definition.

class acapy_agent.anoncreds.models.revocation.RevRegDefResult(job_id: str | None, revocation_registry_definition_state: RevRegDefState, registration_metadata: dict, revocation_registry_definition_metadata: dict, **kwargs)[source]

Bases: BaseModel

Cred def result.

class Meta[source]

Bases: object

RevRegDefResult metadata.

schema_class = 'RevRegDefResultSchema'

property rev_reg_def: RevRegDef: Revocation Registry Definition.

property rev_reg_def_id: str: Revocation Registry Definition ID.

class acapy_agent.anoncreds.models.revocation.RevRegDefResultSchema(*args: Any, **kwargs: Any)[source]

Bases: BaseModelSchema

Cred def result schema.

class Meta[source]

Bases: object

RevRegDefResultSchema metadata.

model_class: alias of RevRegDefResult

class acapy_agent.anoncreds.models.revocation.RevRegDefSchema(*args: Any, **kwargs: Any)[source]

Bases: BaseModelSchema

RevRegDefSchema.

class Meta[source]

Bases: object

RevRegDefSchema metadata.

model_class: alias of RevRegDef

class acapy_agent.anoncreds.models.revocation.RevRegDefState(state: str, revocation_registry_definition_id: str, revocation_registry_definition: RevRegDef)[source]

Bases: BaseModel

RevRegDefState.

class Meta[source]

Bases: object

RevRegDefState metadata.

schema_class = 'RevRegDefStateSchema'

STATE_ACTION = 'action'

STATE_DECOMMISSIONED = 'decommissioned'

STATE_FAILED = 'failed'

STATE_FINISHED = 'finished'

STATE_FULL = 'full'

STATE_WAIT = 'wait'

class acapy_agent.anoncreds.models.revocation.RevRegDefStateSchema(*args: Any, **kwargs: Any)[source]

Bases: BaseModelSchema

RevRegDefStateSchema.

class Meta[source]

Bases: object

RevRegDefStateSchema metadata.

model_class: alias of RevRegDefState

class acapy_agent.anoncreds.models.revocation.RevRegDefValue(public_keys: dict, max_cred_num: int, tails_location: str, tails_hash: str, **kwargs)[source]

Bases: BaseModel

RevRegDefValue model.

class Meta[source]

Bases: object

RevRegDefValue metadata.

schema_class = 'RevRegDefValueSchema'

class acapy_agent.anoncreds.models.revocation.RevRegDefValueSchema(*args: Any, **kwargs: Any)[source]

Bases: BaseModelSchema

RevRegDefValue schema.

class Meta[source]

Bases: object

RevRegDefValueSchema metadata.

model_class: alias of RevRegDefValue

acapy_agent.anoncreds.models.schema module

AnonCreds Schema OpenAPI validators.

class acapy_agent.anoncreds.models.schema.AnonCredsSchema(issuer_id: str, attr_names: List[str], name: str, version: str, **kwargs)[source]

Bases: BaseModel

An AnonCreds Schema object.

class Meta[source]

Bases: object

AnonCredsSchema metadata.

schema_class = 'AnonCredsSchemaSchema'

classmethod from_native(schema: anoncreds.Schema) → AnonCredsSchema[source]: Convert from native object.

to_native() → anoncreds.Schema[source]: Convert to native object.

class acapy_agent.anoncreds.models.schema.AnonCredsSchemaSchema(*args: Any, **kwargs: Any)[source]

Bases: BaseModelSchema

Marshmallow schema for anoncreds schema.

class Meta[source]

Bases: object

AnonCredsSchemaSchema metadata.

model_class: alias of AnonCredsSchema

class acapy_agent.anoncreds.models.schema.GetSchemaResult(schema: AnonCredsSchema, schema_id: str, resolution_metadata: Dict[str, Any], schema_metadata: Dict[str, Any], **kwargs)[source]

Bases: BaseModel

Result of resolving a schema.

class Meta[source]

Bases: object

GetSchemaResult metadata.

schema_class = 'GetSchemaResultSchema'

property schema: AnonCredsSchema

Alias for schema_value.

schema can’t be used directly due to a limitation of marshmallow.

class acapy_agent.anoncreds.models.schema.GetSchemaResultSchema(*args: Any, **kwargs: Any)[source]

Bases: BaseModelSchema

Parameters and validators for schema create query.

class Meta[source]

Bases: object

GetSchemaResultSchema metadata.

model_class: alias of GetSchemaResult

class acapy_agent.anoncreds.models.schema.SchemaResult(job_id: str | None, schema_state: SchemaState, registration_metadata: dict | None = None, schema_metadata: dict | None = None, **kwargs)[source]

Bases: BaseModel

Result of registering a schema.

class Meta[source]

Bases: object

SchemaResult metadata.

schema_class = 'SchemaResultSchema'

class acapy_agent.anoncreds.models.schema.SchemaResultSchema(*args: Any, **kwargs: Any)[source]

Bases: BaseModelSchema

Parameters and validators for schema state.

class Meta[source]

Bases: object

SchemaResultSchema metadata.

model_class: alias of SchemaResult

class acapy_agent.anoncreds.models.schema.SchemaState(state: str, schema_id: str, schema: AnonCredsSchema, **kwargs)[source]

Bases: BaseModel

Model representing the state of a schema after beginning registration.

class Meta[source]

Bases: object

SchemaState metadata.

schema_class = 'SchemaStateSchema'

STATE_ACTION = 'action'

STATE_FAILED = 'failed'

STATE_FINISHED = 'finished'

STATE_WAIT = 'wait'

property schema: AnonCredsSchema

Alias to schema_value.

schema can’t be used directly due to limitations of marshmallow.

class acapy_agent.anoncreds.models.schema.SchemaStateSchema(*args: Any, **kwargs: Any)[source]

Bases: BaseModelSchema

Parameters and validators for schema state.

class Meta[source]

Bases: object

SchemaStateSchema metadata.

model_class: alias of SchemaState

acapy_agent.anoncreds.models.schema_info module

Schema information for AnonCreds.

class acapy_agent.anoncreds.models.schema_info.AnonCredsSchemaInfo(issuer_id: str, name: str | None = None, version: str | None = None)[source]

Bases: object

Represents the schema information for anonymous credentials.

issuer_id

The identifier of the issuer.

Type:: str

name

The name of the schema. Defaults to None.

Type:: Optional[str]

version

The version of the schema. Defaults to None.

Type:: Optional[str]

Parameters:

issuer_id (str) – The identifier of the issuer.
name (Optional[str], optional) – The name of the schema. Defaults to None.
version (Optional[str], optional) – The version of the schema. Defaults to None.

acapy_agent.anoncreds.models package

Submodules

acapy_agent.anoncreds.models.credential module

acapy_agent.anoncreds.models.credential_definition module

acapy_agent.anoncreds.models.credential_offer module

acapy_agent.anoncreds.models.credential_proposal module

acapy_agent.anoncreds.models.credential_request module

acapy_agent.anoncreds.models.issuer_cred_rev_record module

acapy_agent.anoncreds.models.non_rev_interval module

acapy_agent.anoncreds.models.predicate module

acapy_agent.anoncreds.models.presentation_request module

acapy_agent.anoncreds.models.proof module

acapy_agent.anoncreds.models.requested_credentials module

acapy_agent.anoncreds.models.revocation module

acapy_agent.anoncreds.models.schema module

acapy_agent.anoncreds.models.schema_info module

acapy_agent.anoncreds.models.utils module