automation-suite
2022.10
false
- Erste Schritte
- Authentication
- Scopes und Berechtigungen
- Plattformverwaltungs-APIs
- [Vorschau] Einstellungen abrufen
- [Vorschau] Einstellungen ändern
[Vorschau] Einstellungen abrufen
Wichtig :
Bitte beachten Sie, dass dieser Inhalt teilweise mithilfe von maschineller Übersetzung lokalisiert wurde.
Es kann 1–2 Wochen dauern, bis die Lokalisierung neu veröffentlichter Inhalte verfügbar ist.
Automation Suite API-Handbuch
Letzte Aktualisierung 12. Juli 2024
[Vorschau] Einstellungen abrufen
Verwenden Sie diesen Endpunkt, um die Liste der Schlüssel-Wert-Paare für E-Mail- und Authentifizierungseinstellungen abzurufen.
--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'
--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'
Hinweis: Um das
{access_token}
zu erhalten, müssen Sie sich mit einer der hier beschriebenen Methoden authentifizieren.
Abfrageparameter |
Datentyp |
Beschreibung |
---|---|---|
(optional) |
String |
Geben Sie den Namen der Einstellung ein, die Sie abrufen möchten. Um beispielsweise die SMTP-Domäneneinstellung abzurufen, geben Sie
key=Email.Smtp.Domain ein.
|
(optional) |
String |
Die ID der Organisation, für die Sie die Einstellungen abrufen möchten. |
(optional) |
String |
Die ID des Benutzers, für den Sie die Einstellungen abrufen möchten. |
Angenommen, Sie haben alle Informationen gesammelt, die zum Erstellen des API-Aufrufs erforderlich sind.
- Ihre
{baseURL}
ist:https://{yourDomain}/{organizationName}/{tenantName}/
-
Ihre
{access_token}
ist:1234
(aus Gründen der Länge). - Die
{partitionGlobalId}
lautet:magic-7
- Sie möchten die globalen E-Mail-Einstellungen abrufen, also melden Sie sich als Hostadministrator an. In diesem Fall geben Sie keine
userID
an.
Der Aufruf sollte wie folgt aussehen (cURL):
curl --location --request GET 'https://{yourDomain}/{organizationName}/{tenantName}/identity_/api/Setting?partitionGlobalId=magic-7&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'
curl --location --request GET 'https://{yourDomain}/{organizationName}/{tenantName}/identity_/api/Setting?partitionGlobalId=magic-7&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'
Hier ist der Antworttext für einen erfolgreichen Aufruf:
[
{
"id": 6,
"key": "Email.Smtp.FromEmail",
"value": "newalerts.uipath@gmail.com",
"partitionGlobalId": "magic-7",
"userId": null
},
{
"id": 7,
"key": "Email.Smtp.FromDisplayName",
"value": "Hogwarts server - 21.10 - Clean",
"partitionGlobalId": "magic-7",
"userId": null
},
{
"id": 15,
"key": "Email.Smtp.Domain",
"value": "",
"partitionGlobalId": "magic-7",
"userId": null
},
{
"id": 16,
"key": "Email.Smtp.EnableSsl",
"value": "true",
"partitionGlobalId": "magic-7",
"userId": null
},
{
"id": 17,
"key": "Email.Smtp.Port",
"value": "587",
"partitionGlobalId": "magic-7",
"userId": null
},
{
"id": 18,
"key": "Email.Smtp.UseDefaultCredentials",
"value": "false",
"partitionGlobalId": "magic-7",
"userId": null
},
{
"id": 19,
"key": "Email.Smtp.UserName",
"value": "newalerts.uipath@gmail.com",
"partitionGlobalId": "magic-7",
"userId": null
},
{
"id": 20,
"key": "Email.Smtp.Host",
"value": "smtp.gmail.com",
"partitionGlobalId": "magic-7",
"userId": null
},
{
"id": 21,
"key": "Email.Smtp.Password",
"value": "protego-spell",
"partitionGlobalId": "magic-7",
"userId": null
}
]
[
{
"id": 6,
"key": "Email.Smtp.FromEmail",
"value": "newalerts.uipath@gmail.com",
"partitionGlobalId": "magic-7",
"userId": null
},
{
"id": 7,
"key": "Email.Smtp.FromDisplayName",
"value": "Hogwarts server - 21.10 - Clean",
"partitionGlobalId": "magic-7",
"userId": null
},
{
"id": 15,
"key": "Email.Smtp.Domain",
"value": "",
"partitionGlobalId": "magic-7",
"userId": null
},
{
"id": 16,
"key": "Email.Smtp.EnableSsl",
"value": "true",
"partitionGlobalId": "magic-7",
"userId": null
},
{
"id": 17,
"key": "Email.Smtp.Port",
"value": "587",
"partitionGlobalId": "magic-7",
"userId": null
},
{
"id": 18,
"key": "Email.Smtp.UseDefaultCredentials",
"value": "false",
"partitionGlobalId": "magic-7",
"userId": null
},
{
"id": 19,
"key": "Email.Smtp.UserName",
"value": "newalerts.uipath@gmail.com",
"partitionGlobalId": "magic-7",
"userId": null
},
{
"id": 20,
"key": "Email.Smtp.Host",
"value": "smtp.gmail.com",
"partitionGlobalId": "magic-7",
"userId": null
},
{
"id": 21,
"key": "Email.Smtp.Password",
"value": "protego-spell",
"partitionGlobalId": "magic-7",
"userId": null
}
]