aries_cloudagent.anoncreds.models package

Submodules

aries_cloudagent.anoncreds.models.anoncreds_cred_def module

Anoncreds cred def OpenAPI validators.

class aries_cloudagent.anoncreds.models.anoncreds_cred_def.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()[source]

Convert to native anoncreds credential definition.

class aries_cloudagent.anoncreds.models.anoncreds_cred_def.CredDefResult(job_id: Optional[str], 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 aries_cloudagent.anoncreds.models.anoncreds_cred_def.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 aries_cloudagent.anoncreds.models.anoncreds_cred_def.CredDefSchema(*args: Any, **kwargs: Any)[source]

Bases: BaseModelSchema

CredDefSchema.

class Meta[source]

Bases: object

CredDefSchema metadata.

model_class

alias of CredDef

class aries_cloudagent.anoncreds.models.anoncreds_cred_def.CredDefState(state: str, credential_definition_id: Optional[str], 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 aries_cloudagent.anoncreds.models.anoncreds_cred_def.CredDefStateSchema(*args: Any, **kwargs: Any)[source]

Bases: BaseModelSchema

CredDefStateSchema.

class Meta[source]

Bases: object

CredDefStateSchema metadata.

model_class

alias of CredDefState

class aries_cloudagent.anoncreds.models.anoncreds_cred_def.CredDefValue(primary: CredDefValuePrimary, revocation: Optional[CredDefValueRevocation] = None, **kwargs)[source]

Bases: BaseModel

Cred def value.

class Meta[source]

Bases: object

CredDefValue metadata.

schema_class = 'CredDefValueSchemaAnoncreds'
class aries_cloudagent.anoncreds.models.anoncreds_cred_def.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 aries_cloudagent.anoncreds.models.anoncreds_cred_def.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 aries_cloudagent.anoncreds.models.anoncreds_cred_def.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 aries_cloudagent.anoncreds.models.anoncreds_cred_def.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 aries_cloudagent.anoncreds.models.anoncreds_cred_def.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 aries_cloudagent.anoncreds.models.anoncreds_cred_def.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 aries_cloudagent.anoncreds.models.anoncreds_cred_def.GetCredDefResultSchema(*args: Any, **kwargs: Any)[source]

Bases: BaseModelSchema

GetCredDefResultSchema.

class Meta[source]

Bases: object

GetCredDefResultSchema metadata.

model_class

alias of GetCredDefResult

aries_cloudagent.anoncreds.models.anoncreds_revocation module

Anoncreds cred def OpenAPI validators.

class aries_cloudagent.anoncreds.models.anoncreds_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 aries_cloudagent.anoncreds.models.anoncreds_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 aries_cloudagent.anoncreds.models.anoncreds_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 aries_cloudagent.anoncreds.models.anoncreds_revocation.GetRevRegDefResultSchema(*args: Any, **kwargs: Any)[source]

Bases: BaseModelSchema

GetRevRegDefResultSchema.

class Meta[source]

Bases: object

GetRevRegDefResultSchema metadata.

model_class

alias of GetRevRegDefResult

class aries_cloudagent.anoncreds.models.anoncreds_revocation.RevList(issuer_id: str, rev_reg_def_id: str, revocation_list: List[int], current_accumulator: str, timestamp: Optional[int] = 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()[source]

Convert to native revocation list.

class aries_cloudagent.anoncreds.models.anoncreds_revocation.RevListResult(job_id: Optional[str], 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

Rev reg def id.

class aries_cloudagent.anoncreds.models.anoncreds_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 aries_cloudagent.anoncreds.models.anoncreds_revocation.RevListSchema(*args: Any, **kwargs: Any)[source]

Bases: BaseModelSchema

RevListSchema.

class Meta[source]

Bases: object

RevListSchema metadata.

model_class

alias of RevList

class aries_cloudagent.anoncreds.models.anoncreds_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 aries_cloudagent.anoncreds.models.anoncreds_revocation.RevListStateSchema(*args: Any, **kwargs: Any)[source]

Bases: BaseModelSchema

RevListStateSchema.

class Meta[source]

Bases: object

RevListStateSchema metadata.

model_class

alias of RevListState

class aries_cloudagent.anoncreds.models.anoncreds_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()[source]

Convert to native anoncreds revocation registry definition.

class aries_cloudagent.anoncreds.models.anoncreds_revocation.RevRegDefResult(job_id: Optional[str], 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

Revocation Registry Definition.

property rev_reg_def_id

Revocation Registry Definition ID.

class aries_cloudagent.anoncreds.models.anoncreds_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 aries_cloudagent.anoncreds.models.anoncreds_revocation.RevRegDefSchema(*args: Any, **kwargs: Any)[source]

Bases: BaseModelSchema

RevRegDefSchema.

class Meta[source]

Bases: object

RevRegDefSchema metadata.

model_class

alias of RevRegDef

class aries_cloudagent.anoncreds.models.anoncreds_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 aries_cloudagent.anoncreds.models.anoncreds_revocation.RevRegDefStateSchema(*args: Any, **kwargs: Any)[source]

Bases: BaseModelSchema

RevRegDefStateSchema.

class Meta[source]

Bases: object

RevRegDefStateSchema metadata.

model_class

alias of RevRegDefState

class aries_cloudagent.anoncreds.models.anoncreds_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 aries_cloudagent.anoncreds.models.anoncreds_revocation.RevRegDefValueSchema(*args: Any, **kwargs: Any)[source]

Bases: BaseModelSchema

RevRegDefValue schema.

class Meta[source]

Bases: object

RevRegDefValueSchema metadata.

model_class

alias of RevRegDefValue

aries_cloudagent.anoncreds.models.anoncreds_schema module

Anoncreds Schema OpenAPI validators.

class aries_cloudagent.anoncreds.models.anoncreds_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()[source]

Convert to native object.

class aries_cloudagent.anoncreds.models.anoncreds_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 aries_cloudagent.anoncreds.models.anoncreds_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 aries_cloudagent.anoncreds.models.anoncreds_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 aries_cloudagent.anoncreds.models.anoncreds_schema.SchemaResult(job_id: Optional[str], schema_state: SchemaState, registration_metadata: Optional[dict] = None, schema_metadata: Optional[dict] = None, **kwargs)[source]

Bases: BaseModel

Result of registering a schema.

class Meta[source]

Bases: object

SchemaResult metadata.

schema_class = 'SchemaResultSchema'
class aries_cloudagent.anoncreds.models.anoncreds_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 aries_cloudagent.anoncreds.models.anoncreds_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 aries_cloudagent.anoncreds.models.anoncreds_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