Zum Hauptinhalt wechseln
Dokumentation
Dokumentation
Adaptive Planning
Zuletzt aktualisiert: 2023-06-23
Berechtigungssätze

Berechtigungssätze

URL-Endpunkt

https://api.adaptiveplanning.com/api/rest/security/<version>/<tenant>/users/permissionSets
Version: v1
Kategorie
Datenaktualisierung
Beschreibung
Weisen Sie Adaptive Planning-Benutzern Berechtigungssätze zu.
Berechtigung zum Aufrufen erforderlich
Benutzer
mit Administratorzugriff
,
Berechtigungssätze
Mit der API für die Berechtigungssatzzuweisung können Sie Benutzerberechtigungssätze abrufen und zuweisen.

Unterstützte HTTPS-VERBs:

HTTP Verb
Einzelressource
Einzugsressource
Beschreibung
GET
Nicht unterstützt
Unterstützt
Ruft alle Benutzer und die ihnen zugewiesenen Berechtigungssätze ab.
POST
Unterstützt
Unterstützt
Fügt einen Berechtigungssatz hinzu oder aktualisiert einen vorhandenen Berechtigungssatz für einen Benutzer.

GET

Anfordern
/users/permissionSets
Ruft eine Sammlung von Berechtigungssätzen ab, die Benutzern zugewiesen sind
Ruft alle Benutzer und die ihnen zugewiesenen Berechtigungssätze ab. Sie können nach instanceCode filtern. Wenn der Abfrageparameter instanceCode fehlt, ruft die API alle Benutzer und deren Berechtigungssätze in Ihrer Standardinstanz ab. Die Paginierung verwendet die Standardwerte für Grenzwert oder Versatz, wenn Sie diese Abfrageparameter nicht angeben.
Beispiel für eine Anforderungs-URI:
HTTPS://api.adaptiveinsights.com/api/rest/security/v1/default/users/
Abfrageparameter:
Name
Beschreibung
Erforderlich
instanceCode
Die eindeutige ID einer Instanz, die den Instanzkontext definiert.
N
limit
Die maximale Anzahl von Objekten in einer einzelnen Antwort. Der Standardwert ist 500. Maximal sind 500 zulässig.
N
offset
Der 0-basierte Index des ersten Benutzers in einer Antwortsammlung. Der Standardwert ist 0.
Verwenden Sie Offset mit dem Grenzwert-Parameter, um das Paging einer Antworterfassung zu steuern.
N
Beispielantwort
Beispielantwort aus einer vom Benutzer mit Workday synchronisierten Instanz
 


  "links": {
      "next": "https://api.adaptiveinsights.com/api/rest/security/v1/default/users/permissionSets?offset=10&limit=5",
      "previous": "https://api.adaptiveinsights.com/api/rest/security/v1/default/users/permissionSets?offset=0&limit=5"
  },{
  "total": 34,
  "users": [
      {
    "userGuid": "111SampleUserGuid",
    "wid": "14400000000000000000000000000samplewid",
    "userName": "sampleuser1@company.com",
    "permissionSet": [
      {
        "id": 1,
        "name": "samplePermissionSet1"
      }
    ]
  },
      {
    "userGuid": "112SampleUserGuid",
    "wid": "24400000000000000000000000000samplewid",
    "userName": "sampleuser3@company.com",
    "permissionSet": [
      {
        "id": 1,
        "name": "samplePermissionSet1"
      }
    ]
  },
      {
    "userGuid": "113SampleUserGuid",
    "wid": "34400000000000000000000000000samplewid",
    "userName": "sampleuser3@company.com",
    "permissionSet": [
      {
        "id": 2,
        "name": "samplePermissionSet2"
      }
    ]
  },
      {
    "userGuid": "114SampleUserGuid",
    "wid": "44400000000000000000000000000samplewid",
    "userName": "sampleuser4@company.com",
    "permissionSet": [
      {
        "id": 3,
        "name": "samplePermissionSet3"
      }
    ]
  },
      {
    "userGuid": "115SampleUserGuid",
    "wid": "54400000000000000000000000000samplewid",
    "userName": "sampleuser5@company.com",
    "permissionSet": [
      {
        "id": 4,
        "name": "samplePermissionSet4"
      }
    ]
  }
]
}

POST:

Anfrage:
/users/permissionSets:
Weist Berechtigungssätze für Benutzer zu oder aktualisiert sie.
Fügt einen Berechtigungssatz hinzu oder aktualisiert einen vorhandenen Berechtigungssatz für einen Benutzer. Sie können nach instanceCode filtern. Wenn der Abfrageparameter instanceCode fehlt, weist die API allen Benutzern in Ihrer Standardinstanz die entsprechenden Berechtigungssätze zu. Geben Sie im Anforderungstext die folgenden erforderlichen Abfragefelder an: <userIdentifier> und permissionSet. Um eine Massenanforderung für die Zuweisung entsprechender Berechtigungssätze mehreren Benutzern zu übermitteln, geben Sie ein Array an, das jede Berechtigungszuweisung enthält.
Abfrageparameter:
Name
Beschreibung
Erforderlich
instanceCode
Die eindeutige ID einer Instanz, die den Instanzkontext definiert.
N
userIdentifier
Die Benutzer-ID, um die eindeutige Benutzer-ID für Adaptive Planning zu bestimmen. Mögliche Werte: userName, wid, userGuid.
J
Beispielanforderung:
HTTPS://api.adaptiveinsights.com/api/rest/security/v1/default/users/permissionSets?userIdentifier=userName
Beispielanforderungstext
Beispiel für POST-Anforderungstext
 
[  
  {  
      "userName": "sampleuser1@company.com",
          "permissionSet": [
                  {
                      "name": "samplePermissionSet1"
                  }
      ]
  },
  {
      "userName": "sampleuser2@company.com",
          "permissionSet": [
                  {
                      "name": "samplePermissionSet2"
                  }
          ]
  },
  {
      "userName": "sampleuser3@company.com",
          "permissionSet": [
                  {
                      "name": "samplePermissionSet3"
                  }
          ]
  }
]
PayLoad-Parameter
Name
Beschreibung
Erforderlich
wid
Die Workday-ID eines Benutzers.
N
userName
Der Benutzername (Anmeldename) eines Benutzers.
N
userGuid
Die eindeutige Benutzer-ID Global, die beim Erstellen vom System zugewiesen wird.
N
Name
id
Name des Berechtigungssatzes.
ID des Berechtigungssatzes.
Entweder Name oder ID des Berechtigungssatzes ist erforderlich.
J