La version française est une traduction automatique. La version anglaise prévaut sur la française en cas de divergence.

(Grand public) les API d’administration

Contributeurs

Les API d’administration (grand public) comprennent des méthodes qui vous permettent d’effectuer les tâches suivantes :

Le tableau suivant répertorie les API grand public documentées dans cette section.

Méthode HTTP Chemin Description

«POST»

/v2.1/auth/password

Définissez le mot de passe d’un utilisateur.

«POST»

/v2.1/auth/password

Actualiser l’authentification JWT.

«POST»

/v2.1/auth/signin

Connectez-vous.

`GET'

/v2.1/auth/régions

Extraire les régions.

`GET'

`/v2.1/auth/rerégions/{name}'

Extraire les régions par nom.

`GET'

/v2.1/auth/zones

Récupérer les zones.

`GET'

`/v2.1/auth/zones/{name}'

Récupérer les zones par nom.

`GET'

/v2.1/jobs/

Récupérer les travaux.

`GET'

`/v2.1/jobs/{id}'

Récupérer les travaux par ID.

Réinitialiser le mot de passe utilisateur

Utilisez la méthode indiquée dans le tableau suivant pour réinitialiser le mot de passe utilisateur.

Méthode HTTP Chemin Description Paramètres

«POST»

/v2.1/auth/password

Réinitialisez le mot de passe.

Aucune

Attributs de corps de la demande requis : username (chaîne), `New_passwords' (chaîne)

Exemple corps de la demande :

{
  "username": "MyName",
  "old_password": "oldPassword",
  "new_password": "newPassword"
}

Exemple de corps de réponse :

{
  "status": {
    "user_message": "Okay. Returned 1 record.",
    "verbose_message": "",
    "code": 200
  },
  "result": {
    "total_records": 1,
    "records": [
      {
        "user": {
          "id": "5e61aa814559c20001df1a5f",
          "username": "MyName",
          "firstName": "MyFirstName",
          "lastName": "MySurname",
          "displayName": "CallMeMYF",
          "email": "user@example.com",
          "tenancies": [
            {
              "id": "5e5f1c4f253c820001877839",
              "name": "MyTenant",
              "code": "testtenantmh",
              "role": "user"
            }
          ]
        },
        "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6Ik15TmFtZSIsImV4cCI6MTU4MzgxNjg3MX0.ZuRXjDPVtc2pH-e9wqgmszVKCBYS2PLqux2YwQ5uoAM"
      }
    ]
  }
}

Actualiser le jeton d’authentification

Utilisez la méthode indiquée dans le tableau suivant pour actualiser le jeton d’authentification.

Méthode HTTP Chemin Description Paramètres

«POST»

/v2.1/auth/refresh

Actualiser le jeton d’authentification.

Aucune

Attributs de corps de demande requis: `aucun'

Exemple corps de la demande :

none

Exemple de corps de réponse :

{
  "status": {
    "user_message": "Okay. Returned 1 record.",
    "verbose_message": "",
    "code": 200
  },
  "result": {
    "total_records": 1,
    "records": [
      {
        "user": {
          "id": "5d914547869caefed0f3a00c",
          "username": "myusername",
          "firstName": "myfirstname",
          "lastName": "",
          "displayName": "Myfirstname Mysurname",
          "email": "",
          "tenancies": [
            {
              "id": "5d914499869caefed0f39eee",
              "name": "MyOrg",
              "code": "myorg",
              "role": "admin"
            },
            {
              "id": "5d9417aa869caefed0f7b4f9",
              "name": "ABCsafe",
              "code": "abcsafe",
              "role": "admin"
            }
          ]
        },
        "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6ImVsbGlvdCIsImV4cCI6MTU4MzgxNzA2N30.FdKD3QhPoNdWdbMfZ0bzCMTHluIt6HNP311F482K9AY"
      }
    ]
  }
}

Connectez-vous

Utilisez la méthode indiquée dans le tableau suivant pour vous connecter.

Méthode HTTP Chemin Description Paramètres

«POST»

/v2.1/auth/signin

Connectez-vous en tant qu’utilisateur.

Aucune

Attributs de corps de la demande requis : username (chaîne), `New_passwords' (chaîne)

Exemple corps de la demande :

{
  "username": "MyName",
  "password": "newPassword"
}

Exemple de corps de réponse :

{
  "status": {
    "user_message": "Authentication succeeeded.",
    "verbose_message": "",
    "code": 200
  },
  "result": {
    "total_records": 1,
    "records": [
      {
        "user": {
          "id": "5e61aa814559c20001df1a5f",
          "username": "MyName",
          "firstName": "MyFirstName",
          "lastName": "MySurname",
          "displayName": "CallMeMYF",
          "email": "user@example.com",
          "tenancies": [
            {
              "id": "5e5f1c4f253c820001877839",
              "name": "MyTenant",
              "code": "testtenantmh",
              "role": "user"
            }
          ]
        },
        "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6Ik15TmFtZSIsImV4cCI6MTU4MzgxNzQwMH0._u_UyYrzg_RewF-9ClIGoKQhfZYWrixZYBrsj1kh1hI"
      }
    ]
  }
}