Skip to content

Latest commit

 

History

History

api

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 

Authentication and API

Authentication

CMS API require OpenID Connect 1.0 for authentication.

Authorization

A client application who need to fetch CMS data for a particular user need to ask some specific OAuth2 scopes. Exemples of CMS scopes:

  • urn:cms:personal-informations:read: read access to the user's basic personal informations
  • urn:cms:identity:read: read access to the user's identity

Fetching data

Most of the claims will be available from the UserInfo OpenID Connect endpoint.

In the future, we may describe some others endpoints to suit some specific needs.

Claims

name required scope Schema
personalInformation urn:cms:personal-information:read Personal information
identity urn:cms:identity:read Identity
favorites urn:cms:favorites:read Favorites
drivingLicence urn:cms:driving-licence:read Driving Licence
ICE urn:cms:ice-contacts:read In Case Of Emergency contacts
CAF urn:cms:fr-caf-information:read French CAF Information
DGFIP urn:cms:fr-dgfip-information:read French DGFIP Information
MESRI urn:cms:fr-mesri-information:read French MESRI Information