Les cas d'usage que ce client peut exercer

GET

/v1/perimetre

curl --request GET \
  --url https://passerelle.teneur.exemple/v1/perimetre \
  --header 'Authorization: Bearer <token>'

• Un hôte par teneur de compte — un processus ne sert qu'un tenant. Le tenant se lit à l'hôte et au jeton, jamais dans un chemin : le nom d'hôte route, l'identité autorise.

Le périmètre souscrit se lit, il ne se devine pas à coups de 403. Il est dérivé des politiques d’autorisation et jamais ressaisi à côté d’elles : cette réponse est une projection de ce que le point de décision rendrait, pas une seconde source.

Autorisations

• jetonPartenaire

Réponses

200

Le périmètre du client qui appelle.

Media typeapplication/json

object

client

required

L’identifiant du client OAuth qui appelle — le sujet de l’autorisation.

string

contrat

required

Le contrat concerné (« cas-d-usage-du-correspondant »).

string

audience

required

L’audience pour laquelle un jeton doit être obtenu afin d’exercer ce contrat — la valeur à demander au point de jeton. Un client qui sert aussi la surface de l’épargnant lit l’autre audience dans l’autre contrat.

string

version

required

La version du contrat servie par ce déploiement.

string

cas_d_usage

required

Les operationId que ce client peut exercer. Un cas d’usage absent répond 403 sans révéler l’existence de la ressource.

Array<string>

entreprises

Les entreprises sur lesquelles ce client peut agir, quand son périmètre en nomme une liste fermée. Absent, il porte sur toutes les entreprises du teneur.

Array<string>

Example^generated

{
  "client": "example",
  "contrat": "example",
  "audience": "example",
  "version": "example",
  "cas_d_usage": [
    "example"
  ],
  "entreprises": [
    "example"
  ]
}

Headers

Correlation-Id

string

>= 1 characters <= 128 characters

L’identifiant de corrélation reçu, restitué tel quel — la jointure entre le journal du teneur et le nôtre.

401

401 — aucune identité présentée, ou jeton invalide : signature, émetteur, dates, tenant, ou audience obtenue pour une autre surface. La réponse porte WWW-Authenticate: Bearer error="invalid_token".

Media typeapplication/json

object

code

required

Le code stable sur lequel un portail se branche — le motif, lui, est écrit pour être lu par une personne et peut changer sans rupture.

string

Allowed values: DEMANDE_MAL_FORMEE CHAMP_INVALIDE NON_AUTHENTIFIE HORS_PERIMETRE_SOUSCRIT RESSOURCE_INCONNUE REJEU_DIVERGENT ECRITURE_REFUSEE AGREGAT_RETENU

motif

required

Le motif, qui nomme le champ ou l’identifiant en cause.

string

champ

Le champ en cause, quand l’erreur en désigne un.

string

correlation

L’identifiant de corrélation de l’appel — le même que l’en-tête restitué.

string

Example

{
  "code": "DEMANDE_MAL_FORMEE"
}

Headers

WWW-Authenticate

string

Le défi d’authentification, au format des jetons porteurs.