CreationConfigurationAccesApi
- 30 May 2023
- 1 Minute à lire
- Impression
- SombreLumière
- PDF
CreationConfigurationAccesApi
- Mis à jour le 30 May 2023
- 1 Minute à lire
- Impression
- SombreLumière
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
Fonction API
/v1/AdministrationAPI/CreationConfigurationAccesApi
Verbe HTTP
Post
Description
Permet de créer ou de modifier 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 ListeComptesAPI
Groupe de fonctions API
ADMIN02
Paramètres de la requête
Paramètre | Type | Description |
---|---|---|
configuration | CreationConfigurationAccesApi | Elément structuré contenant les informations de la configuration d'accès à créer ou modifier (cf. détail ci-dessous) |
CreationConfigurationAccesApi
Paramètre | Type | Description |
---|---|---|
clientId | string | ClientId du compte API auquel rattacher la configuration d'accès. Valeur à renseigner obligatoirement même en modification |
identifiantUtilisateurSilae | string | Identifiant du compte utilisateur Silae à utiliser pour les droits d'accès fonctionnels |
idConfiguration | string | Id 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 |
niveauAcces | string | Niveau d'accès sur les dossiers du domaine. Valeurs acceptées : - Dossiers - TousDossiers |
dossiers | string[] | 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ètre | Type | Description |
---|---|---|
clientId | string | ClientId du compte API parent |
identifiantUtilisateurSilae | string | Identifiant du compte utilisateur Silae |
idConfiguration | string | Id de la configuration créée ou mise à jour |
niveauAcces | string | Niveau d'accès de la configuration |
dossiers | string[] | 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
Erreur | Message | Description |
---|
Cet article vous a-t-il été utile ?