acapy_agent.indy.models package

Submodules

acapy_agent.indy.models.cred module

Credential artifacts.

class acapy_agent.indy.models.cred.DictWithIndyAttrValueSchema(*args: Any, **kwargs: Any)

Bases: Dict

Dict with indy attribute value schema.

class acapy_agent.indy.models.cred.IndyAttrValue(raw: str | None = None, encoded: str | None = None, **kwargs)

Bases: BaseModel

Indy attribute value.

class Meta

Bases: object

Indy attribute value.

schema_class = 'IndyAttrValueSchema'

class acapy_agent.indy.models.cred.IndyAttrValueSchema(*args: Any, **kwargs: Any)

Bases: BaseModelSchema

Indy attribute value schema.

class Meta

Bases: object

Indy attribute value schema metadata.

model_class

alias of IndyAttrValue

class acapy_agent.indy.models.cred.IndyCredential(schema_id: str | None = None, cred_def_id: str | None = None, rev_reg_id: str | None = None, values: Mapping[str, IndyAttrValue] = None, signature: Mapping | None = None, signature_correctness_proof: Mapping | None = None, rev_reg: Mapping | None = None, witness: Mapping | None = None)

Bases: BaseModel

Indy credential.

class Meta

Bases: object

Indy credential metadata.

schema_class = 'IndyCredentialSchema'

class acapy_agent.indy.models.cred.IndyCredentialSchema(*args: Any, **kwargs: Any)

Bases: BaseModelSchema

Indy credential schema.

class Meta

Bases: object

Indy credential schemametadata.

model_class

alias of IndyCredential

acapy_agent.indy.models.cred_abstract module

Cred abstract artifacts to attach to RFC 453 messages.

class acapy_agent.indy.models.cred_abstract.IndyCredAbstract(schema_id: str | None = None, cred_def_id: str | None = None, nonce: str | None = None, key_correctness_proof: str | None = None, **kwargs)

Bases: BaseModel

Indy credential abstract.

class Meta

Bases: object

Indy credential abstract metadata.

schema_class = 'IndyCredAbstractSchema'

class acapy_agent.indy.models.cred_abstract.IndyCredAbstractSchema(*args: Any, **kwargs: Any)

Bases: BaseModelSchema

Indy credential abstract schema.

class Meta

Bases: object

Indy credential abstract schema metadata.

model_class

alias of IndyCredAbstract

class acapy_agent.indy.models.cred_abstract.IndyKeyCorrectnessProof(c: str | None = None, xz_cap: str | None = None, xr_cap: Sequence[Sequence[str]] = None, **kwargs)

Bases: BaseModel

Indy key correctness proof.

class Meta

Bases: object

IndyKeyCorrectnessProof metadata.

schema_class = 'IndyKeyCorrectnessProofSchema'

class acapy_agent.indy.models.cred_abstract.IndyKeyCorrectnessProofSchema(*args: Any, **kwargs: Any)

Bases: BaseModelSchema

Indy key correctness proof schema.

class Meta

Bases: object

Indy key correctness proof schema metadata.

model_class

alias of IndyKeyCorrectnessProof

acapy_agent.indy.models.cred_def module

Schema artifacts.

class acapy_agent.indy.models.cred_def.CredDefValuePrimarySchema(*args: Any, **kwargs: Any)

Bases: OpenAPISchema

Cred def value primary schema.

class acapy_agent.indy.models.cred_def.CredDefValueRevocationSchema(*args: Any, **kwargs: Any)

Bases: OpenAPISchema

Cred def value revocation schema.

class acapy_agent.indy.models.cred_def.CredDefValueSchema(*args: Any, **kwargs: Any)

Bases: OpenAPISchema

Cred def value schema.

class acapy_agent.indy.models.cred_def.CredentialDefinitionSchema(*args: Any, **kwargs: Any)

Bases: OpenAPISchema

Marshmallow schema for indy cred def.

acapy_agent.indy.models.cred_precis module

Admin routes for presentations.

