aries_cloudagent.holder package¶

Submodules¶

aries_cloudagent.holder.routes module¶

Holder admin routes.

class aries_cloudagent.holder.routes.AttributeMimeTypesResultSchema(*args, **kwargs)[source]¶

Bases: aries_cloudagent.messaging.models.openapi.OpenAPISchema

Result schema for credential attribute MIME type.

results = <fields.Dict(default=<marshmallow.missing>, attribute=None, validate=None, required=False, load_only=False, dump_only=False, missing=<marshmallow.missing>, allow_none=True, error_messages={'required': 'Missing data for required field.', 'null': 'Field may not be null.', 'validator_failed': 'Invalid value.', 'invalid': 'Not a valid mapping type.'})>¶

class aries_cloudagent.holder.routes.CredInfoListSchema(*args, **kwargs)[source]¶

Bases: aries_cloudagent.messaging.models.openapi.OpenAPISchema

Result schema for credential query.

results = <fields.List(default=<marshmallow.missing>, attribute=None, validate=None, required=False, load_only=False, dump_only=False, missing=<marshmallow.missing>, allow_none=False, error_messages={'required': 'Missing data for required field.', 'null': 'Field may not be null.', 'validator_failed': 'Invalid value.', 'invalid': 'Not a valid list.'})>¶

class aries_cloudagent.holder.routes.CredRevokedQueryStringSchema(*args, **kwargs)[source]¶

Bases: aries_cloudagent.messaging.models.openapi.OpenAPISchema

Path parameters and validators for request seeking cred revocation status.

fro = <fields.String(default=<marshmallow.missing>, attribute=None, validate=<aries_cloudagent.messaging.valid.NumericStrWhole object>, required=False, load_only=False, dump_only=False, missing=<marshmallow.missing>, allow_none=False, error_messages={'required': 'Missing data for required field.', 'null': 'Field may not be null.', 'validator_failed': 'Invalid value.', 'invalid': 'Not a valid string.', 'invalid_utf8': 'Not a valid utf-8 string.'})>¶

to = <fields.String(default=<marshmallow.missing>, attribute=None, validate=<aries_cloudagent.messaging.valid.NumericStrWhole object>, required=False, load_only=False, dump_only=False, missing=<marshmallow.missing>, allow_none=False, error_messages={'required': 'Missing data for required field.', 'null': 'Field may not be null.', 'validator_failed': 'Invalid value.', 'invalid': 'Not a valid string.', 'invalid_utf8': 'Not a valid utf-8 string.'})>¶

class aries_cloudagent.holder.routes.CredRevokedResultSchema(*args, **kwargs)[source]¶

Bases: aries_cloudagent.messaging.models.openapi.OpenAPISchema

Result schema for credential revoked request.

revoked = <fields.Boolean(default=<marshmallow.missing>, attribute=None, validate=None, required=False, load_only=False, dump_only=False, missing=<marshmallow.missing>, allow_none=False, error_messages={'required': 'Missing data for required field.', 'null': 'Field may not be null.', 'validator_failed': 'Invalid value.', 'invalid': 'Not a valid boolean.'})>¶

class aries_cloudagent.holder.routes.CredentialsListQueryStringSchema(*args, **kwargs)[source]¶

Bases: aries_cloudagent.messaging.models.openapi.OpenAPISchema

Parameters and validators for query string in credentials list query.

count = <fields.String(default=<marshmallow.missing>, attribute=None, validate=<aries_cloudagent.messaging.valid.NumericStrNatural object>, required=False, load_only=False, dump_only=False, missing=<marshmallow.missing>, allow_none=False, error_messages={'required': 'Missing data for required field.', 'null': 'Field may not be null.', 'validator_failed': 'Invalid value.', 'invalid': 'Not a valid string.', 'invalid_utf8': 'Not a valid utf-8 string.'})>¶

start = <fields.String(default=<marshmallow.missing>, attribute=None, validate=<aries_cloudagent.messaging.valid.NumericStrWhole object>, required=False, load_only=False, dump_only=False, missing=<marshmallow.missing>, allow_none=False, error_messages={'required': 'Missing data for required field.', 'null': 'Field may not be null.', 'validator_failed': 'Invalid value.', 'invalid': 'Not a valid string.', 'invalid_utf8': 'Not a valid utf-8 string.'})>¶

