automation-suite
2023.10
true
Automation Suite API-Handbuch
Last updated 20. Aug. 2024

[Vorschau] Gruppe ändern

Aktualisiert die Informationen über die angegebene lokale Gruppe.

API-Endpunkt

PUT https://{yourDomain}/identity_/api/Group/{groupId}

Scopes

Folgende Scopes sind erforderlich:

  • PM.Group
  • PM.Group.Write

Anforderungsheader

--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.

Pfadparameter

Parameter

Datentyp

Beschreibung

groupId

(erforderlich)

String

Die ID der Gruppe, die Sie aktualisieren möchten.

Anforderungstext

Der Anforderungstext enthält die Organisations-ID, zu der die Gruppe gehört, und die Informationen, die Sie aktualisieren möchten, z. B. Gruppenname und Gruppenmitgliedschaften.

{
  "partitionGlobalId": "string",
  "name": "string",
  "directoryUserIDsToAdd": [
    "string"
  ],
  "directoryUserIDsToRemove": [
    "string"
  ]
}{
  "partitionGlobalId": "string",
  "name": "string",
  "directoryUserIDsToAdd": [
    "string"
  ],
  "directoryUserIDsToRemove": [
    "string"
  ]
}

Antworten

200 OK

Die benutzerdefinierte Gruppe wird mit den von Ihnen angegebenen Informationen aktualisiert.

Beispielanforderung

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 können den Gruppennamen unverändert beibehalten.
  • Sie möchten die Benutzer Luna und Neville zur Gruppe hinzufügen. Diese Benutzer haben die folgenden Benutzer-IDs:

    • Luna-Benutzer-ID: lun-1302
    • Neville-Benutzer-ID: nev-3007

Der Aufruf sollte wie folgt aussehen (cURL):

curl --location --request PUT 'https://{yourDomain}/{organizationName}/{tenantName}/identity_/api/Group/magic-7/gryff-01' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json'
--data-raw '{
    "partitionGlobalId": "magic-7",
    "name": "Gryffindors",
    "directoryUserIDsToAdd": [
        "lun-1302", "nev-3007"
    ],
    "directoryUserIDsToRemove": []
}'curl --location --request PUT 'https://{yourDomain}/{organizationName}/{tenantName}/identity_/api/Group/magic-7/gryff-01' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json'
--data-raw '{
    "partitionGlobalId": "magic-7",
    "name": "Gryffindors",
    "directoryUserIDsToAdd": [
        "lun-1302", "nev-3007"
    ],
    "directoryUserIDsToRemove": []
}'

Hier ist die Antwort für einen erfolgreichen Aufruf:

{
    "id": "gryff-01",
    "name": "Gryffindors",
    "displayName": "Gryffindors",
    "type": 1,
    "creationTime": "2021-10-19T15:37:49.1853184",
    "lastModificationTime": "2021-10-19T16:46:20.0742901",
    "members": [
        {
            "objectType": "DirectoryUser",
            "firstName": "Hermione",
            "lastName": "Granger",
            "jobTitle": "student",
            "companyName": "Hogwarts",
            "city": "London",
            "department": "magic",
            "displayName": "Hermione Granger",
            "source": "local",
            "identifier": "her-1909",
            "name": "Hermione",
            "email": "hermione@hogwarts.com"
        },
        {
            "objectType": "DirectoryUser",
            "firstName": "Harry",
            "lastName": "Potter",
            "jobTitle": ""student"",
            "companyName": "Hogwarts",
            "city": "London",
            "department": "magic",
            "displayName": "Harry Potter",
            "source": "local",
            "identifier": "har-3107",
            "name": "Harry",
            "email": "harry@hogwarts.com"
        },
        {
            "objectType": "DirectoryUser",
            "firstName": "Luna",
            "lastName": "Lovegood",
            "jobTitle": "student",
            "companyName": "Hogwarts",
            "city": "London",
            "department": "magic",
            "displayName": "Luna Lovegood",
            "source": "local",
            "identifier": "lun-1302",
            "name": "Luna",
            "email": "luna@hogwarts.com"
        },      
        {
            "objectType": "DirectoryUser",
            "firstName": "Ron",
            "lastName": "Weasley",
            "jobTitle": "student",
            "companyName": "Hogwarts",
            "city": "London",
            "department": "magic",
            "displayName": "Ron Weasley",
            "source": "local",
            "identifier": "ron-0103",
            "name": "Ron",
            "email": "ron@hogwarts.com"
        },
        {
            "objectType": "DirectoryUser",
            "firstName": "Neville",
            "lastName": "Longbottom",
            "jobTitle": "student",
            "companyName": "Hogwarts",
            "city": "London",
            "department": "magic",
            "displayName": "Neville Longbottom",
            "source": "local",
            "identifier": "nev-3007",
            "name": "Neville",
            "email": "neville@hogwarts.com"
        }      
    ]
}{
    "id": "gryff-01",
    "name": "Gryffindors",
    "displayName": "Gryffindors",
    "type": 1,
    "creationTime": "2021-10-19T15:37:49.1853184",
    "lastModificationTime": "2021-10-19T16:46:20.0742901",
    "members": [
        {
            "objectType": "DirectoryUser",
            "firstName": "Hermione",
            "lastName": "Granger",
            "jobTitle": "student",
            "companyName": "Hogwarts",
            "city": "London",
            "department": "magic",
            "displayName": "Hermione Granger",
            "source": "local",
            "identifier": "her-1909",
            "name": "Hermione",
            "email": "hermione@hogwarts.com"
        },
        {
            "objectType": "DirectoryUser",
            "firstName": "Harry",
            "lastName": "Potter",
            "jobTitle": ""student"",
            "companyName": "Hogwarts",
            "city": "London",
            "department": "magic",
            "displayName": "Harry Potter",
            "source": "local",
            "identifier": "har-3107",
            "name": "Harry",
            "email": "harry@hogwarts.com"
        },
        {
            "objectType": "DirectoryUser",
            "firstName": "Luna",
            "lastName": "Lovegood",
            "jobTitle": "student",
            "companyName": "Hogwarts",
            "city": "London",
            "department": "magic",
            "displayName": "Luna Lovegood",
            "source": "local",
            "identifier": "lun-1302",
            "name": "Luna",
            "email": "luna@hogwarts.com"
        },      
        {
            "objectType": "DirectoryUser",
            "firstName": "Ron",
            "lastName": "Weasley",
            "jobTitle": "student",
            "companyName": "Hogwarts",
            "city": "London",
            "department": "magic",
            "displayName": "Ron Weasley",
            "source": "local",
            "identifier": "ron-0103",
            "name": "Ron",
            "email": "ron@hogwarts.com"
        },
        {
            "objectType": "DirectoryUser",
            "firstName": "Neville",
            "lastName": "Longbottom",
            "jobTitle": "student",
            "companyName": "Hogwarts",
            "city": "London",
            "department": "magic",
            "displayName": "Neville Longbottom",
            "source": "local",
            "identifier": "nev-3007",
            "name": "Neville",
            "email": "neville@hogwarts.com"
        }      
    ]
}
  • API-Endpunkt
  • Scopes
  • Anforderungsheader
  • Pfadparameter
  • Anforderungstext
  • Antworten
  • 200 OK
  • Beispielanforderung

War diese Seite hilfreich?

Hilfe erhalten
RPA lernen – Automatisierungskurse
UiPath Community-Forum
Uipath Logo White
Vertrauen und Sicherheit
© 2005–2024 UiPath. Alle Rechte vorbehalten