GET 
/did-registry/v3/hash-algorithms/:hashAlgorithmId

Returns a hash algorithm based on its ID.

Request

Path Parameters

hashAlgorithmId stringrequired
Example: 1

Responses

200

Success

application/json

Schema

Schema

outputLengthBits number

Hash algorithm output length in bits. 0 if the output length if variable.

ianaName string

Hash algorithm IANA name.

oid string

Object identifier.

status string

Status of the algorithm (active, revoked).

multihash string

Multihash name

Example (from schema)

{
  "outputLengthBits": 0,
  "ianaName": "string",
  "oid": "string",
  "status": "string",
  "multihash": "string"
}

Success

{
  "outputLengthBits": 256,
  "ianaName": "sha-256",
  "oid": "2.16.840.1.101.3.4.2.1",
  "status": "active",
  "multihash": "sha2-256"
}

400

Bad Request

application/problem+json

Schema

Schema

type uri

Default value: about:blank

An absolute URI that identifies the problem type. When dereferenced, it SHOULD provide human-readable documentation for the problem type.

title string

A short summary of the problem type.

status int32

Possible values: >= 400 and <= 600

The HTTP status code generated by the origin server for this occurrence of the problem.

detail string

A human readable explanation specific to this occurrence of the problem.

instance uri

An absolute URI that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

Example (from schema)

{
  "type": "about:blank",
  "title": "Internal Server Error",
  "status": 500,
  "detail": "Connection timeout",
  "instance": "string"
}

Invalid {hashAlgorithmId} Parameter

{
  "title": "Bad Request",
  "status": 400,
  "detail": "The format of {hashAlgorithmId} parameter is not valid"
}

404

Not found

application/problem+json

Schema

Schema

type uri

Default value: about:blank

An absolute URI that identifies the problem type. When dereferenced, it SHOULD provide human-readable documentation for the problem type.

title string

A short summary of the problem type.

status int32

Possible values: >= 400 and <= 600

The HTTP status code generated by the origin server for this occurrence of the problem.

detail string

A human readable explanation specific to this occurrence of the problem.

instance uri

An absolute URI that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

Example (from schema)

{
  "type": "about:blank",
  "title": "Internal Server Error",
  "status": 500,
  "detail": "Connection timeout",
  "instance": "string"
}

Hash algorithm Not Found

{
  "title": "Not found",
  "status": 404,
  "detail": "Not found"
}

500

Internal Server Error

application/json

Schema

Schema

type uri

Default value: about:blank

An absolute URI that identifies the problem type. When dereferenced, it SHOULD provide human-readable documentation for the problem type.

title string

A short summary of the problem type.

status int32

Possible values: >= 400 and <= 600

The HTTP status code generated by the origin server for this occurrence of the problem.

detail string

A human readable explanation specific to this occurrence of the problem.

instance uri

An absolute URI that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

Example (from schema)

{
  "type": "about:blank",
  "title": "Internal Server Error",
  "status": 500,
  "detail": "Connection timeout",
  "instance": "string"
}

Internal Server Error

{
  "title": "Internal error",
  "status": 500,
  "detail": "Internal error"
}

Loading...