wql = <fields.String(default=<marshmallow.missing>, attribute=None, validate=<aries_cloudagent.messaging.valid.IndyWQL object>, required=False, load_only=False, dump_only=False, missing=<marshmallow.missing>, allow_none=False, error_messages={'required': 'Missing data for required field.', 'null': 'Field may not be null.', 'validator_failed': 'Invalid value.', 'invalid': 'Not a valid string.', 'invalid_utf8': 'Not a valid utf-8 string.'})>¶

class aries_cloudagent.holder.routes.HolderCredIdMatchInfoSchema(*args, **kwargs)[source]¶

Bases: aries_cloudagent.messaging.models.openapi.OpenAPISchema

Path parameters and validators for request taking credential id.

credential_id = <fields.String(default=<marshmallow.missing>, attribute=None, validate=None, required=True, load_only=False, dump_only=False, missing=<marshmallow.missing>, allow_none=False, error_messages={'required': 'Missing data for required field.', 'null': 'Field may not be null.', 'validator_failed': 'Invalid value.', 'invalid': 'Not a valid string.', 'invalid_utf8': 'Not a valid utf-8 string.'})>¶

class aries_cloudagent.holder.routes.HolderModuleResponseSchema(*args, **kwargs)[source]¶

Bases: aries_cloudagent.messaging.models.openapi.OpenAPISchema

Response schema for Holder Module.

class aries_cloudagent.holder.routes.VCRecordListSchema(*args, **kwargs)[source]¶

Bases: aries_cloudagent.messaging.models.openapi.OpenAPISchema

Result schema for W3C credential query.

results = <fields.List(default=<marshmallow.missing>, attribute=None, validate=None, required=False, load_only=False, dump_only=False, missing=<marshmallow.missing>, allow_none=False, error_messages={'required': 'Missing data for required field.', 'null': 'Field may not be null.', 'validator_failed': 'Invalid value.', 'invalid': 'Not a valid list.'})>¶

class aries_cloudagent.holder.routes.W3CCredentialsListRequestSchema(*args, **kwargs)[source]¶

Bases: aries_cloudagent.messaging.models.openapi.OpenAPISchema

Parameters and validators for W3C credentials request.

contexts = <fields.List(default=<marshmallow.missing>, attribute=None, validate=None, required=False, load_only=False, dump_only=False, missing=<marshmallow.missing>, allow_none=False, error_messages={'required': 'Missing data for required field.', 'null': 'Field may not be null.', 'validator_failed': 'Invalid value.', 'invalid': 'Not a valid list.'})>¶

given_id = <fields.String(default=<marshmallow.missing>, attribute=None, validate=None, required=False, load_only=False, dump_only=False, missing=<marshmallow.missing>, allow_none=False, error_messages={'required': 'Missing data for required field.', 'null': 'Field may not be null.', 'validator_failed': 'Invalid value.', 'invalid': 'Not a valid string.', 'invalid_utf8': 'Not a valid utf-8 string.'})>¶

issuer_id = <fields.String(default=<marshmallow.missing>, attribute=None, validate=None, required=False, load_only=False, dump_only=False, missing=<marshmallow.missing>, allow_none=False, error_messages={'required': 'Missing data for required field.', 'null': 'Field may not be null.', 'validator_failed': 'Invalid value.', 'invalid': 'Not a valid string.', 'invalid_utf8': 'Not a valid utf-8 string.'})>¶

max_results = <fields.Integer(default=<marshmallow.missing>, attribute=None, validate=None, required=False, load_only=False, dump_only=False, missing=<marshmallow.missing>, allow_none=False, error_messages={'required': 'Missing data for required field.', 'null': 'Field may not be null.', 'validator_failed': 'Invalid value.', 'invalid': 'Not a valid integer.', 'too_large': 'Number too large.'})>¶

proof_types = <fields.List(default=<marshmallow.missing>, attribute=None, validate=None, required=False, load_only=False, dump_only=False, missing=<marshmallow.missing>, allow_none=False, error_messages={'required': 'Missing data for required field.', 'null': 'Field may not be null.', 'validator_failed': 'Invalid value.', 'invalid': 'Not a valid list.'})>¶

