v1

latestOpenAPI 3.0.12026-08-06106119306.5 KB
/organizations/{organizationId}/devices/smart-cards

Update smart card partially

patch/api/v1/organizations/{organizationId}/devices/smart-cards/{deviceId}

Path parameters

organizationIdinteger required

Organization ID

deviceIdinteger required

Smart card ID

Request body

op0 | 1 | 2 required

0 = Add, 1 = Remove, 2 = Replace

pathstring required
valueobject nullable

Response

OK

idinteger required
deviceHexIdstring required
organizationIdinteger nullable
type1 | 2 | 3 required

1 = Browser, 2 = Smartphone, 3 = SmartCard

status1 | 2 | 3 | 4 | 5 required

1 = Unassigned, 2 = AdditionPending, 3 = Added, 4 = RemovalPending, 5 = Removed

namestring required

Device name as specified by the user

manufacturerstring required

Device manufacturer (e.g. Apple or Samsung)

modelstring required

The technical model name (e.g. iPhone5,2 or SM-G800F)

modelMarketingNamestring nullable

Marketing model name if there is one (e.g. iPhone 5 or Galaxy S5 mini)

appVersionstring nullable

KleverKey app version if Type == Smartphone

operatingSystem0 | 1 | 2

0 = None, 1 = Android, 2 = iOS

operatingSystemVersionstring nullable

KleverKey app OS version if Type == Smartphone

smartCardType1 | 2 | 3

1 = Generic, 2 = KleverKey, 3 = Swisspass

smartCardAuthentication0 | 1 | 2 | 32

0 = None, 1 = AuthenticationUid, 2 = AuthenticationSecured, 32 = RfidStandardIso14443A

displayNamestring required
isSyncedboolean

Device is synchronized with lock for all permissions

dateLastActivitystring date-time nullable