Récupérer la configuration SSO SAML

Renvoie la configuration SSO SAML du workspace ainsi que les paramètres Service Provider (SP) prêts à coller dans votre IdP.

1 min de lectureTélécharger en PDF

Réponse exemple

{
  "sp": {
    "acs_url": "https://app.coffrify.com/sso/acme/acs",
    "slo_url": "https://app.coffrify.com/sso/acme/slo",
    "entity_id": "https://app.coffrify.com/sso/acme/metadata",
    "metadata_url": "https://app.coffrify.com/sso/acme/metadata"
  },
  "domains": [
    "acme.com",
    "acme.fr"
  ],
  "enabled": true,
  "configured": true,
  "updated_at": "2026-06-01T09:10:44.000Z",
  "idp_entity_id": "https://sts.windows.net/8a1c.../",
  "sso_login_url": "https://login.microsoftonline.com/8a1c.../saml2",
  "last_tested_at": "2026-05-30T14:22:07.000Z",
  "sso_logout_url": "https://login.microsoftonline.com/8a1c.../saml2",
  "idp_metadata_url": "https://login.microsoftonline.com/8a1c.../federationmetadata.xml",
  "last_test_result": "success",
  "idp_certificate_summary": "MIIDdzCCAl+gAwIBAgIE…(1428 chars)"
}

GET/v1/sso/configLit la configuration SSO SAML du workspace courant et les coordonnées SP générées.

Cet endpoint renvoie l'état de la configuration SSO SAML du workspace authentifié (table coffrify_sso_configs), ainsi qu'un bloc sp contenant les coordonnées Service Provider de Coffrify (entity ID, ACS, SLO, metadata) à reporter dans votre fournisseur d'identité. Le certificat IdP n'est jamais renvoyé en clair : seul un résumé (idp_certificate_summary) est exposé. Si aucune configuration n'existe encore, les champs IdP valent null et domains est un tableau vide.

Authentification

Requiert une clé API valide portant le scope workspace:manage. À défaut, l'appel renvoie 403 scope_missing. La lecture n'est pas soumise au contrôle d'idempotence (skipIdempotency).

Paramètres de requête

Aucun paramètre de requête. Le workspace ciblé est déterminé par le contexte de la clé API.

Réponse

L'objet renvoyé décrit l'état complet de la configuration. Les champs clés :

Champ	Type	Description
enabled	boolean	Indique si le SSO SAML est activé pour le workspace.
configured	boolean	Vrai uniquement si `idp_entity_id`, `idp_certificate` et `sso_login_url` sont tous présents.
idp_entity_id	string \| null	Entity ID du fournisseur d'identité.
idp_metadata_url	string \| null	URL des métadonnées de l'IdP, si fournie.
idp_certificate_summary	string \| null	Résumé du certificat IdP (début + longueur), jamais le PEM complet.
sso_login_url	string \| null	URL de connexion (SSO) de l'IdP.
sso_logout_url	string \| null	URL de déconnexion (SLO) de l'IdP.
domains	string[]	Domaines email rattachés au SSO (peut être vide).
last_tested_at	string \| null	Horodatage du dernier test de connexion SSO.
last_test_result	string \| null	Résultat du dernier test.
updated_at	string	Dernière modification de la configuration.
sp	object	Coordonnées Service Provider de Coffrify : `entity_id`, `acs_url`, `slo_url`, `metadata_url`.

Erreurs

Code	Quand	Résolution
401 missing_api_key	En-tête Authorization absent.	Ajoutez `Authorization: Bearer cof_live_...`.
401 invalid_api_key	Clé API invalide, révoquée ou expirée.	Régénérez une clé valide depuis la console.
403 scope_missing	La clé ne porte pas le scope `workspace:manage`.	Émettez une clé incluant `workspace:manage`.
429 rate_limited	Quota de requêtes du workspace dépassé.	Respectez l'en-tête `Retry-After` puis réessayez.
500 internal_error	Erreur serveur inattendue.	Réessayez ; si le problème persiste, contactez le support avec le `request_id`.

Voir aussi

PATCH /v1/sso/config — Mettre à jour la configuration SSO SAML.
GET /v1/workspace — Détails et plan du workspace (le SSO requiert le plan Entreprise).
GET /v1/members — Membres du workspace dont les accès dépendent du SSO.