schema_ids = <fields.List(default=<marshmallow.missing>, attribute=None, validate=None, required=False, load_only=False, dump_only=False, missing=<marshmallow.missing>, allow_none=False, error_messages={'required': 'Missing data for required field.', 'null': 'Field may not be null.', 'validator_failed': 'Invalid value.', 'invalid': 'Not a valid list.'})>¶

subject_ids = <fields.List(default=<marshmallow.missing>, attribute=None, validate=None, required=False, load_only=False, dump_only=False, missing=<marshmallow.missing>, allow_none=False, error_messages={'required': 'Missing data for required field.', 'null': 'Field may not be null.', 'validator_failed': 'Invalid value.', 'invalid': 'Not a valid list.'})>¶

tag_query = <fields.Dict(default=<marshmallow.missing>, attribute=None, validate=None, required=False, load_only=False, dump_only=False, missing=<marshmallow.missing>, allow_none=False, error_messages={'required': 'Missing data for required field.', 'null': 'Field may not be null.', 'validator_failed': 'Invalid value.', 'invalid': 'Not a valid mapping type.'})>¶

types = <fields.List(default=<marshmallow.missing>, attribute=None, validate=None, required=False, load_only=False, dump_only=False, missing=<marshmallow.missing>, allow_none=False, error_messages={'required': 'Missing data for required field.', 'null': 'Field may not be null.', 'validator_failed': 'Invalid value.', 'invalid': 'Not a valid list.'})>¶

aries_cloudagent.holder.routes.credentials_attr_mime_types_get(request: <sphinx.ext.autodoc.importer._MockObject object at 0x7fb054fa8050>)[source]¶

Request handler for getting credential attribute MIME types.

Parameters:	request – aiohttp request object
Returns:	The MIME types response

aries_cloudagent.holder.routes.credentials_get(request: <sphinx.ext.autodoc.importer._MockObject object at 0x7fb054fa8050>)[source]¶

Request handler for retrieving credential.

Parameters:	request – aiohttp request object
Returns:	The credential info

aries_cloudagent.holder.routes.credentials_list(request: <sphinx.ext.autodoc.importer._MockObject object at 0x7fb054fa8050>)[source]¶

Request handler for searching credential records.

Parameters:	request – aiohttp request object
Returns:	The credential info list response

aries_cloudagent.holder.routes.credentials_remove(request: <sphinx.ext.autodoc.importer._MockObject object at 0x7fb054fa8050>)[source]¶

Request handler for searching connection records.

Parameters:	request – aiohttp request object
Returns:	Empty production

aries_cloudagent.holder.routes.credentials_revoked(request: <sphinx.ext.autodoc.importer._MockObject object at 0x7fb054fa8050>)[source]¶

Request handler for querying revocation status of credential.

Parameters:	request – aiohttp request object
Returns:	Empty production

aries_cloudagent.holder.routes.post_process_routes(app: <sphinx.ext.autodoc.importer._MockObject object at 0x7fb054fa8050>)[source]¶: Amend swagger API.

aries_cloudagent.holder.routes.register(app: <sphinx.ext.autodoc.importer._MockObject object at 0x7fb054fa8050>)[source]¶: Register routes.

aries_cloudagent.holder.routes.w3c_cred_get(request: <sphinx.ext.autodoc.importer._MockObject object at 0x7fb054fa8050>)[source]¶

Request handler for retrieving W3C credential.

Parameters:	request – aiohttp request object
Returns:	Verifiable credential record

aries_cloudagent.holder.routes.w3c_cred_remove(request: <sphinx.ext.autodoc.importer._MockObject object at 0x7fb054fa8050>)[source]¶

Request handler for deleting W3C credential.

Parameters:	request – aiohttp request object
Returns:	Empty production

aries_cloudagent.holder.routes.w3c_creds_list(request: <sphinx.ext.autodoc.importer._MockObject object at 0x7fb054fa8050>)[source]¶

Request handler for searching W3C credential records.

Parameters:	request – aiohttp request object
Returns:	The credential record list response