Device Type REST API

The Device/Type endpoint allows creating and managing push-based authentication device types, including customization. This endpoint also enables defining devices with specific graphical/cryptographic customizations for subsets of users in the same tenant.

HID Authentication Service includes a set of default device types.

Note: To use the version-specific parameters/attributes, you must add api-version=N to the query parameter (that is, first digit only, for example, POST /scim/{tenant}/v2/Users?api-version=11).

The API version supported by HID Authentication Service is 11.2.0.

Previous versions of the API are also supported with the corresponding functionality. For details of the version updates, see SCIM API Revision History.

Method Details

HTTPS Method	Entity Action	Request URI	Description
GET	Read	/configuration/{tenant}/v2/Device/Type	Retrieve all the device types
GET	Read	/configuration/{tenant}/v2/Device/Type/{id}	Retrieve a known device type
POST	Create	/configuration/{tenant}/v2/Device/Type	Create a device type
PUT	Replace	/configuration/{tenant}/v2/Device/Type/{id}	Update a known device type
DELETE	Delete	/configuration/{tenant}/v2/Device/Type/{id}	Delete a known device type

Get All Device Types

[GET] /Device/Type

Note: The response does not include the urn:hid:scim:api:idp:2.0:device:type:Push device type extension, even for device types with the correct adapter. Use Get Device Type to obtain all the information for a device type with the “TDS provisioning V4” adapter.

Copy

Sample Request URI

[GET] /configuration/{tenant}/v2/Device/Type

Copy

Sample Response

{
    "ignored": "string",
    "schemas": ["urn:ietf:params:scim:api:messages:2.0:ListResponse"],
    "totalResults": 1,
    "startIndex": 0,
    "resources": [
        {
            "ignored": "string",
            "schemas": ["string"],
            "meta": {
                "resourceType": "TheResource",
                "created": "2023-02-08T16:25:38.098Z",
                "location": "https://[base-server-url]/configuration/{tenant}/v2/<pathToResource>/<id>",
                "version": 1
            },
            "copyFrom": "string",
            "id": "string",
            "name": "string",
            "notes": "string",
            "readOnly": false,
            "manufacturer": "string",
            "defaultCredentialTypeCode": "string",
            "maximumDevicePerUser": -1,
            "allowedCredentialTypes": ["string"],
            "urn:hid:scim:api:idp:2.0:device:type:Token": {
                "deviceFormFactor": "urn:hid:scim:api:idp:2.0:device:type:Token",
                "challengeLength": 0,
                "supportedAuthenticationMethod": "BOTH",
                "syncAuthenticationCodeLength": -1,
                "asyncAuthenticationCodeLength": -1,
                "supportsUnlock": false,
                "unlockChallengeLength": -1,
                "supportsSynch": "SUPPORT_ALL",
                "synchronisationBase": "BOTH",
                "autoSynchEventCounter": 200,
                "autoSynchStartTime": -3600,
                "autoSynchEndTime": 3600,
                "supportsSignatureVerification": false,
                "supportsSoftPin": false,
                "pinMinLength": 4,
                "pinMaxLength": 8"pinPosition": "NONE",
                "allowedCredentialNumber": 100,
                "defaultPin": "string"
            },
            "urn:hid:scim:api:idp:2.0:device:type:Virtual": {
                "deviceFormFactor": "urn:hid:scim:api:idp:2.0:device:type:Virtual"
            },
            "urn:hid:scim:api:idp:2.0:device:type:Fido": {
                "deviceFormFactor": "urn:hid:scim:api:idp:2.0:device:type:FIDO:Generic",
                "challengeLength": 0
            }
            <--truncated output-->
        }
    ]
}

Get Device Type

[GET] /Device/Type/{id}

Copy

Sample Request URI

[GET] /configuration/{tenant}/v2/Device/Type/DT_TDSV4

Create a Device Type

[POST] /Device/Type

Accept: application/scim+json

Important: You cannot create an Device Type from scratch. You must use the copyFrom parameter to specify another Device Type ID from which to copy the configuration and modify the parameters as required.

For details of the extension, see urn:hid:scim:api:idp:2.0:device:Type

Copy

Sample Request URI

[POST] /configuration/{tenant}/v2/Device/Type

Replace Device Type

[PUT] /Device/Type/{id}

Accept: application/scim+json

Note: As a best practice, use GET to retrieve the current data for the resource before using PUT.

Copy

Sample Request URI

[PUT] /configuration/{tenant}/v2/Device/Type/DT_TDSV4a

Delete Device Type

Important: You cannot delete the default device types.

All the delete endpoints follow the same standard pattern and can be reached through the following URL pattern:

Copy

Delete entity

DELETE https://[base-server-url]/scim/{tenant}/v2/ENTITY_TYPE/{id}

Accept: application/scim+json

Copy

Sample Response

HTTP/1.1 204 No content