class acapy_agent.indy.models.cred_precis.IndyCredInfo(referent: str | None = None, attrs: Mapping | None = None, schema_id: str | None = None, cred_def_id: str | None = None, rev_reg_id: str | None = None, cred_rev_id: str | None = None)

Bases: BaseModel

Indy cred info, as holder gets via indy-sdk.

class Meta

Bases: object

IndyCredInfo metadata.

schema_class = 'IndyCredInfoSchema'

class acapy_agent.indy.models.cred_precis.IndyCredInfoSchema(*args: Any, **kwargs: Any)

Bases: BaseModelSchema

Schema for indy cred-info.

class Meta

Bases: object

Schema metadata.

model_class

alias of IndyCredInfo

class acapy_agent.indy.models.cred_precis.IndyCredPrecisSchema(*args: Any, **kwargs: Any)

Bases: OpenAPISchema

Schema for precis that indy credential search returns (and aca-py augments).

acapy_agent.indy.models.cred_request module

Cred request artifacts to attach to RFC 453 messages.

class acapy_agent.indy.models.cred_request.IndyCredRequest(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)

Bases: BaseModel

Indy credential request.

class Meta

Bases: object

Indy credential request metadata.

schema_class = 'IndyCredRequestSchema'

class acapy_agent.indy.models.cred_request.IndyCredRequestSchema(*args: Any, **kwargs: Any)

Bases: BaseModelSchema

Indy credential request schema.

class Meta

Bases: object

Indy credential request schema metadata.

model_class

alias of IndyCredRequest

acapy_agent.indy.models.non_rev_interval module

Indy non-revocation interval.

class acapy_agent.indy.models.non_rev_interval.IndyNonRevocationInterval(fro: int | None = None, to: int | None = None, **kwargs)

Bases: BaseModel

Indy non-revocation interval.

class Meta

Bases: object

NonRevocationInterval metadata.

schema_class = 'IndyNonRevocationIntervalSchema'

covers(timestamp: int | None = None) → bool

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

Parameters:

timestamp – time of interest

Returns:

whether input time satisfies non-revocation interval

timestamp() → bool

Return a timestamp that the non-revocation interval covers.

class acapy_agent.indy.models.non_rev_interval.IndyNonRevocationIntervalSchema(*args: Any, **kwargs: Any)

Bases: BaseModelSchema

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

class Meta

Bases: object

IndyNonRevocationIntervalSchema metadata.

model_class

alias of IndyNonRevocationInterval

acapy_agent.indy.models.predicate module

Utilities for dealing with predicates.

class acapy_agent.indy.models.predicate.Predicate(*values)

Bases: Enum

Enum for predicate types that indy-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

Return enum instance corresponding to input relation string.

property math: str

Mathematical nomenclature.

static to_int(value: Any) → int

Cast a value as its equivalent int for indy 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.indy.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.indy.models.pres_preview module

acapy_agent.indy.models.proof module

Marshmallow bindings for indy proofs.

class acapy_agent.indy.models.proof.IndyEQProof(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)

Bases: BaseModel

Equality proof for indy primary proof.

class Meta

Bases: object

Equality proof metadata.

schema_class = 'IndyEQProofMeta'

class acapy_agent.indy.models.proof.IndyEQProofSchema(*args: Any, **kwargs: Any)

Bases: BaseModelSchema

Indy equality proof schema.

class Meta

Bases: object

Indy equality proof metadata.

model_class

alias of IndyEQProof

class acapy_agent.indy.models.proof.IndyGEProof(u: Mapping[str, str] = None, r: Mapping[str, str] = None, mj: str | None = None, alpha: str | None = None, t: Mapping[str, str] = None, predicate: IndyGEProofPred | None = None, **kwargs)

Bases: BaseModel

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

class Meta

Bases: object

GE proof metadata.

schema_class = 'IndyGEProofMeta'

class acapy_agent.indy.models.proof.IndyGEProofPred(attr_name: str | None = None, p_type: str | None = None, value: int | None = None, **kwargs)

