etiCORE logo
API docs by Redocly

(((eTicket Security Hub media management interface (1.0.0-rc.1)

Download OpenAPI specification:

License: etiCORE terms of use

Interface of the (((eTicket Security Hub for media management

media-individualisation

interface parts for media individualisation

Import the individualisation data for a single medium.

Authorizations:
MutualTLS
header Parameters
X-ClientId
required
string <uuid>
Example: 1ac81b4a-c810-4f0b-9cab-437408abb82b

Client identifier. To be set universally uniquely per client.

X-MessageNumber
required
integer <int64> >= 0
Example: 7

Number identifying the message uniquely together with the ClientId. Required for message recovery purposes. Useful for logging/investigative purposes.

Request Body schema: application/json
individualisationArchive
required
string <byte>

A ZIP file containing a single individualisation response file containing data for a single SAM or User Medium.

Responses

Request samples

Content type
application/json
{
  • "individualisationArchive": "string"
}

Response samples

Content type
application/json
{
  • "result": "OK"
}

media-configuration

interface parts for media configuration

Get the medium type for the given app instance ID

Authorizations:
MutualTLS
path Parameters
appInstanceId
required
string <byte> (AppInstanceId)
Example: ZA1NAhOIgAETggQAAAAB

App instance ID. DER-encoded including tag and length, afterwards base64-encoded and url-encoded.

Responses

Response samples

Content type
application/json
Example
"CHIPCARD_UM_FULL"

Get the list of organisations this TSP has permission to configure SAMs for

Authorizations:
MutualTLS

Responses

Response samples

Content type
application/json
[
  • 193,
  • 205
]

Get the list of medium types this TSP has permission to configure

Authorizations:
MutualTLS
path Parameters
ownerId
required
integer (OrganisationId)
Example: 318

Org ID of the owner organisation

Responses

Response samples

Content type
application/json
[
  • "vSAM_FULL",
  • "vSAM_STATIC_ENTITLEMENTS"
]

Get the product issuance rights (as a list of org IDs) that the given org ID (owner ID) has granted the TSP the permission to use

Authorizations:
MutualTLS
path Parameters
ownerId
required
integer (OrganisationId)
Example: 318

Org ID of the owner organisation

mediumType
required
string (MediumType)
Enum: "CHIPCARD_SAM_FULL" "CHIPCARD_UM_FULL" "vSAM_STATIC_ENTITLEMENTS" "vSAM_FULL" "SAM_LITE_APP" "CHIPCARD_UM_LIMITED"
Example: vSAM_FULL

The type of the medium

Responses

Response samples

Content type
application/json

The client organisation has product issuance rights for the organisation IDs 123, 438, and 538.

[
  • 123,
  • 438,
  • 538
]

Get the SAM activation rights that the given org ID (owner ID) has granted the TSP the permission to use

Authorizations:
MutualTLS
path Parameters
ownerId
required
integer (OrganisationId)
Example: 318

Org ID of the owner organisation

mediumType
required
string (MediumType)
Enum: "CHIPCARD_SAM_FULL" "CHIPCARD_UM_FULL" "vSAM_STATIC_ENTITLEMENTS" "vSAM_FULL" "SAM_LITE_APP" "CHIPCARD_UM_LIMITED"
Example: vSAM_FULL

The type of the medium

Responses

Response samples

Content type
application/json

There are two sam activation rights, both for the org ID 123. One is for ecdsa-with-sha256 without an accessToken. The other is for ecdsa-with-sha384 with the access token 0xC0FFEE.

[
  • {
    },
  • {
    }
]

For a single medium, get the information required to initiate the single update and config process.

Authorizations:
MutualTLS
path Parameters
ownerId
required
integer (OrganisationId)
Example: 318

Org ID of the owner organisation

appInstanceId
required
string <byte> (AppInstanceId)
Example: ZA1NAhOIgAETggQAAAAB

App instance ID. DER-encoded including tag and length, afterwards base64-encoded and url-encoded.

Responses

Response samples

Content type
application/json
{
  • "adminCertificateChain": [
    ],
  • "challengeLength": 16
}

For a single medium, perform an optional update and a subsequent configuration.

The optionality of the request body parameters depends on the subject role as follows:

parameter name SAM_FULL SAM_STE SAM_LIMITED UM_FULL UM_LIMITED
validityData Optional Optional Required Required Required
productIssuanceRights Required Required Not allowed Not allowed Not allowed
samActivationRights Required Required Not allowed Not allowed Not allowed
passwordParameters Not allowed Not allowed Not allowed Optional Not allowed
Authorizations:
MutualTLS
path Parameters
ownerId
required
integer (OrganisationId)
Example: 318

Org ID of the owner organisation

appInstanceId
required
string <byte> (AppInstanceId)
Example: ZA1NAhOIgAETggQAAAAB

App instance ID. DER-encoded including tag and length, afterwards base64-encoded and url-encoded.

header Parameters
If-Match
required
string
Example: bfc13a64729c4290ef5b2c2730249c88ca92d82d

HTTP standard header If-Match

X-ClientId
required
string <uuid>
Example: 1ac81b4a-c810-4f0b-9cab-437408abb82b

Client identifier. To be set universally uniquely per client.

X-MessageNumber
required
integer <int64> >= 0
Example: 7

Number identifying the message uniquely together with the ClientId. Required for message recovery purposes. Useful for logging/investigative purposes.

Request Body schema: application/json
configurationRequestId
required
string

Identifier for the configuration request. The required syntax is described in 2.6.1.1 of the MMS Spec.

ownerEticoreRole
required
integer

The etiCORE role of the organisation identified by the OwnerID.

rndMedium
required
string <byte>

The random from the medium.

epukMedium
required
string <byte>

The ephemeral public key from the medium as a PublicKeyParameters structure.

object (ValidityData)

Validity data to use to retrieve certificates. If absent, no new certificates will be fetched. If the SAM in question does not have a set of certificates yet, this field MUST be present. Otherwise, it this field may be left absent to keep using the current set of certificates.

productIssuanceRights
Array of integers

List of organisation IDs the SAM shall receive product issuance rights for. If the subjectRole shows anything else than SAM_FULL or SAM_STE, this list MUST be empty.

Array of objects (SamActivationRight)

List of SAM activation rights. If the subjectRole shows anything else than SAM_FULL or SAM_STE, this list MUST be empty.

object (PasswordParameters)

The password parameters to use. Only allowed for UM_FULL.

Responses

Request samples

Content type
application/json

TSP org ID is 249. Owner org ID is 318, owner role is CCP (1). 16 byte challenge. Ephemeral public key on SECP384R1 matching the admin key. Product issuance rights for org IDs 123 and 234. SAM activation rights for ecdsa-with-sha256 without access token and ecdsa-with-sha384 with access token 0xC0FFEE

{
  • "configurationRequestId": "C-SAM_FULL.STAGING-249-20250703-1",
  • "ownerEticoreRole": 1,
  • "rndMedium": "irUTHQQsnytdNyYNlpyABw==",
  • "epukMedium": "f0lqBgUrgQQAIoZhBL55zY7bDrHCM36Q1e+Y/iXHbxvD8LuYYmUtvANCk6BCGYuO0SHXEck8H+HtIeXAFgAS0rq2NBWlwdEnTBnbiptE4d6Mlv0EKNvBArEGXmq/PhGhLbH4Ap8vh4RsJrnKkw==",
  • "validityData": {
    },
  • "productIssuanceRights": [
    ],
  • "samActivationRights": [
    ]
}

Response samples

Content type
application/json
{
  • "configurationCommandScript": "MIIJvlKCATkAKgC+AAEyf06BxH8gE00CE4iAAQeBCkVUUy1TVUItMDF/TBBNAhOIoAoGCCqGSM49BAMDXyUEX8WHgF8kBHKVfv9iFE0CE4iAAQOBC0VUUy1ST09ULTAxf0lqBgUrgQQAIoZhBKFJlVB8hAWrxvBsFy/y974Epnp/VCAeOEfMdLVoEof0HnGX7mWiUoAYqgrgKZtMHvmqDPbPNvnLIG+wZ/8g4sUcnhk/vC/6KL4HtnLtLDwDBGJGNalWc53mqZA9FZlT5QYIKoZIzj0EAwNfN2cwZQIwEq1vEV+RNGbJYMlIcWa8l0iNsiHXDSf4zqoz3MrQDuGtNQciOj/PoFezFobG2RunAjEAlNdpIT35zAgwdzShoLyplWJfZCOx5GjC6Yv8jxaq9JYW6aY0HCwCz3ETccGVIz9bUoIBLgAqAL4AASd/ToG6fyANTQIV44ABC4IEAAEAA39MDU0CE4igBwYFK4EEAQxfJQRm+zuAXyQEar2if2ITTQITiIABB4EKRVRTLVNVQi0wMX9JagYFK4EEACKGYQSvoGt2famnjMx09FtFKuolF9QM7dMK+IaslErA4qqfEF5YmMBrKv+FTonTk/9vxyOEaGw5by9PJLMPsc8h9J1w/2OQ/1VmvwmDTtZg1a3tzfSJ1xsCVZNQeesNL7WSIQIGCCqGSM49BAMDXzdmMGQCMG4ulycwQHjdMIT5kbj7Ph4Zqz9wnOSbXWyTos+yGMJZVT2Rf48vqOjy6hGqum7pgwIwG5croPcg5lfXA2mlWjooSFV4PhLYJCcvt9DVN25AiTvGwXmMTqxxiIDaxCz1byvZUoGPgAISAop/SWoGBSuBBAAihmEEHPBBAn9+rpdquOfw+w/Kgi3jgDVPYUaVjDxnFE5LGfrSKs1v1VHNlauwEVb8Il40twnAKUl4IPESXSjO80FCAD8xHtyR7HaB1GBssqsOLw889SkL/JfwprDFi+QOO36PBglghkgBZQMEASqAELSSwFPWWYct/NUre401Q99SggSuDNp/IwAEp4eCBJEB1TbQHqxuOBxftYxu5NMaLwSfvk2qDC/lpU1aY3YGlCT86Zibto2fNpmXv9E5cs+r5ImUjkUShEkyp2uyprXJqaDJ8jULGC3TD5utYA5+0sGRAQZVWMjUC7l5p/BkvkpC2TO3DN9GdY4TZ2ybd42JARClZVxZctF0kIgq9BPaFdvMf2RuVpDZv+lmd0Vz7/LWytORU8jPj6MhJ4ENn0cv1B3EuKt0esG0WsR29EDCEf75rSA8YTUPytnPhhILyYKHuLO8E1ndS2CTA1fWCEaifzKXuq4CdiX9qs1WnOcd7lqmpaj59Fr5tjKxcfFVa3+WeB57SFHlQjk0D3bnbsi0khf9qvUgbspgQcA6iEsmhBnCib3rD0MXx/8PowSzyFhNPW200dogt2TaGdAMPsbI/L37eUpzpbNKQW48jypLTojuA9mslLTR8R0a6YDb59d91BikuL8xNQL4UkG9ogPSxc20LzFZbtYD4UlkReKoCrO1Uu66YrvxHohQMIZHlZ8lVSFbcwryY8xVebCy0oWeDwieUUvZDuI3oFlmunBkRgwek2nOvBGP8HilN2r9pzwqTPZ9jBb0EI06mNwzFtW37OpKrGFB70P9MUueFl50zqDoxF8yfk59HvAuRq7jMl/10D1ZNmk7B0TGanJjdODIyKiHteIFa9Pc80Rwsdul7zrkXgh7d8EFDrUtOTVNliKVFfSx+uN6LtIRX90XNg9dIgnuAdpt4tJyP7AfUAfP3CnbTc5p3VfzClQ0J1Ake7P9fwDrAFsvQqg+ffWeYpDuwTTrrMQJU+aalCzGZGxdSFaCmUEmJ+Q/MiRVAXUlq8zLVpZaVMX9T6rlQk9efewGEcgjfFlE79dtI8LDzh2q6iaOjRAFqoTQT8OVtTnw13DvuUJ3VhOCpYJfQkSmdU5ljMpR09bip9mvK4CwE821qQx6nkGkiUlOj1O4xPX0wmnlqsqi/YfEwb/cuk00CjQ56U/jvPRpU5FlmHEI1tdBSHHJs0xvxPGpLXlxGrrq/pWDAMeFSXOzGOMhW0LK0QnKNPisCSTVJGxBlDO95QEl/kfcnpL3JSnNEsXUExe3ancSp1EYSBrstxfJ87oT7+NsO3borGYelxYAGtpg8fBHWy1yfJtqoTy6a4jGEP+ww9ylAhVKRFX2IarSSQlSC+kWOpjiyRCaCy8ffiPeZbZdnO1YNcFbK3FjJgeJueGHwegZTiSIpPr1zP9WnM0KzVnlfsM0dpIxr6F34ScsK0b9jdCO8Yh75hL4VCVHpZIRu2JYeEN7qdcKCSZYMF96TumQtQnfRz5/A25yWJWOTcAnUB+mwUQ8rSHHSy/tv2J9vqOblyMOBkzGqcoEp3ZMIt/sTd8TKHdkPKkFxdeTG80KVTlbWOJp7gR0UKH1WKUKGaoNHv+qcGpdL4GAGmfXgtxDljS7s+DBE1Flru0G2nYhNLkbKbgVS84F+/o8yFHEQoTU8Flda2vBCiBtrbh/504JiFaSvgEbEacLzlcaLzgLeseE9v0oMqPii5Xm0g1xnu7BgNTMOoXkOXgzpq4wDcaI6I4Qo6vO4xeCcN/iUBFkLraeR1IqDNoATSWHEQEQyp9wO61uM55qGJK8WoZnjhBtWhLfgkiqeEU1Q86bwbVNUjoM2n8oNYchAWBVszfQbuS8P6k7yI4wFZxrh2x3zOj3XO1s6TVUSzm6jhAyxDpL6xAG7wUzba+lXOGKUnoM2n84dYdhAd+GOggwV2V7X9V86zH4ZofttiOfEob2kpIjencUiHVq6mxmLqQJHGJEq5rMjkS4vk/y/OnmZMVHIJCGKysxaxHdBQ8eMsIwVZh+HVrRjXhTx9ozmubsXQj6OknkvhzWao4QnzmxeJ7lQaTYhRoshWmgQlKBywzafyvGh4GxATNDYFIezOUCQXNZ/nehsFiD+yiD1tFihIzJTPTjjVtBouBZ7znMnONDVR9EZ5Q5eN6TsB1V+nPFdQtTIueWPorKPAxI0uTWus6j3uFa4XTtxNPpSq2+6E1G10MHbnQWDX+2oLW6bAZYXJfGsC9vtfETeoDHXsgfjADOnwGTtmm9rB7NC8nY0TqEQlwvHAM5peMk5tgacl1S8o9pYuym8irECtgLkuNoN4B+SRAmYcPMjhDf1PMgg1wltZx3VCUOW21OUjoM2n8pNYchAWozeucSbcDQXmbOxgeDqVY1fJ8l0mpjQB/Y1OVWgdfPjhB+sVXYXIaKFn3rNFJYvy/fUhuMBgAAFl8uAQGOEILGDAGpag6hUA/xrIZMa5o="
}