ProConnect

https://partenaires.proconnect.gouv.fr/docs
Admin
ProConnect is the French government identity federation service that allows professional users and...
Tokens:49,845
Snippets:374
Trust Score:8.1
Update:1 month ago
Show doc for...
Tokens:
Raw
### GET https://PROCONNECT_DOMAIN/api/v2/userinfo

Source: https://partenaires.proconnect.gouv.fr/docs/fournisseur-service/implementation_technique

Endpoint permettant de récupérer les informations de l'utilisateur authentifié. Implémente le UserInfo Endpoint de OpenID Connect.

```APIDOC
## GET https://PROCONNECT_DOMAIN/api/v2/userinfo

### Description
Implémente le UserInfo Endpoint de OpenID Connect. Permet de récupérer les informations de l'utilisateur authentifié en utilisant l'access token.

### Method
GET

### Endpoint
https://PROCONNECT_DOMAIN/api/v2/userinfo

### Parameters
#### Headers
- **Authorization** (string) - Requis - `Bearer <access_token>` où `<access_token>` a été communiqué par le Token Endpoint

### Response
#### Success Response (200)
- **content-type** (string) - `application/jwt` ou `application/json` selon la configuration
- **description** (string) - JSON Web Token signé ou JSON contenant les claims transmis par le FI

#### Error Response (400)
- **content-type** (string) - `application/json;charset=utf-8`
- **description** (string) - JSON document décrivant l'origine de l'erreur de format
```

--------------------------------

### Appel du Logout Endpoint avec id_token_hint

Source: https://partenaires.proconnect.gouv.fr/docs/fournisseur-service/implementation_technique

Appel HTTP GET à /api/v2/session/end avec les paramètres id_token_hint, state et post_logout_redirect_uri. Doit être réalisé via une redirection navigateur pour expirer les cookies de session.

```http
GET /api/v2/session/end?id_token_hint=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiI3MDRlMDI0MjI5MDE1ZDJiZDQ3ZjdhNWU1YWIwNWIzNWM4MzM2YWI0MDNjMzgwMjI5ODVmOGNmYWRjODZmZTkxIiwiYW1yIjpbInB3ZCJdLCJhdXRoX3RpbWUiOjE2Njg1MzAzMjYsImFjciI6ImVpZGFzMSIsIm5vbmNlIjoiYWZjODFmZGExZmJiNmQzYzg3NmFmNzVjNzM3YTEzMDdhMWIyOWJhMDg3M2VmYTA1OWU0NTM1ZDEyMmM5ZGI1YSIsImF0X2hhc2giOiJJVEJTV1J2NW1HRmxxTGQ0Sm5nbnRnIiwidWIiOiI2OTI1ZmI4MTQzYzc2ZWQzZDQ0ZDU4ODM3ZDIwMGM2Y2IxMDA2MDY1ZjdmMDAzZDU1MjcxMmI3ODk4NTcwNGYzOTU0MCIsImV4cCI6MTY2ODUzMDM4NiwiaWF0IjoxNjY4NTMwMzI2LCJpc3MiOiJodHRwczovL2ZjYS5pbnRlZzAxLmRldi1hZ2VudGNvbm5lY3QuZnIvYXBpL3YyIiwibm9uY2UiOiJhZmM1OGYxYmJiNmQzZF7hZmE3NTczNzM3M1OGQ0NjVmM2RkMTcwODJiZjlkYzRlMjQ0NmIzNDM4NTM1NmQ1OCJ0.hg1n4WJbzZECwz4VldAybXYreEXJ4fxpSWqDseV4tTk&state=3b7bd7fB38ccab89864563f17a89c4cb3bd400164ce828b4cfc2cb01ce8ed9da&post_logout_redirect_uri=https%3A%2F%2Ffsa1v2.integ01.dev-agentconnect.fr%2Flogout-callback HTTP/1.1
Host: fca.integ01.dev-agentconnect.fr
```

--------------------------------

### Exemple d'URL avec le paramètre login_hint

Source: https://partenaires.proconnect.gouv.fr/docs/fournisseur-service/login_hint_usage

Utilisez cette URL pour appeler l'authorization_endpoint avec le paramètre login_hint afin de préremplir l'adresse email de l'utilisateur dans la mire de connexion ProConnect. Remplacez les valeurs entre chevrons par vos propres paramètres. Le paramètre login_hint est optionnel et l'utilisateur peut toujours modifier l'adresse préremplie.

```text
https://PROCONNECT_DOMAIN/api/v2/authorize?response_type=code&client_id=<CLIENT_ID>&redirect_uri=<REDIRECT_URI>&scope=<SCOPES>&state=<STATE>&nonce=<NONCE>&login_hint=utilisateur@exemple.fr
```

--------------------------------

### GET FS_URL/POST_LOGOUT_REDIRECT_URI?state=x

Source: https://partenaires.proconnect.gouv.fr/docs/fournisseur-service/implementation_technique

Route de redirection vers le FS après déconnexion. ProConnect renvoie le state communiqué par le FS lors de la demande de déconnexion.