Bases: BaseModel

Indy GE proof predicate.

class Meta

Bases: object

Indy GE proof predicate metadata.

schema_class = 'IndyGEProofPredSchema'

class acapy_agent.indy.models.proof.IndyGEProofPredSchema(*args: Any, **kwargs: Any)

Bases: BaseModelSchema

Indy GE proof predicate schema.

class Meta

Bases: object

Indy GE proof predicate metadata.

model_class

alias of IndyGEProofPred

class acapy_agent.indy.models.proof.IndyGEProofSchema(*args: Any, **kwargs: Any)

Bases: BaseModelSchema

Indy GE proof schema.

class Meta

Bases: object

Indy GE proof schema metadata.

model_class

alias of IndyGEProof

predicate

alias of IndyGEProofPredSchema

class acapy_agent.indy.models.proof.IndyNonRevocProof(x_list: Mapping | None = None, c_list: Mapping | None = None, **kwargs)

Bases: BaseModel

Indy non-revocation proof.

class Meta

Bases: object

Indy non-revocation proof metadata.

schema_class = 'IndyNonRevocProofSchema'

class acapy_agent.indy.models.proof.IndyNonRevocProofSchema(*args: Any, **kwargs: Any)

Bases: BaseModelSchema

Indy non-revocation proof schema.

class Meta

Bases: object

Indy non-revocation proof schema metadata.

model_class

alias of IndyNonRevocProof

class acapy_agent.indy.models.proof.IndyPresSpecSchema(*args: Any, **kwargs: Any)

Bases: AdminAPIMessageTracingSchema

Request schema for indy proof specification to send as presentation.

class acapy_agent.indy.models.proof.IndyPrimaryProof(eq_proof: IndyEQProof | None = None, ge_proofs: Sequence[IndyGEProof] = None, **kwargs)

Bases: BaseModel

Indy primary proof.

class Meta

Bases: object

Indy primary proof metadata.

schema_class = 'IndyPrimaryProofSchema'

class acapy_agent.indy.models.proof.IndyPrimaryProofSchema(*args: Any, **kwargs: Any)

Bases: BaseModelSchema

Indy primary proof schema.

class Meta

Bases: object

Indy primary proof schema metadata.

model_class

alias of IndyPrimaryProof

eq_proof

alias of IndyEQProofSchema

ge_proofs

alias of IndyGEProofSchema

class acapy_agent.indy.models.proof.IndyProof(proof: IndyProofProof | None = None, requested_proof: IndyProofRequestedProof | None = None, identifiers: Sequence[IndyProofIdentifier] = None, **kwargs)

Bases: BaseModel

Indy proof.

class Meta

Bases: object

Indy proof metadata.

schema_class = 'IndyProofSchema'

class acapy_agent.indy.models.proof.IndyProofIdentifier(schema_id: str | None = None, cred_def_id: str | None = None, rev_reg_id: str | None = None, timestamp: int | None = None, **kwargs)

Bases: BaseModel

Indy proof identifier.

class Meta

Bases: object

Indy proof identifier metadata.

schema_class = 'IndyProofIdentifierSchema'

class acapy_agent.indy.models.proof.IndyProofIdentifierSchema(*args: Any, **kwargs: Any)

Bases: BaseModelSchema

Indy proof identifier schema.

class Meta

Bases: object

Indy proof identifier schema metadata.

model_class

alias of IndyProofIdentifier

class acapy_agent.indy.models.proof.IndyProofProof(proofs: Sequence[IndyProofProofProofsProof] = None, aggregated_proof: IndyProofProofAggregatedProof | None = None, **kwargs)

Bases: BaseModel

Indy proof.proof content.

class Meta

Bases: object

Indy proof.proof content metadata.

schema_class = 'IndyProofProofSchema'

class acapy_agent.indy.models.proof.IndyProofProofAggregatedProof(c_hash: str | None = None, c_list: Sequence[Sequence[int]] = None, **kwargs)

