Oracle Cloud Infrastructure-Dokumentation

Allgemeine REST-Referenz (Standard-UI-gesteuert)

Im Folgenden finden Sie einige REST-API-Beispiele für die Konfiguration für das orchestrierte System.

API-Anforderungsantwort für Account erstellen

Verwenden Sie das folgende Beispiel, um die API "Account erstellen" zu konfigurieren:

API-Details für Konto erstellen

  • Name: Benutzer erstellen
  • Methode: POST
  • URL: <target-system>/admin/v1/Users
  • Kopfdaten
    • Content-Type: application/json
    • Authorization: <<CREDENTIALS>>. Der Wert <<CREDENTIALS>> wird zur Laufzeit mit OCI Vault- oder vom Benutzer eingegebenen Zugangsdaten aufgelöst, die in den Integrationseinstellungen konfiguriert sind.
  • Anforderungstext für REST-API

    Das im Beispiel gezeigte Attribut schemas:

    {
  "schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"],
  "userName": "<EL>attributes.get('name').get(0)</EL>",
  "name": {
    "givenName": "<EL>attributes.get('firstName').get(0)</EL>",
    "familyName": "<EL>attributes.get('lastName').get(0)</EL>"
  },
  "password": "<EL>attributes.get('password').get(0)</EL>",
  "emails": [
    {
      "value": "<EL>attributes.get('email').get(0)</EL>",
      "type": "work",
      "primary": true
    }
  ]
}
  • Antwort
    {
  "items": "",
  "responseValues": [],
  "attributes": [
    {
      "name": "uid",
      "value": "<JP>$.id</JP>",
      "responseOfSubRequestId": null,
      "items": null,
      "subAttributes": []
    }
  ]
}
    Diese API erstellt einen Zielaccount und ordnet die zurückgegebene ID dem Attribut uid zu.

API für Gruppensuche

API-Details für Gruppensuche

  • Name: Gruppensuche (Berechtigung)
  • Methode: POST
  • URL: <target-system>/admin/v1/Groups/.search
  • Kopfdaten
    • Content-Type: application/json
    • Authorization: <<CREDENTIALS>>. Der Wert <<CREDENTIALS>> wird zur Laufzeit mit OCI Vault- oder vom Benutzer eingegebenen Zugangsdaten aufgelöst, die in den Integrationseinstellungen konfiguriert sind.
  • Anforderungstext für REST-API

    Nehmen Sie das im Beispiel gezeigte Attribut schemas auf:

    {
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:SearchRequest"
  ],
  "attributes": [
    "displayName",
    "externalId"
  ],
  "sortBy": "displayName",
  "startIndex": "UQ:<EL>currentOffset</EL>",
  "count": "UQ:<EL>limit</EL>"
}
  • Antwort

    Verwenden Sie den JSON-Editor mit der folgenden Antwort:

    {
  "items": "<JP>$.Resources[*]</JP>",
  "responseValues": [],
  "attributes": [
    {
      "name": "uid",
      "value": "<JP>$.Resources[<EL>currentIndex</EL>].id</JP>",
      "responseOfSubRequestId": null,
      "items": null,
      "subAttributes": []
    },
    {
      "name": "name",
      "value": "<JP>$.Resources[<EL>currentIndex</EL>].displayName</JP>",
      "responseOfSubRequestId": null,
      "items": null,
      "subAttributes": []
    }
  ]
}

API für Ländersuche

  • Name: Suchländer
  • Methode: GET
  • URL: <target-system>/admin/v1/AllowedValues/countries
  • Kopfdaten
    • Content-Type: application/json
    • Authorization: <<CREDENTIALS>>. Der Wert <<CREDENTIALS>> wird zur Laufzeit mit OCI Vault- oder vom Benutzer eingegebenen Zugangsdaten aufgelöst, die in den Integrationseinstellungen konfiguriert sind.
  • Antwort

    Verwenden Sie den JSON-Editor mit der folgenden Antwort:

    {
  "items": "<JP>$.attrValues[*]</JP>",
  "responseValues": [],
  "attributes": [
    {
      "name": "uid",
      "value": "<JP>$.attrValues[<EL>currentIndex</EL>].value</JP>",
      "responseOfSubRequestId": null,
      "items": null,
      "subAttributes": []
    },
    {
      "name": "name",
      "value": "<JP>$.attrValues[<EL>currentIndex</EL>].value</JP>",
      "responseOfSubRequestId": null,
      "items": null,
      "subAttributes": []
    }
  ]
}

Gruppenmitgliedschafts-API hinzufügen

  • Name: Gruppenmitgliedschaft hinzufügen
  • Methode: PATCH
  • URL: <target-system>/admin/v1/Groups/<EL>attributes.get('groups').get('uid').get(0)</EL>
  • Kopfdaten
    • Content-Type: application/json
    • Authorization: <<CREDENTIALS>>. Der Wert <<CREDENTIALS>> wird zur Laufzeit mit OCI Vault- oder vom Benutzer eingegebenen Zugangsdaten aufgelöst, die in den Integrationseinstellungen konfiguriert sind.
  • Anforderung

    Verwenden Sie die folgende Anforderung:

    {
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:PatchOp"
  ],
  "Operations": [
    {
      "op": "add",
      "path": "members",
      "value": [
        {
          "value": "<EL>attributes.get('uid').get(0)</EL>",
          "type": "User"
        }
      ]
    }
  ]
}
  • Antwort
    Verwenden Sie den JSON-Editor mit der folgenden Antwort:
    Name: uid
Value: <EL>attributes.get('uid').get(0)</EL>
    Oder verwenden Sie den JSON-Editor
    {
  "items": "",
  "responseValues": [],
  "attributes": [
    {
      "name": "uid",
      "value": "<EL>attributes.get('uid').get(0)</EL>",
      "responseOfSubRequestId": null,
      "items": null,
      "subAttributes": []
    }
  ]
}

Account-API löschen

  • Name: Account-API löschen
  • Methode: LÖSCHEN
  • URL: <target-system>/admin/v1/Users/<EL>attributes.get('uid').get(0)</EL>
  • Kopfdaten
    • Content-Type: application/json
    • Authorization: <<CREDENTIALS>>. Der Wert <<CREDENTIALS>> wird zur Laufzeit mit OCI Vault- oder vom Benutzer eingegebenen Zugangsdaten aufgelöst, die in den Integrationseinstellungen konfiguriert sind.
  • Parameter: forceDelete: true
  • Antwort

    Verwenden Sie die folgende Antwort:

    Name: uid
Value: <EL>attributes.get('uid').get(0)</EL>
    Oder verwenden Sie den JSON-Editor
    {
  "items": "",
  "responseValues": [],
  "attributes": [
    {
      "name": "uid",
      "value": "<EL>attributes.get('uid').get(0)</EL>",
      "responseOfSubRequestId": null,
      "items": null,
      "subAttributes": []
    }
  ]
}