```APIDOC
## [GET] FS_URL/POST_LOGOUT_REDIRECT_URI?state=x

### Description
Redirection vers le FS après déconnexion. ProConnect renvoie le state communiqué par le FS lors de la demande de déconnexion.

### Method
GET

### Endpoint
FS_URL/POST_LOGOUT_REDIRECT_URI?state=x

### Parameters
#### Query Parameters
- **state** (string, minimum 32 caractères) - Requis - `<state>` communiqué par le FS dans l'appel au Logout Endpoint. Cette information est à vérifier par le FS, afin d'empêcher l'exploitation de failles CSRF

### Request Example
```
GET /logout-callback?state=3b7bd7fb38ccab89864563f17a89c4cb3bd400164ce828b4cfc2cb01ce8ed9da HTTP/1.1
Host: fsa1v2.integ01.dev-agentconnect.fr
```

### Response
(No explicit response example provided in source)
```

--------------------------------

### Règle CSS pour le bouton ProConnect (CSS)

Source: https://partenaires.proconnect.gouv.fr/docs/fournisseur-service/bouton_proconnect

Ajuste la mise en page du bouton pour ProConnect, en remplaçant l'icône par défaut par celle de ProConnect et en définissant le dimensionnement. À ajouter après les modifications mentionnées dans les étapes DSFR.

```css
.fr-connect {
  padding-left: 4.375em !important;
}

.fr-connect:before {
  width: 3.375em !important;
  background-size: 3.375em 3em !important;
  left: 0.625em !important;
}
```

--------------------------------

### Algorithmes de signature asymétrique supportés par ProConnect

Source: https://partenaires.proconnect.gouv.fr/docs/fournisseur-identite/configuration

Liste des algorithmes de signature asymétrique que ProConnect gère pour signer les appels aux endpoints /token et /user-info. Ces algorithmes sont ES256 (EC + SHA256) et RS256 (RSA + SHA256).

```text
 - ES256 (EC + SHA256)
 - RS256 (RSA + SHA256)
```

--------------------------------

### GET /api/v2/session/end

Source: https://partenaires.proconnect.gouv.fr/docs/fournisseur-service/implementation_technique

Endpoint de déconnexion auprès de ProConnect. Implémente le Logout Endpoint de OpenID Connect. Cet appel doit être réalisé via une redirection dans le navigateur de l'agent, afin d'expirer les cookies de session ProConnect et FI.

```APIDOC
## [GET] /api/v2/session/end

### Description
Implémente le Logout Endpoint de OpenID Connect. Cet appel doit être réalisé via une redirection dans le navigateur de l'agent, afin d'expirer les cookies de session ProConnect et FI.

### Method
GET

### Endpoint
/api/v2/session/end

### Parameters
#### Query Parameters
- **id_token_hint** (string) - Recommandé - `<id_token>` contenu dans la réponse du Token Endpoint
- **state** (string) - Requis - Champ obligatoire, généré aléatoirement par le FS, que ProConnect renvoie tel quel dans la redirection qui suit la déconnexion, pour être ensuite vérifié par le FS. Il est utilisé afin d'empêcher l'exploitation de failles CSRF
- **post_logout_redirect_uri** (string) - Requis - URL de retour vers le FS, communiquée dans le formulaire Démarches Simplifiées. Attention, cette URL doit être encodée pour être passée en query parameter, doit correspondre exactement à celle communiquée à ProConnect, et est sensible à la présence ou non du `/` final
- **client_id** (string) - Optionnel - Identifiant du FS, utilisé lorsque l'id_token_hint ne peut être fourni en raison de contraintes techniques.

### Request Example
```
GET /api/v2/session/end?id_token_hint=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiI3MDRlMDI0MjI5MDE1ZDJiZDQ3ZjdhNWU1YWIwNWIzNWM4MzM2YWI0MDNjMzgwMjI5ODVmOGNmYWRjODZmZTkxIiwiYW1yIjpbInB3ZCJdLCJhdXRoX3RpbWUiOjE2Njg1MzAzMjYsImFjciI6ImVpZGFzMSIsIm5vbmNlIjoiYWZjODFmZGExZmJiNmQzYzg3NmFmNzVjNzM3YTEzMDdhMWIyOWJhMDg3M2VmYTA1OWU0NTM1ZDEyMmM5ZGI1YSIsImF0X2hhc2giOiJJVEJTV1J2NW1HRmxxTGQ0Sm5nbnRnIiwiYXVkIjoiNjkyNWZiODE0M2M3NmVkZWQ0NGQzMmI0MGMwY2IxMDA2MDY1ZjdmMDAzZGU1MjcxMmI3ODk4NTcwNGYzOTk1MCIsImV4cCI6MTY2ODUzMDM4NiwiaWF0IjoxNjY4NTMwMzI2LCJpc3MiOiJodHRwczovL2ZjYS5pbnRlZzAxLmRldi1hZ2VudGNvbm5lY3QuZnIvYXBpL3YyIn0.hg1n4WJbzZECwz4VldAybXYreEXJ4fxpSWqDs9V4tTk&state=3b7bd7fb38ccab89864563f17a89c4cb3bd400164ce828b4cfc2cb01ce8ed9da&post_logout_redirect_uri=https%3A%2F%2Ffsa1v2.integ01.dev-agentconnect.fr%2Flogout-callback HTTP/1.1
Host: fca.integ01.dev-agentconnect.fr
```

### Response
#### Success Response (303)
- **content-type** (string) - `text/html;charset=UTF-8`
- **description** (string) - Redirection vers le FI pour déconnexion, puis redirection vers le FS après déconnexion

#### Response Example
(No explicit response example provided in source)
```

