Desktop agent configuration

Use this endpoint to retrieve the configuration file consumed by the Signitic desktop agent on Windows and macOS.

This is also the endpoint used in centralized Windows deployments such as RDS or GPO-based rollouts.

Endpoint

GET https://api.signitic.app/desktop/:email

Headers

Name	Type	Description
x-api-key*	String	Your API key

Path parameters

Name	Type	Description
email*	String	User email used to resolve the desktop agent configuration.

Response

200 OK

{
  "cron_m": 17,
  "cron_h": "*/2",
  "2ec9c7c3d2d54f1f9f68d4d9b7c9d6c1": {
    "key": "2ec9c7c3d2d54f1f9f68d4d9b7c9d6c1",
    "email": "[email protected]",
    "service": 3,
    "name": "John Doe"
  },
  "aa51c9115c3c4f31bc16507cb9fe5f32": {
    "key": "aa51c9115c3c4f31bc16507cb9fe5f32",
    "email": "[email protected]",
    "service": 3,
    "name": "John Alias"
  }
}

Response fields

Name	Type	Description
cron_m	Integer	Minute used by the desktop agent refresh schedule.
cron_h	String	Hour expression used by the desktop agent refresh schedule.
<hash>.key	String	Internal key used by the desktop app to request signatures.
<hash>.email	String	Email address attached to this configuration entry.
<hash>.service	Integer	Internal service identifier used by the desktop app.
<hash>.name	String	Display name shown by the desktop app.

The response can include multiple entries:

• the main user

• aliases

• delegated users

Common errors

Status	Description
200	{"success": false, "code": 99, "message": "Invalid API key."} when the x-api-key header is missing.
200	{"error": false, "message": "Wrong API key"} when the API key does not match a workspace with API access.
200	{"success": false, "code": 100, "message": "Method not allowed."} when the user cannot be resolved.

Deployment notes

For Windows RDS or GPO deployments, Signitic provides deployment guidance and example scripts here:

Déploiement sur RDS ou par GPO