API integration for external systems

External API access allows third-party providers to connect to an organization's internal resources via authenticated API requests.

Follow these steps to configure API access* for external integrations:

– In the Appterix Management UI, navigate to Settings > General Settings.

– Scroll down to the section External API access.

– Activate the option External API access.

– Click Generate new credentials to get a Client Secret and Client ID to create.

– Copy the values ​​for Server URL, Client ID and Client Secret.

*Request from support support@egomind.eu The documentation for all available API methods.

Example: Retrieving device information

The following query returns a list of all available YubiKey devices.

GET https://sample.appterix.eu/api/external/ybk-management/devices

Authorization: Bearer <access_token>

Example (excerpt)

[
    {
        "yubikey": {
            "code": 12345,
            "orgCode": 123,
            "name": "YubiKey 5 NFC",
            "description": null,
            "uniqueId": "123456",
            "serialNumber": "12345678",
            "alternativeSerialNumber": null,
            "firmwareVersion": "5.7.2",
            "model": {
                "code": 20,
                "name": "YubiKey 5 NFC",
                "uniqueId": "00yk12345678",
                "prodLineCode": 100,
                "formFactor": 1,
                "interfaces": [
                    3
                ],
                "usbCapabilities": [
                    1
                ],
                "nfcCapabilities": [
                    1
                ]
            },
            "enabledUSBCapabilities": [
                1
            ],
            "enabledNFCCapabilities": [
                1
            ],
            "lastUpdate": "2026-05-05T14:11:42.78Z",
            "lastUsed": "2026-05-05T14:09:08.6Z",
            "status": 1
        },
        "owners": {
            "count": 1,
            "items": [
                {
                    "code": 12345,
                    "name": "sample-user",
                    "email": "mail@sample.com",
                    "isAdmin": false,
                    "sid": "S-1-5-21-123456789-123456789-123456798-123",
                    "entraId": "",
                    "lastLogin": "2026-05-05T14:05:34.787+00:00",
                    "profilePicture": "",
                    "profilePictureSmall": "",
                    "profilePictureMedium": "",
                    "isExternal": false,
                    "groups": {
                        "count": 2,
                        "items": [
                            {
                                "type": 3,
                                "source": 1,
                                "description": "",
                                "code": -1,
                                "name": "Directory users (Default)"
                            },
                            {
                                "type": 3,
                                "source": 1,
                                "description": "",
                                "code": 12345,
                                "name": ""
                            }
                        ]
                    },
                    "tags": {
                        "count": 1,
                        "items": [
                            {
                                "type": 1,
                                "source": 1,
                                "description": "",
                                "code": 1234,
                                "name": ""
                            }
                        ]
                    }
                }
            ]
        },
        "tags": [],
        "status": {
            "code": 12345,
            "name": "Shared"
        }
    }   
]