Clients

4 routes de l'API publique. Textes de la source : openapi-csp.json du dépôt platform.

List clients

GET /clients

Accès : Clé API du MSP, portée read.

Paramètres

Nom	Emplacement	Type	Obligatoire	Description
limit	requête	integer	non	Défaut : 50. Valeur : 1 à 100.
cursor	requête	string	non	Longueur minimum : 1.
q	requête	string	non	Longueur : 1 à 255.

Réponses

Code	Description
200	Success
default	Error (400, 401, 403, 404, 409, 415, 422, 429, 500, 502, 503 or 504)

Réponse 200 (application/json)

Nom	Type	Obligatoire	Description
items	array of object	oui
items[].id	string (uuid)	oui
items[].msp_id	string (uuid)	oui
items[].name	string	oui
items[].created_at	string (date-time)	oui
items[].endpoint_count	integer	oui	Valeur minimum : 0.
items[].stored_bytes	integer	oui	Valeur minimum : 0.
items[].deletion_effective_at	string (date-time) | null	oui
next_cursor	string | null	oui

Create client

POST /clients

Accès : Clé API du MSP, portée operate.

Corps de la requête (application/json)

Nom	Type	Obligatoire	Description
name	string	oui	Longueur : 1 à 255.

Réponses

Code	Description
201	Success
default	Error (400, 401, 403, 404, 409, 415, 422, 429, 500, 502, 503 or 504)

Réponse 201 (application/json)

Nom	Type	Obligatoire	Description
id	string (uuid)	oui
msp_id	string (uuid)	oui
name	string	oui
created_at	string (date-time)	oui
endpoint_count	integer	oui	Valeur minimum : 0.
stored_bytes	integer	oui	Valeur minimum : 0.
deletion_effective_at	string (date-time) | null	oui

Get client

GET /clients/{id}

Accès : Clé API du MSP, portée read.

Paramètres

Nom	Emplacement	Type	Obligatoire	Description
id	chemin	string (uuid)	oui

Réponses

Code	Description
200	Success
default	Error (400, 401, 403, 404, 409, 415, 422, 429, 500, 502, 503 or 504)

Réponse 200 (application/json)

Nom	Type	Obligatoire	Description
id	string (uuid)	oui
msp_id	string (uuid)	oui
name	string	oui
created_at	string (date-time)	oui
endpoint_count	integer	oui	Valeur minimum : 0.
stored_bytes	integer	oui	Valeur minimum : 0.
deletion_effective_at	string (date-time) | null	oui

Delete client

DELETE /clients/{id}

Accès : Clé API du MSP, portée operate.

Paramètres

Nom	Emplacement	Type	Obligatoire	Description
id	chemin	string (uuid)	oui

Réponses

Code	Description
202	Success
default	Error (400, 401, 403, 404, 409, 415, 422, 429, 500, 502, 503 or 504)

Réponse 202 (application/json)

Nom	Type	Obligatoire	Description
client_id	string (uuid)	oui
endpoints	array of object	oui
endpoints[].endpoint_id	string (uuid)	oui
endpoints[].pending_action_id	string (uuid)	oui
endpoints[].requested_at	string (date-time)	oui
endpoints[].effective_at	string (date-time)	oui	Request + 72 h.
endpoints[].purge_at	string (date-time)	oui	Planned earliest purge: effective_at + 7 days; actual purge is at least 7 days after deleted_at.
revoked_enrollment_tokens	integer	oui	Unused tokens of the client revoked by this request. Valeur minimum : 0.