Obtenir les paramètres

Utilisez ce point de terminaison pour récupérer la liste des paires clé-valeur pour les paramètres d'e-mail et d'authentification.

Point de terminaison de l’API

GET https://{yourDomain}/identity/api/Setting

Étendues

Nécessite les étendues suivantes :

• PM.Setting
• PM.Setting.Read

En-têtes de requête.

--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'

Remarque : pour obtenir le {access_token}, assurez-vous de vous authentifier via l'une des méthodes décrites ici.

Paramètres de requête

Paramètre de requête	Type de données	Description
key (facultatif)	Chaîne de caractères (string)	Saisissez le nom du paramètre que vous souhaitez récupérer. Par exemple, pour récupérer le paramètre Domaine SMTP, saisissez key=Email.Smtp.Domain.
partitionGlobalId (facultatif)	Chaîne de caractères (string)	L'ID de l'organisation pour laquelle vous souhaitez récupérer les paramètres.
userId (facultatif)	Chaîne de caractères (string)	L'ID de l'utilisateur pour lequel vous souhaitez récupérer les paramètres.

Réponses

200 OK

Renvoie les comptes de robot interrogés.

Exemple de requête

Supposons que vous ayez rassemblé toutes les informations nécessaires pour créer l'appel d'API.

• Your {baseURL} is: https://{yourDomain}/identity
• Votre {access_token} est : 1234 (pour des considérations de longueur).
• Le {partitionGlobalId} est : 3fa85f64-5717-4562-b3fc-2c963f66afa6
• Vous souhaitez récupérer les paramètres de messagerie globaux, vous devez vous connecter en tant qu'administrateur hôte. Dans ce cas, vous ne fournissez pas de userID.

L’appel doit ressembler à l’exemple suivant (cURL) :

curl --location --request GET 'https://{yourDomain}/identity/api/Setting?partitionGlobalId=3fa85f64-5717-4562-b3fc-2c963f66afa6&key=Email.Smtp.Domain&key=Email.Smtp.EnableSsl&key=Email.Smtp.FromDisplayName&key=Email.Smtp.FromEmail&key=Email.Smtp.Host&key=Email.Smtp.Password&key=Email.Smtp.Port&key=Email.Smtp.UseDefaultCredentials&key=Email.Smtp.UserName' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json'

Voici la réponse pour un appel réussi :

[
    {
        "id": 6,
        "key": "Email.Smtp.FromEmail",
        "value": "[e-mail]",
        "partitionGlobalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "userId": null
    },
    {
        "id": 7,
        "key": "Email.Smtp.FromDisplayName",
        "value": "Hogwarts server - 21.10 - Clean",
        "partitionGlobalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "userId": null
    },
    {
        "id": 15,
        "key": "Email.Smtp.Domain",
        "value": "",
        "partitionGlobalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "userId": null
    },
    {
        "id": 16,
        "key": "Email.Smtp.EnableSsl",
        "value": "true",
        "partitionGlobalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "userId": null
    },
    {
        "id": 17,
        "key": "Email.Smtp.Port",
        "value": "587",
        "partitionGlobalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "userId": null
    },
    {
        "id": 18,
        "key": "Email.Smtp.UseDefaultCredentials",
        "value": "false",
        "partitionGlobalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "userId": null
    },
    {
        "id": 19,
        "key": "Email.Smtp.UserName",
        "value": "[e-mail]",
        "partitionGlobalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "userId": null
    },
    {
        "id": 20,
        "key": "Email.Smtp.Host",
        "value": "smtp.gmail.com",
        "partitionGlobalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "userId": null
    },
    {
        "id": 21,
        "key": "Email.Smtp.Password",
        "value": "protego-spell",
        "partitionGlobalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "userId": null
    }
]