Key Manager REST Interface: (GET) /objects

Purpose

This operation is called to query for managed objects at the Key Manager.

Interface

Key Manager REST Interface (siehe [IF_KM])

Method of use

The operation is called by a client software according to the specification as a GET method on the Key Manager REST interface (see [IF_KM]).

authorization

String

ID token in the format: "Bearer: MII..."

return

Object

Specify fields to be returned for managed objects that are found. If this parameter is omitted, all fields of the managed objects will be returned.

Usage: return=id&return=value&return=attributes&return=activation

id

String

Object identifier for the management object to be filtered by

state

String

Status of the managed objects to be filtered by

Possible values: PRE_ACTIVE, ACTIVE, DEACTIVATED, COMPROMISED, DESTROYED, DESTROYED_COMPROMISED

objecttype

String

Object type of the management object to be filtered by

Possible values: CERTIFICATE, CERTIFICATE_REQUEST, OPAQUE_OBJECT, PGP_KEY, PRIVATE_KEY, PUBLIC_KEY, SECRET_DATA, SPLIT_KEY, SYMMETRIC_KEY, X_USER, X_USER_GROUP

attribute- params

Attributes

Attributes as query parameters for filtering

Usage: $AttributeName;$QueryExpression=$filtervalue

Output

Type

Description

200

Successfull response

{"id":"string","value":"string","objecttype":"string","state":"string"," attributes":{"comment":"string","name":[string]},"dateattributes

{"activation":"string","not-after":"string"}}

Error messages

Type

Reason

400

Invalid request

{"type": "string", "title": "string", "detail": "string", "instance": "string", "status": "string", "additionalData": {}}

401

Unauthorized access to the resource

{"type": "string", "title": "string", "detail": "string", "instance": "string", "status": "string", "additionalData": {}}

403

Access to the resource forbidden

{"type": "string", "title": "string", "detail": "string", "instance": "string", "status": "string", "additionalData": {}}

500

Internal server error

{"type": "string", "title": "string", "detail": "string", "instance": "string", "status": "string", "additionalData": {}}