Bases: BaseModel

Indy proof.proof aggregated proof.

class Meta

Bases: object

Indy proof.proof aggregated proof metadata.

schema_class = 'IndyProofProofAggregatedProofSchema'

class acapy_agent.indy.models.proof.IndyProofProofAggregatedProofSchema(*args: Any, **kwargs: Any)

Bases: BaseModelSchema

Indy proof.proof aggregated proof schema.

class Meta

Bases: object

Indy proof.proof aggregated proof schema metadata.

model_class

alias of IndyProofProofAggregatedProof

class acapy_agent.indy.models.proof.IndyProofProofProofsProof(primary_proof: IndyPrimaryProof | None = None, non_revoc_proof: IndyNonRevocProof | None = None, **kwargs)

Bases: BaseModel

Indy proof.proof.proofs constituent proof.

class Meta

Bases: object

Indy proof.proof.proofs constituent proof schema.

schema_class = 'IndyProofProofProofsProofSchema'

class acapy_agent.indy.models.proof.IndyProofProofProofsProofSchema(*args: Any, **kwargs: Any)

Bases: BaseModelSchema

Indy proof.proof.proofs constituent proof schema.

class Meta

Bases: object

Indy proof.proof.proofs constituent proof schema metadata.

model_class

alias of IndyProofProofProofsProof

non_revoc_proof

alias of IndyNonRevocProofSchema

primary_proof

alias of IndyPrimaryProofSchema

class acapy_agent.indy.models.proof.IndyProofProofSchema(*args: Any, **kwargs: Any)

Bases: BaseModelSchema

Indy proof.proof content schema.

class Meta

Bases: object

Indy proof.proof content schema metadata.

model_class

alias of IndyProofProof

aggregated_proof

alias of IndyProofProofAggregatedProofSchema

proofs

alias of IndyProofProofProofsProofSchema

class acapy_agent.indy.models.proof.IndyProofRequestedProof(revealed_attrs: Mapping[str, IndyProofRequestedProofRevealedAttr] = None, revealed_attr_groups: Mapping[str, IndyProofRequestedProofRevealedAttrGroup] = None, self_attested_attrs: Mapping | None = None, unrevealed_attrs: Mapping | None = None, predicates: Mapping[str, IndyProofRequestedProofPredicate] = None, **kwargs)

Bases: BaseModel

Indy proof.requested_proof content.

class Meta

Bases: object

Indy proof.requested_proof content metadata.

schema_class = 'IndyProofRequestedProofSchema'

class acapy_agent.indy.models.proof.IndyProofRequestedProofPredicate(sub_proof_index: int | None = None, **kwargs)

Bases: BaseModel

Indy proof requested proof predicate.

class Meta

Bases: object

Indy proof requested proof requested proof predicate metadata.

schema_class = 'IndyProofRequestedProofPredicateSchema'

class acapy_agent.indy.models.proof.IndyProofRequestedProofPredicateSchema(*args: Any, **kwargs: Any)

Bases: BaseModelSchema

Indy proof requested prrof predicate schema.

class Meta

Bases: object

Indy proof requested proof requested proof predicate schema metadata.

model_class

alias of IndyProofRequestedProofPredicate

class acapy_agent.indy.models.proof.IndyProofRequestedProofRevealedAttr(sub_proof_index: int | None = None, **kwargs)

Bases: RawEncoded

Indy proof requested proof revealed attr.

class Meta

Bases: object

Indy proof requested proof revealed attr metadata.

schema_class = 'IndyProofRequestedProofRevealedAttrSchema'

class acapy_agent.indy.models.proof.IndyProofRequestedProofRevealedAttrGroup(sub_proof_index: int | None = None, values: Mapping[str, RawEncoded] = None, **kwargs)

Bases: BaseModel

Indy proof requested proof revealed attr group.

class Meta

Bases: object

Indy proof requested proof revealed attr group metadata.

schema_class = 'IndyProofRequestedProofRevealedAttrGroupSchema'

