CredentialSettingsV1
Information regarding the device credentials settings and action to modify them.
Trait Type: Standard
Action Mutations
Note: See Overview: Device Action Lifecycle for more information on action flows
CredentialSettingsV1SetCredentialsSettings action
Modify the credentials settings on the device.
Mutation Inputs
Input Name | Description | Data Type | Nullable |
deviceId | uuid of the device to which mutation should apply | ID! | false |
traitActionArgs | See table below for specific fields | CredentialSettingsV1SetCredentialsSettingArgs! | false |
CredentialSettingsV1SetCredentialsSettingArgs Fields
Field Name | Description | Data Type | Nullable |
mifareClassic | Desired value for if support for mifareClassic setting. | mifareClassicEnums | true |
mifareDesfire | Desired value for if support for mifareDesfire setting. | mifareDesfireEnums | true |
mifareDesfireLight | Desired value for if support for mifareDesfireLight setting. | mifareDesfireLightEnums | true |
mifare2Go | Desired value for if support for mifare2Go setting. | mifare2GoEnums | true |
androidHce | Desired value for if support for androidHce setting. | androidHceEnums | true |
appleNFC | Desired value for if support for appleNFC setting. | appleNFCEnums | true |
iClassCredentials | Desired value for if support for iClassCredentials setting. | iClassCredentialsEnums | true |
iso14443SecurityMethod | Desired value for if support for iso14443SecurityMethod setting. | iso14443SecurityMethodEnums | true |
iso15693SecurityMethod | Desired value for if support for iso15693SecurityMethod setting. | iso15693SecurityMethodEnums | true |
nfcConfigCard | Desired value for if support for nfcConfigCard setting. | nfcConfigCardEnums | true |
mifareClassicEnums Values
Enumerated String | Description |
ENABLED | mifareClassic credentials are accepted at device. |
DISABLED | mifareClassic credentials are not accepted at device. |
mifareDesfireEnums Values
Enumerated String | Description |
ENABLED | mifareDesfire credentials are accepted at device. |
DISABLED | mifareDesfire credentials are not accepted at device. |
mifareDesfireLightEnums Values
Enumerated String | Description |
ENABLED | mifareDesfireLight credentials are accepted at device. |
DISABLED | mifareDesfireLight credentials are not accepted at device. |
mifare2GoEnums Values
Enumerated String | Description |
ENABLED | mifareClassic credentials are accepted at device. |
DISABLED | mifareClassic credentials are not accepted at device. |
androidHceEnums Values
Enumerated String | Description |
ENABLED | androidHce credentials are accepted at device. |
DISABLED | androidHce credentials are not accepted at device. |
appleNFCEnums Values
Enumerated String | Description |
ENABLED | appleNFC credentials are accepted at device. |
DISABLED | appleNFC credentials are not accepted at device. |
iClassCredentialsEnums Values
Enumerated String | Description |
UID_FORTY_BIT_WITH_PARITY | iClassCredentials credentials are accepted at device using UID with 40-bit parity. |
UID_SIXTYFOUR_BIT_MSB | iClassCredentials credentials are accepted at device using UID with 64-bit most-significant-bit first. |
SYMMETRIC_CRYPTOGRAPHIC_SECURITY | iClassCredentials credentials are accepted at device using symmetric cryptographic security. |
DISABLED | iClassCredentials credentials are not accepted at device. |
iso14443SecurityMethodEnums Values
Enumerated String | Description |
UID_ONLY | iso14443SecurityMethod credentials are accepted at device using UID only. |
SYMMETRIC_CRYPTOGRAPHIC_SECURITY | iso14443SecurityMethod credentials are accepted at device using symmetric cryptographic security. |
DISABLED | iso14443SecurityMethod credentials are not accepted at device. |
iso15693SecurityMethodEnums Values
Enumerated String | Description |
UID | iso15693SecurityMethod credentials are accepted at device using UID only. |
DISABLED | iso15693SecurityMethod credentials are not accepted at device. |
nfcConfigCardEnums Values
Enumerated String | Description |
ENABLED | nfcConfigCard credentials are accepted at device. |
DISABLED | nfcConfigCard credentials are not accepted at device. |
GQL Examples
Request Example
mutation CredentialsSettingsV1SetCredentialsSettings {
CredentialsSettingsV1SetCredentialsSettings(
deviceId: "9a8f6104-6c50-476e-90ee-16b9a2dafc8d"
traitActionArgs: {
mifareClassic: ENABLED
mifareDesfire: ENABLED
mifareDesfireLight: ENABLED
mifare2Go: ENABLED
androidHce: ENABLED
appleNFC: ENABLED
iClassCredentials: UID_FORTY_BIT_WITH_PARITY
iso14443SecurityMethod: UID_ONLY
iso15693SecurityMethod: UID
nfcConfigCard: ENABLED
}
) {
deviceId
actionId
traitName
}
}
Response Example
{
"data": {
"CredentialsSettingsV1SetCredentialsSettings": {
"actionId": "7eb3629a-a1c3-49f0-89b6-2831d500ac68",
"deviceId": "9a8f6104-6c50-476e-90ee-16b9a2dafc8d"
}
}
}
Reported States
Note: See Overview: Device Reported State for more information on reported state flows.
State Definitions
mifareClassic State
Indicates whether the MIFARE classic credential settings is enabled or disable for the device.
Data Type: Enum
Valid Values
Enumerated Value | Description |
ENABLED | mifareClassic credentials are accepted at device. |
DISABLED | mifareClassic credentials are not accepted at device. |
UNSUPPORTED | Device has not yet reported a value for this field. |
mifareDesfire State
Indicates whether the MIFARE DESFire credential settings is enabled or disable for the device.
Data Type: Enum
Valid Values
Enumerated Value | Description |
ENABLED | mifareDesfire credentials are accepted at device. |
DISABLED | mifareDesfire credentials are not accepted at device. |
UNSUPPORTED | Device has not yet reported a value for this field. |
mifareDesfireLight State
Indicates whether the MIFARE DESFire light credential settings is enabled or disable for the device.
Data Type: Enum
Valid Values
Enumerated Value | Description |
ENABLED | mifareDesfireLight credentials are accepted at device. |
DISABLED | mifareDesfireLight credentials are not accepted at device. |
UNSUPPORTED | Device has not yet reported a value for this field. |
mifare2Go State
Indicates whether the MIFARE2Go credential settings is enabled or disable for the device.
Data Type: Enum
Valid Values
Enumerated Value | Description |
ENABLED | mifare2Go credentials are accepted at device. |
DISABLED | mifare2Go credentials are not accepted at device. |
UNSUPPORTED | Device has not yet reported a value for this field. |
androidHce State
Indicates whether the Android HCE credential settings is enabled or disable for the device.
Data Type: Enum
Valid Values
Enumerated Value | Description |
ENABLED | androidHce credentials are accepted at device. |
DISABLED | androidHce credentials are not accepted at device. |
UNSUPPORTED | Device has not yet reported a value for this field. |
appleNFC State
Indicates whether the Apple NFC credential settings is enabled or disable for the device.
Data Type: Enum
Valid Values
Enumerated Value | Description |
ENABLED | appleNFC credentials are accepted at device. |
DISABLED | appleNFC credentials are not accepted at device. |
UNSUPPORTED | Device has not yet reported a value for this field. |
iClassCredentials State
Indicates if the iClass credential setting is disable and if not the method used for it.
Data Type: Enum
Valid Values
Enumerated Value | Description |
UID_FORTY_BIT_WITH_PARITY | iClassCredentials credentials are accepted at device using UID with 40-bit parity. |
UID_SIXTYFOUR_BIT_MSB | iClassCredentials credentials are accepted at device using UID with 64-bit most-significant-bit first. |
SYMMETRIC_CRYPTOGRAPHIC_SECURITY | iClassCredentials credentials are accepted at device using symmetric cryptographic security. |
DISABLED | iClassCredentials credentials are not accepted at device. |
UNSUPPORTED | Device has not yet reported a value for this field. |
iso14443SecurityMethod State
Indicates if the ISO 14443 security method setting is disable and if not the method used for it.
Data Type: Enum
Valid Values
Enumerated Value | Description |
UID_ONLY | iso14443SecurityMethod credentials are accepted at device using UID only. |
SYMMETRIC_CRYPTOGRAPHIC_SECURITY | iso14443SecurityMethod credentials are accepted at device using symmetric cryptographic security. |
DISABLED | iso14443SecurityMethod credentials are not accepted at device. |
UNSUPPORTED | Device has not yet reported a value for this field. |
iso15693SecurityMethod State
Indicates if the ISO 15693 security method setting is disable and if not the method used for it.
Data Type: Enum
Valid Values
Enumerated Value | Description |
UID | iso15693SecurityMethod credentials are accepted at device using UID only. |
DISABLED | iso15693SecurityMethod credentials are not accepted at device. |
UNSUPPORTED | Device has not yet reported a value for this field. |
nfcConfigCard State
Indicates whether the NFC config card settings is enabled or disable for the device.
Data Type: Enum
Valid Values
Enumerated Value | Description |
ENABLED | nfcConfigCard credentials are accepted at device. |
DISABLED | nfcConfigCard credentials are not accepted at device. |
UNSUPPORTED | Device has not yet reported a value for this field. |
Device State Query GQL Examples
Request Example
query Device {
device(deviceId: "9a8f6104-6c50-476e-90ee-16b9a2dafc8d") {
id
traits {
... on CredentialsSettingsV1DeviceTrait {
name
state {
mifareClassic {
reported {
value
}
}
mifareDesfire {
reported {
value
}
}
mifareDesfireLight {
reported {
value
}
}
mifare2Go {
reported {
value
}
}
androidHce {
reported {
value
}
}
appleNFC {
reported {
value
}
}
iClassCredentials {
reported {
value
}
}
iso14443SecurityMethod {
reported {
value
}
}
iso15693SecurityMethod {
reported {
value
}
}
nfcConfigCard {
reported {
value
}
}
}
}
}
}
}
Response Example
{
"data": {
"device": {
"id": "9a8f6104-6c50-476e-90ee-16b9a2dafc8d",
"traits": [
{
"name": "CredentialsSettingsV1",
"state": {
"mifareClassic": {
"reported": {
"value": "ENABLED"
}
},
"mifareDesfire": {
"reported": {
"value": "ENABLED"
}
},
"mifareDesfireLight": {
"reported": {
"value": "DISABLED"
}
},
"mifare2Go": {
"reported": {
"value": "DISABLED"
}
},
"androidHce": {
"reported": {
"value": "DISABLED"
}
},
"appleNFC": {
"reported": {
"value": "DISABLED"
}
},
"iClassCredentials": {
"reported": {
"value": "UID_FORTY_BIT_WITH_PARITY"
}
},
"iso14443SecurityMethod": {
"reported": {
"value": "DISABLED"
}
},
"iso15693SecurityMethod": {
"reported": {
"value": "UID"
}
},
"nfcConfigCard": {
"reported": {
"value": "DISABLED"
}
}
}
}
]
}
}
}
What made this section unhelpful for you?
On this page
- CredentialSettingsV1