CreationConfigurationAccesApi
  • 01 Apr 2024
  • 1 Minute à lire
  • Sombre
    Lumière
  • PDF

CreationConfigurationAccesApi

  • Sombre
    Lumière
  • PDF

Article Summary

Fonction API

/v1/AdministrationAPI/CreationConfigurationAccesApi

Verbe HTTP

Post

Description

Permet de créer ou de modifier (mode annule et remplace) une configuration d'accès API.

Une configuration d'accès API ajoutée est au statut désactivé. Il est nécessaire de l'activer depuis le portail API.

Pour connaitre la liste des configurations d''accès API, utiliser la fonction AnalyseConfigurationAccesAPI

Groupe de fonctions API

ADMIN02

Paramètres de la requête

ParamètreTypeDescription
configurationCreationConfigurationAccesApiElément structuré contenant les informations de la configuration d'accès à créer ou modifier (cf. détail ci-dessous)

CreationConfigurationAccesApi

ParamètreTypeDescription
clientIdstringClientId du compte API auquel rattacher la configuration d'accès.
Valeur à renseigner obligatoirement même en modification
identifiantUtilisateurSilaestringIdentifiant du compte utilisateur Silae à utiliser pour les droits d'accès fonctionnels
idConfigurationstringId de la configuration à renseigner pour modifier une configuration d'accès API existante.
Pour connaître l'id de la configuration, utiliser la fonction AnalyseConfigurationAccesApi
niveauAccesstringNiveau d'accès sur les dossiers du domaine. Valeurs acceptées :
- Dossiers
- TousDossiers
dossiersstring[]Si le niveau d'accès = "Dossiers", préciser le sous ensemble de dossiers auxquels donner accès

Paramètres de la réponse

ParamètreTypeDescription
clientIdstringClientId du compte API parent
identifiantUtilisateurSilaestringIdentifiant du compte utilisateur Silae
idConfigurationstringId de la configuration créée ou mise à jour
niveauAccesstringNiveau d'accès de la configuration
dossiersstring[]Liste des dossiers retenue

Requête

{
  "configuration": {
    "clientId": "string",
    "identifiantUtilisateurSilae": "string",
    "idConfiguration": "string",
    "niveauAcces": "string",
    "dossiers": [
      "string",
      "string"
    ]
  }
}

Réponse

{
  "clientId": "string",
  "identifiantUtilisateurSilae": "string",
  "idConfiguration": "string",
  "niveauAcces": "string",
  "dossiers": [
    "string",
    "string"
  ]
}

Messages d'erreur

ErreurMessageDescription

Cet article vous a-t-il été utile ?

Changing your password will log you out immediately. Use the new password to log back in.
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.