class acapy_agent.indy.models.proof.IndyProofRequestedProofRevealedAttrGroupSchema(*args: Any, **kwargs: Any)

Bases: BaseModelSchema

Indy proof requested proof revealed attr group schema.

class Meta

Bases: object

Indy proof requested proof revealed attr group schema metadata.

model_class

alias of IndyProofRequestedProofRevealedAttrGroup

class acapy_agent.indy.models.proof.IndyProofRequestedProofRevealedAttrSchema(*args: Any, **kwargs: Any)

Bases: RawEncodedSchema

Indy proof requested proof revealed attr schema.

class Meta

Bases: object

Indy proof requested proof revealed attr schema metadata.

model_class

alias of IndyProofRequestedProofRevealedAttr

class acapy_agent.indy.models.proof.IndyProofRequestedProofSchema(*args: Any, **kwargs: Any)

Bases: BaseModelSchema

Indy proof requested proof schema.

class Meta

Bases: object

Indy proof requested proof schema metadata.

model_class

alias of IndyProofRequestedProof

class acapy_agent.indy.models.proof.IndyProofSchema(*args: Any, **kwargs: Any)

Bases: BaseModelSchema

Indy proof schema.

class Meta

Bases: object

Indy proof schema metadata.

model_class

alias of IndyProof

identifiers

alias of IndyProofIdentifierSchema

proof

alias of IndyProofProofSchema

requested_proof

alias of IndyProofRequestedProofSchema

class acapy_agent.indy.models.proof.RawEncoded(raw: str | None = None, encoded: str | None = None, **kwargs)

Bases: BaseModel

Raw and encoded attribute values.

class Meta

Bases: object

Raw and encoded attribute values metadata.

schema_class = 'RawEncodedSchema'

class acapy_agent.indy.models.proof.RawEncodedSchema(*args: Any, **kwargs: Any)

Bases: BaseModelSchema

Raw and encoded attribute values schema.

class Meta

Bases: object

Raw and encoded attribute values schema metadata.

model_class

alias of RawEncoded

acapy_agent.indy.models.proof_request module

Utilities to deal with indy.

class acapy_agent.indy.models.proof_request.IndyProofReqAttrSpecSchema(*args: Any, **kwargs: Any)

Bases: OpenAPISchema

Schema for attribute specification in indy proof request.

validate_fields(data, **kwargs)

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.indy.models.proof_request.IndyProofReqPredSpecSchema(*args: Any, **kwargs: Any)

Bases: OpenAPISchema

Schema for predicate specification in indy proof request.

class acapy_agent.indy.models.proof_request.IndyProofRequest(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)

Bases: BaseModel

Indy proof request.

class Meta

Bases: object

Indy proof request metadata.

schema_class = 'IndyProofRequestSchema'

class acapy_agent.indy.models.proof_request.IndyProofRequestSchema(*args: Any, **kwargs: Any)

Bases: BaseModelSchema

Schema for indy proof request.

class Meta

Bases: object

Indy proof request schema metadata.

model_class

alias of IndyProofRequest

acapy_agent.indy.models.requested_creds module

Admin routes for presentations.

class acapy_agent.indy.models.requested_creds.IndyRequestedCredsRequestedAttrSchema(*args: Any, **kwargs: Any)

Bases: OpenAPISchema

Schema for requested attributes within indy requested credentials structure.

class acapy_agent.indy.models.requested_creds.IndyRequestedCredsRequestedPredSchema(*args: Any, **kwargs: Any)

Bases: OpenAPISchema

Schema for requested predicates within indy requested credentials structure.

acapy_agent.indy.models.revocation module

Revocation artifacts.

class acapy_agent.indy.models.revocation.IndyRevRegDef(ver: str | None = None, id_: str | None = None, revoc_def_type: str | None = None, tag: str | None = None, cred_def_id: str | None = None, value: IndyRevRegDefValue | None = None)

Bases: BaseModel

Indy revocation registry definition.

