Config

Récupérer la configuration du client

Changed on
get/api/v2/config

Request

  • The document declares no server URL.
  • Auth: one of:
    • OAuth 2 (authorization code, authorization URL http://localhost:8082/realms/referentiel-applications/protocol/openid-connect/auth, token URL http://localhost:8082/realms/referentiel-applications/protocol/openid-connect/token)
    • API key in header x-refapp-token

Response

Configuration du client

oidcConfigUrlstring required

OIDC configuration URL

oidcClientIdstring required

OIDC client ID

oidcScopestring required

OIDC scopes requested by the frontend

versionstring required

Backend version

environmentLabelstring

Environment label displayed in the header badge

Example response

{
  "oidcConfigUrl": "https://auth.sso.interieur.rie.gouv.fr/.well-known/openid-configuration",
  "oidcClientId": "my-client-id",
  "oidcScope": "openid profile email",
  "version": "1.0.0",
  "environmentLabel": "developpement",
  "footerLinks": [
    {
      "label": "Documentation",
      "title": "Aller à la documentation",
      "href": "https://documentation.example.com"
    }
  ],
  "authLevel": {
    "reauth": {
      "prompt": "login"
    }
  }
}

Changes

  • fd88a848c65dRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status