Outils d’enrôlement (enroll)
Ces outils créent des clients et les jetons d’enrôlement des nouvelles machines. Un jeton OAuth avec la portée enroll voit ces 3 outils. Les textes de la source sont en anglais.
create_client
Create a client. Portée enroll. Lecture seule : non. Destructif : non.
Creates a client (customer) of the MSP, with no machine: the first step of the onboarding, then create_enrollment_token. Before the call, confirm the exact name with the user. The name is visible in the portal, the reports and the emails. A client with the same name (case and spaces at the start and the end ignored) is refused: the answer gives that client. To rename or delete a client: the portal.
Paramètres
| Nom | Type | Obligatoire | Description |
|---|---|---|---|
name | string | oui | name of the client, as the user confirmed it. Longueur : 1 à 255. |
create_enrollment_token
Create an enrollment token. Portée enroll. Lecture seule : non. Destructif : non.
Creates a single-use token to enroll (add) a Linux or Windows machine for a client, with its install commands. Before the call, confirm the exact name of the client with the user (list_clients finds it from an approximate name): the machine is backed up for that client. The answer holds the token inside the install commands only: give them to the user, do not copy the token anywhere else (no file, no ticket, no other tool). The token expires after 1 hour. The MSP admins get an email at the enrollment. For 24 h, the new machine is no restore target for the MCP unless a person approves it in the portal.
Paramètres
| Nom | Type | Obligatoire | Description |
|---|---|---|---|
client_id | string (uuid) | oui | Id of the client the machine belongs to. |
tags | any | non | Tags the enrolled machine gets, as {key, value}. Optional. |
revoke_enrollment_token
Revoke an enrollment token. Portée enroll. Lecture seule : non. Destructif : non.
Revokes an enrollment token that was not used: it can no longer enroll a machine. A used token cannot be revoked: the machine exists, it is deleted in the portal.
Paramètres
| Nom | Type | Obligatoire | Description |
|---|---|---|---|
enrollment_token_id | string (uuid) | oui | Id of the enrollment token. |