--------------------------------

### Réponse userinfo_endpoint de ProConnect avec objet custom rempli

Source: https://partenaires.proconnect.gouv.fr/docs/fournisseur-service/custom-scope

Cas n°2 : ProConnect place les propriétés non canoniques dans l'objet `custom`.

```json
{
  "sub": "7396c91e-b9f2-4f9d-8547-5e9b3332725b",
  ...
  "custom": {
    "structureTravail": "59194",
    "siteTravail": "DRHAUTS-DE-FRANCE/PFPPLATEFORMESERVICESADISTANCE(HDF0262005733)"
  }
}
```

--------------------------------

### Intégration HTML/CSS du bouton ProConnect (sans Design Système)

Source: https://partenaires.proconnect.gouv.fr/docs/fournisseur-service/bouton_proconnect

À utiliser lorsque le Système de Design de l'État n'est pas employé. Fournit une classe pour l'accessibilité (masquer le texte) et une classe .proconnect-button pour le style de base.

```css
.proconnect-sr-only {
  position: absolute;
  width: 1px;
  height: 1px;
  padding: 0;
  margin: -1px;
  overflow: hidden;
  clip: rect(0, 0, 0, 0);
  white-space: nowrap;
  border-width: 0;
}

.proconnect-button {
  background-color: transparent !important;
  background-image: 
```

--------------------------------

### CSS du bouton ProConnect

Source: https://partenaires.proconnect.gouv.fr/docs/fournisseur-service/bouton_proconnect

Styles CSS pour le bouton ProConnect, avec une image de fond en base64 et un état de survol. À utiliser lorsque le site n'utilise pas le Système de Design de l'État.

```css
.proconnect-button {
  background-image: url('data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIyMTQiIGhlaWdodD0iNTYiIHZpZXdCb3g9IjAgMCAyMTQgNTYiPjxwYXRoIGZpbGw9IiMwMDAwOTkiIGQ9Ik0wIDBoMjE0djU2SDB6Ii8+PHBhdGggZmlsbD0iI2ZmZiIgZD0iTTEwLjUgMTIuNWgxOTN2MzFIMTAuNXoiLz48cGF0aCBmaWxsPSIjMDAwMDk5IiBkPSJNMjAgMjBoMTc0djE2SDIweiIvPjx0ZXh0IHg9IjEwNyIgeT0iMzAiIGZvbnQtZmFtaWx5PSJBcmlhbCwgc2Fucy1zZXJpZiIgZm9udC1zaXplPSIxNCIgZmlsbD0iI2ZmZiIgdGV4dC1hbmNob3I9Im1pZGRsZSI+UHJvQ29ubmVjdDwvdGV4dD48L3N2Zz4=');
  background-position: 50% 50%;
  background-repeat: no-repeat;
  width: 214px;
  height: 56px;
  border: none;
}

.proconnect-button:hover {
  background-image: url('data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIyMTQiIGhlaWdodD0iNTYiIHZpZXdCb3g9IjAgMCAyMTQgNTYiPjxwYXRoIGZpbGw9IiMwMDAwOTkiIGQ9Ik0wIDBoMjE0djU2SDB6Ii8+PHBhdGggZmlsbD0iI2ZmZiIgZD0iTTEwLjUgMTIuNWgxOTN2MzFIMTAuNXoiLz48cGF0aCBmaWxsPSIjMDAwMDk5IiBkPSJNMjAgMjBoMTc0djE2SDIweiIvPjx0ZXh0IHg9IjEwNyIgeT0iMzAiIGZvbnQtZmFtaWx5PSJBcmlhbCwgc2Fucy1zZXJpZiIgZm9udC1zaXplPSIxNCIgZmlsbD0iI2ZmZiIgdGV4dC1hbmNob3I9Im1pZGRsZSI+UHJvQ29ubmVjdDwvdGV4dD48L3N2Zz4=');
}
```

--------------------------------

### Réponse userinfo_endpoint avec objet custom vide

Source: https://partenaires.proconnect.gouv.fr/docs/fournisseur-service/custom-scope

Cas n°1 : le Fournisseur d'Identité n'a retourné aucune propriété non canonique. ProConnect renvoie un objet `custom` vide.

```json
{
  "sub": "sub-proconnect",
  ...
  "custom": {}
  }
```
Tokens:
Raw