Sign in
tokens

Crée un nouveau token de service

Changed on

Cette méthode permet de créer un nouveau token de service.

post/api/v2/tokens

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

Request body

role'VISITOR' | 'READER' | 'CONTRIBUTOR' | 'ADMIN' required

Role attribué a un utilisateur

descriptionstring required

Description du token

namestring required

Nom du service ou de l'application utilisant le token

expiresAtstring

Date d'expiration du token, au format ISO 8601, maximum 1 an dans le futur

serviceMode'machine' | 'delegated'

Mode du token de service : machine (autonome) ou delegated (JWT utilisateur obligatoire). Fixé à la création ; sans effet pour les tokens personnels.

scopeOrganizationIdstring nullable

ID de l'organisation de périmètre du compte de service créé. Ignoré si le rôle est VISITOR, comme pour le périmètre d'un utilisateur.

Example request

{
  "description": "Token pour l'application X",
  "name": "Service X",
  "expiresAt": "2023-12-31T23:59:59.999Z"
}

Response

Token créé avec succès

idstring required

Identifiant unique du token

role'VISITOR' | 'READER' | 'CONTRIBUTOR' | 'ADMIN'

Role attribué a un utilisateur

descriptionstring required

Description du token

namestring required

Nom du service ou de l'application utilisant le token

expiresAtstring

Date d'expiration du token, au format ISO 8601, maximum 1 an dans le futur

status'active' | 'expired' | 'revoked' required

Statut du token

kind'personal' | 'service' required

Type de token : personnel (créé par un utilisateur pour lui-même) ou applicatif (compte de service pour un système tiers)

serviceMode'machine' | 'delegated' required

Mode du token de service : machine (autonome) ou delegated (JWT utilisateur obligatoire). Fixé à la création ; sans effet pour les tokens personnels.

passwordstring required

Valeur du token (ne sera pas stockée, à afficher une seule fois)

Example response

{
  "id": "abc123def456ghi789jkl012mno345pq",
  "description": "Token pour l'application X",
  "name": "Service X",
  "expiresAt": "2023-12-31T23:59:59.999Z",
  "status": "active",
  "createdBy": {
    "id": "abc123def456ghi789jkl012mno345pq",
    "email": "jean.dupont@beta.gouv.fr"
  },
  "userImpersonate": {
    "id": "abc123def456ghi789jkl012mno345pq",
    "email": "jean.dupont@beta.gouv.fr"
  },
  "scopeOrganization": {
    "id": "f09ed26a-8415-476a-be3b-ada479291c34",
    "path": "Direction de la transformation numérique",
    "sigle": "dtnum",
    "parentId": "f09ed26a-8415-476a-be3b-ada479291c34",
    "businessDivisionId": "f09ed26a-8415-476a-be3b-ada479291c34",
    "businessDivision": {
      "label": "farm"
    },
    "maiaReferences": [
      {
        "id": "f09ed26a-8415-476a-be3b-ada479291c34",
        "maiaRef": "MI/DNUM/SDID",
        "organizationId": "f09ed26a-8415-476a-be3b-ada479291c34"
      }
    ]
  },
  "password": "xyz987uvw654rst321opq098nml765kj"
}

Changes

  • 1fffb2d3f8b9Revision changes
    • info

      added the new optional request property

    • info

      added the required property to the response with the status

  • 69ebe791b8cbRevision changes
    • info

      added the optional property ///// to the response with the status