automation-suite
2023.10
true
- Erste Schritte
- Authentication
- Scopes und Berechtigungen
- Plattformverwaltungs-APIs
[Vorschau] Benutzer ändern
Automation Suite API-Handbuch
Last updated 20. Aug. 2024
[Vorschau] Benutzer ändern
Aktualisiert die Informationen über den angegebenen lokalen Benutzer.
--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.
Parameter |
Datentyp |
Beschreibung |
---|---|---|
(erforderlich) |
String |
Die ID des Benutzers, den Sie aktualisieren möchten. |
Der Anforderungstext enthält die Benutzerinformationen, die Sie aktualisieren möchten, z. B. Name, E-Mail-Adresse oder Gruppenmitgliedschaft.
{
"name": "string",
"surname": "string",
"email": "user@example.com",
"isActive": true,
"password": "string",
"groupIDsToAdd": [
"string"
],
"groupIDsToRemove": [
"string"
],
"bypassBasicAuthRestriction": true,
"invitationAccepted": true
}
{
"name": "string",
"surname": "string",
"email": "user@example.com",
"isActive": true,
"password": "string",
"groupIDsToAdd": [
"string"
],
"groupIDsToRemove": [
"string"
],
"bypassBasicAuthRestriction": true,
"invitationAccepted": true
}
Das Update konnte nicht ausgeführt werden.
{
"errors": {
"bypassBasicAuthRestriction": [
"Unexpected character encountered while parsing value: h. Path 'bypassBasicAuthRestriction', line 17, position 35.",
"Unexpected character encountered while parsing value: a. Path 'bypassBasicAuthRestriction', line 17, position 35."
]
},
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
"title": "One or more validation errors occurred.",
"status": 400,
"traceId": "00-aec3de9099a9934e9c31e26c19f5e0dd-8c0d3d5f476c7742-00"
}
{
"errors": {
"bypassBasicAuthRestriction": [
"Unexpected character encountered while parsing value: h. Path 'bypassBasicAuthRestriction', line 17, position 35.",
"Unexpected character encountered while parsing value: a. Path 'bypassBasicAuthRestriction', line 17, position 35."
]
},
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
"title": "One or more validation errors occurred.",
"status": 400,
"traceId": "00-aec3de9099a9934e9c31e26c19f5e0dd-8c0d3d5f476c7742-00"
}
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). - Sie möchten die Informationen und die Mitgliedschaft der Benutzer-ID
her-1909
aktualisieren.
Der Aufruf sollte wie folgt aussehen (cURL):
curl --location --request PUT 'https://{yourDomain}/{organizationName}/{tenantName}/identity_/api/User/her-1909' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json'
--data-raw '{
"name": "Hermione",
"surname": "Granger-Weasley",
"email": "hermione@hogwarts.com",
"groupIDsToAdd": [
"gryff-01",
"alumni-02",
"teachers-03"
],
"groupIDsToRemove": [],
"bypassBasicAuthRestriction": false
}'
curl --location --request PUT 'https://{yourDomain}/{organizationName}/{tenantName}/identity_/api/User/her-1909' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json'
--data-raw '{
"name": "Hermione",
"surname": "Granger-Weasley",
"email": "hermione@hogwarts.com",
"groupIDsToAdd": [
"gryff-01",
"alumni-02",
"teachers-03"
],
"groupIDsToRemove": [],
"bypassBasicAuthRestriction": false
}'
Hier ist die Antwort für einen erfolgreichen Aufruf:
{
"succeeded": true,
"errors": []
}
{
"succeeded": true,
"errors": []
}