class Meta

Bases: object

Model metadata.

schema_class = 'IndyRevRegDefSchema'

class acapy_agent.indy.models.revocation.IndyRevRegDefSchema(*args: Any, **kwargs: Any)

Bases: BaseModelSchema

Indy revocation registry definition schema.

class Meta

Bases: object

Schema metadata.

model_class

alias of IndyRevRegDef

class acapy_agent.indy.models.revocation.IndyRevRegDefValue(issuance_type: str | None = None, max_cred_num: int | None = None, public_keys: IndyRevRegDefValuePublicKeys | None = None, tails_hash: str | None = None, tails_location: str | None = None)

Bases: BaseModel

Indy revocation registry definition value.

class Meta

Bases: object

Model metadata.

schema_class = 'IndyRevRegDefValueSchema'

class acapy_agent.indy.models.revocation.IndyRevRegDefValuePublicKeys(accum_key: IndyRevRegDefValuePublicKeysAccumKey | None = None)

Bases: BaseModel

Indy revocation registry definition value public keys.

class Meta

Bases: object

Model metadata.

schema_class = 'IndyRevRegDefValuePublicKeysSchema'

class acapy_agent.indy.models.revocation.IndyRevRegDefValuePublicKeysAccumKey(z: str | None = None)

Bases: BaseModel

Indy revocation registry definition value public keys accum key.

class Meta

Bases: object

Indy revocation registry definition value public keys accum key metadata.

schema_class = 'IndyRevRegDefValuePublicKeysAccumKeySchema'

class acapy_agent.indy.models.revocation.IndyRevRegDefValuePublicKeysAccumKeySchema(*args: Any, **kwargs: Any)

Bases: BaseModelSchema

Indy revocation registry definition value public keys accum key schema.

class Meta

Bases: object

Schema metadata.

model_class

alias of IndyRevRegDefValuePublicKeysAccumKey

class acapy_agent.indy.models.revocation.IndyRevRegDefValuePublicKeysSchema(*args: Any, **kwargs: Any)

Bases: BaseModelSchema

Indy revocation registry definition value public keys schema.

class Meta

Bases: object

Schema metadata.

model_class

alias of IndyRevRegDefValuePublicKeys

class acapy_agent.indy.models.revocation.IndyRevRegDefValueSchema(*args: Any, **kwargs: Any)

Bases: BaseModelSchema

Indy revocation registry definition value schema.

class Meta

Bases: object

Schema metadata.

model_class

alias of IndyRevRegDefValue

class acapy_agent.indy.models.revocation.IndyRevRegEntry(ver: str | None = None, value: IndyRevRegEntryValue | None = None)

Bases: BaseModel

Indy revocation registry entry.

class Meta

Bases: object

Model metadata.

schema_class = 'IndyRevRegEntrySchema'

class acapy_agent.indy.models.revocation.IndyRevRegEntrySchema(*args: Any, **kwargs: Any)

Bases: BaseModelSchema

Indy revocation registry entry schema.

class Meta

Bases: object

Schema metadata.

model_class

alias of IndyRevRegEntry

class acapy_agent.indy.models.revocation.IndyRevRegEntryValue(prev_accum: str | None = None, accum: str | None = None, revoked: Sequence[int] = None)

Bases: BaseModel

Indy revocation registry entry value.

class Meta

Bases: object

Model metadata.

schema_class = 'IndyRevRegEntryValueSchema'

class acapy_agent.indy.models.revocation.IndyRevRegEntryValueSchema(*args: Any, **kwargs: Any)

Bases: BaseModelSchema

Indy revocation registry entry value schema.

class Meta

Bases: object

Schema metadata.

model_class = 'IndyRevRegEntryValue'

acapy_agent.indy.models.schema module

Schema artifacts.

class acapy_agent.indy.models.schema.SchemaSchema(*args: Any, **kwargs: Any)

Bases: OpenAPISchema

Marshmallow schema for indy schema.

acapy_agent.indy.models.xform module