Lesen und beachten Sie die Automation Anywhere-Dokumentation

Automation Anywhere

Inhalt schließen

Inhalte

Inhalt öffnen

APIs zum Verwalten des Anmeldedatentresors

  • Aktualisiert: 5/10/2019
    • 11.3.x
    • Erstellen
    • Enterprise
    • API-Dokumente

APIs zum Verwalten des Anmeldedatentresors

Als Enterprise Control Room-Nutzer mit der Rollenberechtigung Meine Anmeldedaten und Locker verwalten verwenden Sie die Credential Vault-APIs zum Verwalten Ihrer Anmeldedaten, Attribute, Locker und des Credential Vault-Modus in Enterprise Control Room.

  1. Die APIs zum Verwalten von Anmeldedaten können zum Erstellen, Aktualisieren und Löschen von Anmeldedaten verwendet werden.
  2. Die APIs zum Verwalten von Anmeldedatenattributen können zum Erstellen, Aktualisieren und Löschen der Attribute und Werte der Anmeldedaten verwendet werden.
  3. Die APIs zum Verwalten von Lockern können zum Hinzufügen, Bearbeiten und Entfernen von Lockern, einschließlich Verbrauchern und Mitgliedern, verwendet werden.
  4. Mit den APIs zum Verwalten des Modus für den Anmeldedatentresor können Sie den Verbindungsmodus konfigurieren, mit dem Sie sich mithilfe eines Hauptschlüssels mit dem Credential Vault verbinden.
Anmerkung: Die Beispiele in diesem Thema dienen lediglich als Referenz.

API-Endpunkt

Greifen Sie über den folgenden Endpunkt auf die Credential Vault-APIs zu: <Enterprise Control Room URL>/v2/credentialvault

Beispiel: https://crdevenv.com:81/v2/credentialvault

APIs zum Verwalten von Anmeldedaten

Verwenden Sie diese APIs, um Ihre Anmeldedaten im Enterprise Control Room zu verwalten.

Bevor Sie auf die Credential Vault-APIs zugreifen können, müssen Sie zuerst die Authentifizierungs-API verwenden und sie als Token übergeben, um eine bestimmte Credential Vault-API verwenden zu können.

  1. Verwenden Sie die POST-Methode, um ein Token anhand des Endpunkts https://<Hostname:Port>/v1/authentication zu generieren. Geben Sie hierzu die Enterprise Control Room-Instanz als Servernamen/Hostnamen/IP und die Port-Nummer an.

    Beispiel: https://crdevenv.com:81/v1/authentication

  2. Geben Sie die folgende Anfrage-Payload in Headern an:
    “X-Authorization” : “Authorization token” “Content-Type” : “application/json”
  3. Geben Sie die folgende Anfrage-Payload im Textkörper an:
     { "username": "<Username>", "password": "<Password>" } 
    Beispiel: {

    "usename": "Ellie.Brown",

    "password": "12345678"

    }

1. Anmeldedatensatz erstellen

Mit dieser API können Sie einen Anmeldedatensatz erstellen.

  1. Geben Sie die Parameter „X-Authorization“ und „Content Type“ in Headern an.
  2. Verwenden Sie die POST-Methode, um folgende Anfrage-Payload im Textkörper anzugeben:
    { "name": "<Credential Name>", "description": "<Credential Description>","attributes": [ { "name": "<Attribute Name>", "description": "<Attribute Description>", "userProvided": <true or false>, "masked": <true or false> } ] }
    Beispiel: Damti wird der Anmeldedatensatz „SharePoint Login“ mit dem „Username“ als Attribut erstellt:
    { "name": "SharePoint Login", "description": "Credentials to login to SharePoint", "attributes": [ { "name": "Username", "description": "Name of the user", "userProvided": true, "masked": true } ] }
  3. Klicken Sie auf Senden.
  4. Die Aktion war erfolgreich, wenn der Antwortstatus 201 Credential created lautet.
  5. Sie können die Antwort in den Textkörperdaten anzeigen.
    { "id": "10", "name": "SharePoint Login", "description": "Credentials to login to SharePoint", "ownerId": "1", "attributes": [ { "id": "58", "name": "Username", "description": "Name of the user", "userProvided": true, "masked": true, "createdBy": "1", "createdOn": "2018-07-16T06:04:32.905Z", "updatedBy": "1", "updatedOn": "2018-07-16T06:04:32.905Z", "version": "0" } ], "createdBy": "1", "createdOn": "2018-07-16T06:04:32.905Z", "updatedBy": "1", "updatedOn": "2018-07-16T06:04:32.905Z", "version": "0" }

Parameterbeschreibung

Parameter Beschreibung
name Name des Anmeldedatensatzes in der ersten Instanz und Attributname in der zweiten Instanz
description Beschreibung des Anmeldedatensatzes in der ersten Instanz und Beschreibung des Attributwerts in der zweiten Instanz
userProvided Gibt an, ob der Attributtyp Vom Nutzer bereitgestellt oder Standard lautet. Beim Typ Vom Nutzer bereitgestellt ist dieser Parameter auf true (den Standardparameter) eingestellt. Weitere Informationen zu Attributwerttypen finden Sie unter Anmeldedaten erstellen.
masked Gibt an, ob der Attributwert Maskiert lautet. Ist bei Verschlüsselung auf true eingestellt. Weitere Details finden Sie unter „Anmeldedaten erstellen“.

2. Liste der Anmeldedaten

Mit dieser API können Sie alle Anmeldedaten anzeigen, die einem Nutzer gehören oder auf die er über einen Locker Zugriff hat. Wenn der Nutzer ein Locker-Administrator ist, werden hier alle Anmeldedaten im System aufgelistet.

  1. Geben Sie in Headern den Parameter „X-Autorisierung” an.
  2. Mit der GET-Methode können Sie mit folgenden Parametern auf die APIs für Anmeldedaten zugreifen: http(s)://<hostname:port>/v2/credentialvault/credentials?consumed="<true oder false>"&name oder names="<nach Name(n) der Anmeldedaten filtern, durch Kommata getrennt>"

    Beispielsweise enthält die folgende Liste alle nicht verwendeten Anmeldedaten:

    https://crdevenv.com:81/v2/credentialvault/credentials?consumed=false

  3. Klicken Sie auf Senden.
  4. Die Aktion war erfolgreich, wenn der Antwortstatus 200 Found credentials lautet.
  5. Sie können die Antwort in den Textkörperdaten anzeigen:
    { "list": [ { "id": 12, "createdBy": 1, "createdOn": "2018-06-25T14:13:58+05:30", "updatedBy": 1, "updatedOn": "2018-06-25T14:13:58+05:30", "tenantId": 1, "version": 0, "name": "SharePoint Login", "description": "-", "lockerId": null, "ownerId": 1, "attributes": [ { "id": 61, "createdBy": 1, "createdOn": "2018-06-25T14:13:58+05:30", "updatedBy": 1, "updatedOn": "2018-06-25T14:13:58+05:30", "tenantId": 1, "version": 0, "name": "Username", "description": "-", "userProvided": true, "masked": true } ], "completed": false }, { "id": 11, "createdBy": 1, "createdOn": "2018-06-21T12:56:07+05:30", "updatedBy": 1, "updatedOn": "2018-06-21T13:00:22+05:30", "tenantId": 1, "version": 1, "name": "SharePoint-User1", "description": "name of the SharePoint user", "lockerId": null, "ownerId": 1, "attributes": [ { "id": 59, "createdBy": 1, "createdOn": "2018-06-21T12:56:07+05:30", "updatedBy": 1, "updatedOn": "2018-06-21T13:00:22+05:30", "tenantId": 1, "version": 1, "name": "SP-User1", "description": "name of the user", "userProvided": true, "masked": false }, { "id": 60, "createdBy": 1, "createdOn": "2018-06-21T13:00:22+05:30", "updatedBy": 1, "updatedOn": "2018-06-21T13:00:22+05:30", "tenantId": 1, "version": 0, "name": "Victor.Hugo", "description": null, "userProvided": true, "masked": false } ], "completed": false ] }

Parameterbeschreibung

Parameter Beschreibung
consumed Filtert die Anmeldedaten nach Fakten, wenn sie userProvided sind und vom aktuellen Nutzer verwendet werden.
name Filtert die Anmeldedaten nach einem einzelnen Namen.
names Filtert die Anmeldedaten nach einer durch Kommata getrennten Liste von Namen.

3. Anmeldedaten nach ID auflisten

Mit dieser API können Sie Details zu den Anmeldedaten anzeigen, deren ID Sie als Parameter angeben.

Tipp: Sie können die ID eines Anmeldedatensatzes in der Liste der Anmeldedaten ermitteln, die mit der API zum Auflisten der Anmeldedaten abgerufen wurden.
  1. Geben Sie die Parameter „X-Authorization“ und „Content Type“ in Headern an.
  2. Mit der GET-Methode können Sie mit folgenden Parametern auf die APIs für Anmeldedaten zugreifen: http(s)://<hostname:port>/v2/credentialvault/credentials/<id>

    Beispiel: Im Folgenden werden Nutzeranmeldedaten mit der ID 12 abgerufen: https://crdevenv.com:81/v2/credentialvault/credentials/12

  3. Klicken Sie auf Senden.

    Die Aktion war erfolgreich, wenn der Antwortstatus 200 lautet. Sie können die Antwort in den Textkörperdaten anzeigen:

    { "id": 12, "createdBy": 1, "createdOn": "2018-06-25T14:13:58+05:30", "updatedBy": 1, "updatedOn": "2018-06-25T14:13:58+05:30", "tenantId": 1, "version": 0, "name": "SharePoint Login", "description": "-", "lockerId": null, "ownerId": 1, "attributes": [ { "id": 61, "createdBy": 1, "createdOn": "2018-06-25T14:13:58+05:30", "updatedBy": 1, "updatedOn": "2018-06-25T14:13:58+05:30", "tenantId": 1, "version": 0, "name": "Username", "description": "-", "userProvided": true, "masked": true } ] }

4. Anmeldedaten aktualisieren

Mit dieser API können Sie vorhandene Anmeldedaten aktualisieren.

  1. Geben Sie die Parameter „X-Authorization“ und „Content Type“ in Headern an.
  2. Verwenden Sie die PUT-Methode, um auf die APIs für Anmeldedaten http(s)://<hostname:port>/v2/credentialvault/credentials/<id> zuzugreifen.

    Beispiel: Im Folgenden wird der Anmeldedatensatz mit der ID 12 aktualisiert: https://crdevenv.com:81/v2/credentialvault/credentials/12

  3. Geben Sie die folgende Anfrage-Payload im Textkörper an:
    { "id": "<Credential id>", "version": <Version id>, "name": "<Credential Name>", "description": "<Credential Description>", "lockerId": null, "ownerId": <the user ID of the owner>, "attributes": [ { "id": <Attribute id>, "version": 0, "name": "<Updated attribute name >", "description": "<Updated attribute description>", "userProvided": <False or true>, - Attribute type "masked": <false or true> masking is true or false } ] } 
    Wenn Sie beispielsweise die Beschreibung des Anmeldedatensatzes aktualisieren möchten, können Sie die folgenden Anforderungsparameter angeben:
    { "id": "12", "version": 0, "name": "SharePoint Login", "description": "Login details for SharePoint", "lockerId": null, "ownerId": <the user ID of the owner>, "attributes": [ { "id": 61, "version": 0, "name": "<Updated attribute name >", "description": "SharePoint Username", "userProvided": <False or true>, - Attribute type "masked": true } ] }
    Tipp: Sie können nur die Parameter eingeben, die Sie aktualisieren möchten, und die anderen Parameterwerte beibehalten, d. h. keine Änderung an ihnen vornehmen.
  4. Klicken Sie auf Senden.
  5. Die Aktion war erfolgreich, wenn der Antwortstatus 200 Credential updated lautet.
  6. Sie können die Antwort in den Textkörperdaten anzeigen:
    { "id": 12, "createdBy": 1, "createdOn": "2018-06-25T14:13:58+05:30", "updatedBy": 1, "updatedOn": "2018-06-25T14:13:58+05:30", "tenantId": 1, "version": 0, "name": "SharePoint Login", "description": "Login details for SharePoint", "lockerId": null, "ownerId": 1, "attributes": [ { "id": 61, "createdBy": 1, "createdOn": "2018-06-25T14:13:58+05:30", "updatedBy": 1, "updatedOn": "2018-06-25T14:13:58+05:30", "tenantId": 1, "version": 0, "name": "Username", "description": "SharePoint Username", "userProvided": true, "masked": true } ] }

Parameterbeschreibung

Parameter Beschreibung
id ID des Anmeldedatensatzes in der ersten Instanz und Attribut-ID in der zweiten Instanz. Diese kann mithilfe der API zum Abrufen der Anmeldedaten nach ID ermittelt werden.
version Aktualisierte Version der ID des Anmeldedatensatzes in der ersten Instanz und Attribut in der zweiten Instanz. Bei Abweichungen zwischen der früheren und aktuellen Version wird ein Konfliktfehler ausgegeben.
name Aktualisierter Anmeldedatensatz in der ersten Instanz und Attributwert in der zweiten Instanz
description Aktualisierter Anmeldedatensatz in der ersten Instanz und Beschreibung des Attributwerts in der zweiten Instanz
lockerId Locker-ID, sofern verfügbar. Wenn keine Locker-ID angegeben wurde, wird sie standardmäßig auf null festgelegt. Diese kann mithilfe der API zum Abrufen der Anmeldedaten nach ID ermittelt werden.
ownerId Die Nutzer-ID des Anmeldeinformationseigentümers. Diese kann mithilfe der API zum Abrufen der Anmeldedaten nach ID ermittelt werden.
userProvided Gibt an, ob der Attributtyp Vom Nutzer bereitgestellt oder Standard lautet. Beim Typ Vom Nutzer bereitgestellt ist dieser Parameter auf true (den Standardparameter) eingestellt. Weitere Informationen zu Attributwerttypen finden Sie unter „Anmeldedaten erstellen”.
masked Gibt an, ob der Attributwert Maskiert lautet. Ist bei Verschlüsselung auf true eingestellt. Weitere Details finden Sie unter „Anmeldedaten erstellen“.

5. Eigentum der Anmeldedaten aktualisieren

Mit dieser API können Sie das Eigentum an den Anmeldedaten aktualisieren.

  1. Geben Sie in Headern die „X-Autorisierung“-Parameter an.
  2. Verwenden Sie die PUT-Methode, um auf die APIs für Anmeldedaten zuzugreifen:

    http(s)://<hostname:port>/v2/credentialvault/credentials/<id>/owner/<credentialOwnerId>

    Beispiel: Im Folgenden wird das Eigentum an den Anmeldedaten mit der ID 12 von Eigentümer 1 in 2 geändert:

    https://crdevenv.com:81/v2/credentialvault/credentials/12/owner/2
  3. Klicken Sie auf Senden.
  4. Die Aktion ist erfolgreich, wenn der Antwortstatus 200 Successful update of credential ownership lautet.
  5. Sie können die Antwort in den Textkörperdaten anzeigen:

    {

    "id": 12, "createdBy": 1, "createdOn": "2018-06-25T14:13:58+05:30", "updatedBy": 1, "updatedOn": "2018-06-25T14:13:58+05:30", "tenantId": 1, "version": 0, "name": "SharePoint Login", "description": "Login details for SharePoint", "lockerId": null, "ownerId": 1,

    "attributes":

    [

    { "id": 61, "createdBy": 1, "createdOn": "2018-06-25T14:13:58+05:30", "updatedBy": 1, "updatedOn": "2018-06-25T14:13:58+05:30", "tenantId": 1, "version": 0, "name": "Username", "description": "SharePoint Username", "userProvided": true, "masked": true }

    ]

    }

Parameterbeschreibung

Parameter Beschreibung
id ID der Anmeldedaten. Diese kann mithilfe der API zum Abrufen der Anmeldedaten nach ID ermittelt werden.
credentialOwnerId ID des Anmeldeinformationseigentümers. Diese kann mithilfe der API zum Abrufen der Anmeldedaten nach ID ermittelt werden.

6. Anmeldedaten löschen

Mit dieser API können Sie die Anmeldedaten löschen, deren ID Sie als Parameter angeben.

  1. Geben Sie in Headern die „X-Autorisierung“-Parameter an.
  2. Mit der DELETE-Methode können Sie mit folgenden Parametern auf die APIs für Anmeldedaten zugreifen:

    http(s)://<hostname:port>/v2/credentialvault/credentials/<id>

    Beispiel: Im Folgenden wird der Anmeldedatensatz mit der ID 11 gelöscht:

    https://crdevenv.com:81/v2/credentialvault/credentials/11

  3. Klicken Sie auf Senden.

    Die Aktion war erfolgreich, wenn der Antwortstatus 204 Successful Delete lautet.

APIs zum Verwalten von Anmeldedatenattributen

Als Enterprise Control Room-Nutzer mit der Berechtigung ALLE Attributwerte für Anmeldedaten anzeigen und bearbeiten verwenden Sie die APIs für die Anmeldedatenattribute, um Ihre Anmeldedatenattribute und die zugehörigen Werte im Enterprise Control Room zu verwalten. Mit dieser API erstellen, bearbeiten und entfernen Sie Werte aus von Nutzern erstellten Anmeldedaten.

Bevor Sie auf die Credential Vault-APIs zugreifen können, müssen Sie zuerst die Authentifizierungs-API verwenden und sie als Token übergeben, um eine bestimmte Credential Vault-API verwenden zu können.

  1. Verwenden Sie die POST-Methode, um ein Token anhand des Endpunkts https://<Hostname:Port>/v1/authentication zu generieren. Geben Sie hierzu die Enterprise Control Room-Instanz als Servernamen/Hostnamen/IP und die Port-Nummer an.

    Beispiel: https://crdevenv.com:81/v1/authentication

  2. Verwenden Sie die POST-Methode, um auf die APIs für Anmeldedaten zuzugreifen.

    Beispiel: GET https://crdevenv.com:81/v2/credentialvault/credentials

  3. Geben Sie die folgende Anfrage-Payload in Headern an:

    “X-Authorization” : “Authorization token”

    “Content-Type” : “application/json”

1. Attributwert erstellen

Mit dieser API können Sie einen Attributwert von Anmeldedaten erstellen, deren ID Sie als Parameter angeben

  1. Geben Sie die Parameter „X-Authorization“ und „Content Type“ in Headern an.
  2. Verwenden Sie die POST-Methode, um auf die APIs für Anmeldedaten zuzugreifen:

    http(s)://<hostname:port>/v2/credentialvault/credentials/<id>/attributevalue

    Beispiel: Im Folgenden wird ein Attribut username für die Anmeldedaten-ID 12 erstellt:

    https://crdevenv.com:81/v2/credentialvault/credentials/12/username

  3. Geben Sie die Anfrage-Payload im Textkörper an:
    [ { "credentialAttributeId": "<Attribute Id>", "value": "<attribute value>" } ] 

    Beispiel: Für den Anmeldedatensatz "SharePoint Login", der im vorherigen Beispiel mit der ID "12" erstellt wurde, können Sie für das Attribut "username" mit der ID "30" den Wert wie folgt hinzufügen:

    [

    {

    "credentialAttributeId": "30",

    "value": "Jane Smith"

    }

    ]

  4. Klicken Sie auf Senden.
  5. Die Aktion war erfolgreich, wenn der Antwortstatus 201 Credential attribute values created lautet.
  6. Sie können die Antwort in den Textkörperdaten anzeigen:

    [

    {

    "id":30,"createdBy":1,"createdOn":"2018-06-27T14:18:13+05:30","updatedBy":1,"updatedOn":"2018-06-27T14:18:13+05:30","tenantId":1,"version":0,"userId":null,"value":"Jane.Smith","credentialAttributeId":62

    }

    ]

Parameterbeschreibung

Parameter Beschreibung
credentialAttributeId ID des Attributs. Diese kann mithilfe der API zum Abrufen der Anmeldedaten nach ID ermittelt werden.
value Attributwert, den Sie bereitstellen möchten

2. Liste der Attributwerte für Anmeldedaten

Mit dieser API können Sie alle Standard- und nutzerdefinierten Werte für einen bestimmten Anmeldedatensatz auflisten.

  1. Geben Sie in Headern die „X-Autorisierung“-Parameter an.
  2. Mit der GET-Methode können Sie mit folgenden Parametern auf die APIs für Anmeldedaten zugreifen:

    http(s)://<hostname:port>/v2/credentialvault/credentials/<id>/attributevalues

    Beispiel: Für die Anmeldedaten "SharePoint Login" mit der ID "12" können Sie für das Attribut "username" mit der ID "30" den Wert wie folgt hinzufügen:

    https://crdevenv.com:81/v2/credentialvault/credentials/12/attributevalues

  3. Klicken Sie auf Senden.

    Die Aktion war erfolgreich, wenn der Antwortstatus 200 Credential attribute values found lautet.

  4. Sie können die Antwort in den Textkörperdaten anzeigen:

    { "list":[

    {

    "id": 30, "createdBy": 1, "createdOn": "2018-06-27T14:16:20+05:30", "updatedBy": 1, "updatedOn": "2018-06-27T14:16:20+05:30", "tenantId": 1, "version": 0, "userId": null, "value": "Jane.Smith", "credentialAttributeId": 62

    }

    ]}

Parameterbeschreibung

Parameter Beschreibung
id ID der Anmeldedaten. Diese kann mithilfe der API zum Abrufen der Anmeldedaten nach ID ermittelt werden.
credentialAttributeId ID des Attributs. Diese kann mithilfe der API zum Abrufen der Anmeldedaten nach ID ermittelt werden.
userId ID des Enterprise Control Room-Nutzers

3. Attributwert von Anmeldedaten aktualisieren

Mit dieser API können Sie den Wert eines Attributs der angegebenen Anmeldedaten aktualisieren.

  1. Geben Sie die Parameter „X-Authorization“ und „Content Type“ in Headern an.
  2. Mit der PUT-Methode können Sie mit folgenden Parametern auf die APIs für Anmeldedaten zugreifen:

    http(s)://<hostname:port>/v2/credentialvault//credentials/<id>/attributevalues/<attributeValueId>

    Beispiel: Für die Anmeldedaten "SharePoint Login" mit der ID "12" können Sie für das Attribut "username" mit der ID "30" den Wert wie folgt aktualisieren:

    https://crdevenv.com:81/v2/credentialvault/credentials/12/attributevalues/30

  3. Geben Sie die Anfrage-Payload im Textkörper an:

    [

    {

    "id": "<Attribute value id>", "version": 0, "value": "<Attribute value>", "credentialAttributeId": "<Attribute ID>"

    }

    ]

  4. Klicken Sie auf Senden.

    Die Aktion war erfolgreich, wenn der Antwortstatus 200 Credential attribute value updated lautet.

  5. Sie können die Antwort in den Textkörperdaten anzeigen:

    [

    {

    "id":30,"createdBy":1,"createdOn":"2018-06-27T14:47:55+05:30","updatedBy":1,"updatedOn":"2018-06-27T14:47:55+05:30","tenantId":1,"version":0,"userId":null,"value":"","credentialAttributeId":62

    }

    ]

Parameterbeschreibung

Parameter Beschreibung
id ID des Attributwerts. Diese kann mithilfe der API zum Abrufen der Anmeldedaten nach ID ermittelt werden.
version Versionsnummer des aktualisierten Attributwerts
credentialAttributeId ID des Attributs. Diese kann mithilfe der API zum Abrufen der Anmeldedaten nach ID ermittelt werden.

Attributwert von Anmeldedaten löschen

Mit dieser API können Sie den Wert eines Attributs der angegebenen Anmeldedaten löschen.

  1. Geben Sie in Headern die „X-Autorisierung“-Parameter an.
  2. Verwenden Sie die DELETE-Methode, um den Attributwert der Anmeldedaten mithilfe der APIs für Anmeldedaten mit den folgenden Parametern zu löschen:

    http(s)://<hostname:port>/v2/credentialvault/credentials/<id>/values/<attributeValueId>

    Beispiel: https://crdevenv.com:81/v2/credentialvault/credentials/12/values/30
  3. Klicken Sie auf Senden.
  4. Die Aktion war erfolgreich, wenn der Antwortstatus 204 Successful Delete lautet.

APIs zum Verwalten von Lockern

Als Enterprise Control Room-Administrator mit der Berechtigung Alle Locker-Berechtigungen verwalten oder Enterprise Control Room-Nutzer mit der Berechtigung Eigene Locker verwalten können Sie die APIs zum Verwalten von Lockern dazu verwenden, Locker, Verbraucher und Mitglieder im Enterprise Control Room zu erstellen, zu aktualisieren und zu löschen.

Bevor Sie auf diese APIs zugreifen können, müssen Sie zuerst die Authentifizierungs-API verwenden und sie als Token übergeben, um eine bestimmte Credential Vault-API verwenden zu können.

  1. Verwenden Sie die POST-Methode, um ein Token anhand des Endpunkts https://<Hostname:Port>/v1/authentication zu generieren. Geben Sie hierzu die Enterprise Control Room-Instanz als Servernamen/Hostnamen/IP und die Port-Nummer an.

    Beispiel: https://crdevenv.com:81/v1/authentication

  2. Verwenden Sie die POST-Methode, um auf die APIs für Anmeldedaten zuzugreifen.

    Beispiel: GET https://crdevenv.com:81/v2/credentialvault/lockers

  3. Geben Sie die folgende Anfrage-Payload in Headern an:

    "X-Authorization": "Authorization token"

    "Content-Type": “application/json“

1. Liste der Locker

Diese API ruft eine Liste der Locker ab, deren Mitglied der angemeldete Nutzer (Eigentümer, Manager oder Teilnehmer) ist oder für die er eine Nutzungsberechtigung besitzt. Wenn der Nutzer Locker-Administrator ist, ruft diese API die Liste aller Locker im System ab.

  1. Geben Sie in Headern den Parameter „X-Autorisierung” an.
  2. Mit der GET-Methode können Sie mit folgenden Parametern auf die APIs für Locker zugreifen:

    http(s)://<hostname:port>/v2/credentialvault/lockers?consumed="<true oder false>"

    Beispielsweise enthält die folgende Liste alle nicht verwendeten Lockernamen:

    https://crdevenv.com:81/v2/credentialvault/lockers?consumed=false

  3. Klicken Sie auf Senden.
  4. Die Aktion war erfolgreich, wenn der Antwortstatus 200 Lockers found lautet.
  5. Sie können die Antwort in den Textkörperdaten anzeigen:

    { "list":

    [

    {

    "id": 2, "name": "SharePoint Locker", "description": "", "createdBy": 2, "createdOn": "2018-07-04T09:40:49.187Z", "updatedBy": 2, "updatedOn": "2018-07-04T09:41:04.682Z", "tenantId": 1, "version": 1

    },

    {

    "id": 3, "name": "Outlook Locker", "description": "", "createdBy": 2, "createdOn": "2018-07-04T09:47:33.532Z", "updatedBy": 2, "updatedOn": "2018-07-04T09:47:33.532Z", "tenantId": 1, "version": 0

    }

    ]}

Parameterbeschreibung

Parameter Beschreibung
id Locker-ID
name Name des Lockers
description Beschreibung des Lockers
consumed Angabe, ob der Locker vom angemeldeten Nutzer verbraucht wird. Diese kann „True” oder „False” lauten.

2. Einen Locker erstellen

Mit dieser API können Sie einen Locker erstellen.

  1. Geben Sie die Parameter „X-Authorization“ und „Content Type“ in Headern an.
  2. Verwenden Sie die POST-Methode, um auf die APIs für Locker zuzugreifen: http(s)://<hostname:port>/v2/credentialvault/credentials/<id>/attributevalue
    • Beispiel:Im Folgenden wird ein Attribut username für die Anmeldedaten-ID 12 erstellt:https://crdevenv.com:81/v2/credentialvault/credentials/12/username

  3. Geben Sie die Anfrage-Payload im Textkörper an:
    { "name":"<Locker name>" , "description":"<Locker description>" }
    • Beispiel: Im Folgenden wird ein Locker mit der Bezeichnung "SalesForce" erstellt:
      { "name": "SalesForce Locker", "description": "Use this to store all credentials for the SalesForce application" }
  4. Klicken Sie auf Senden.
  5. Die Aktion war erfolgreich, wenn der Antwortstatus 201 Locker created lautet.
  6. Sie können die Antwort in den Textkörperdaten anzeigen:
    { "id": 4, "name": "SalesForce Locker", "description": "Use this to store all credentials for the SalesForce application", "createdBy": 2, "createdOn": "2018-07-04T09:55:04.045Z", "updatedBy": 2, "updatedOn": "2018-07-04T09:55:04.045Z", "tenantId": 1, "version": 0 }

Parameterbeschreibung

Parameter Beschreibung
name Name des Lockers, wie vom Locker-Administrator angegeben
description Beschreibung des Lockers

3. Liste aller Locker mit zusätzlichen Feldern

Diese API ruft eine Liste der Locker ab, deren Mitglied der angemeldete Nutzer (Eigentümer, Manager oder Teilnehmer) ist oder für die er eine Nutzungsberechtigung besitzt. Wenn der Nutzer Locker-Administrator ist, ruft diese API die Liste aller Locker im System ab. Die Antwort enthält Locker-Mitglieder und die Anzahl der Anmeldedatensätze je Locker.

  1. Geben Sie in Headern den Parameter „X-Autorisierung” an.
  2. Mit der GET-Methode können Sie mit folgenden Parametern auf die APIs für Locker zugreifen:

    http(s)://<hostname:port>/v2/credentialvault/lockers/advanced

    • Beispiel: Im Folgenden werden alle Lockernamen mit zusätzlichen Feldern aufgeführt:

      https://crdevenv.com:81/v2/credentialvault/lockers/advanced

  3. Klicken Sie auf Senden.
  4. Die Aktion war erfolgreich, wenn der Antwortstatus 200 Lockers found lautet.
  5. Sie können die Antwort in den Textkörperdaten anzeigen:

    { "list":[

    { "id": 2, "name": "SharePoint Locker", "description": "", "createdBy": 2, "createdOn": "2018-07-04T09:40:49.187Z", "updatedBy": 2, "updatedOn": "2018-07-04T10:10:04.163Z", "tenantId": 1, "version": 2, "members": [ { "id": 1, "permissions": [ "participate", "manage" ] }, { "id": 2, "permissions": [ "participate", "own", "manage" ] } ], "countOfCredentials": 1 },

    { "id": 3, "name": "Outlook Locker", "description": "", "createdBy": 2, "createdOn": "2018-07-04T09:47:33.532Z", "updatedBy": 2, "updatedOn": "2018-07-04T09:47:33.532Z", "tenantId": 1, "version": 0, "members": [ { "id": 2, "permissions": [ "participate", "own", "manage" ] } ], "countOfCredentials": 0 },

    { "id": 4, "name": "SalesForce Locker", "description": "-", "createdBy": 2, "createdOn": "2018-07-04T09:55:04.045Z", "updatedBy": 2, "updatedOn": "2018-07-04T09:55:04.045Z", "tenantId": 1, "version": 0, "members": [ { "id": 2, "permissions": [ "participate", "own", "manage" ] } ], "countOfCredentials": 0 }

    ]}

4. Locker nach ID auflisten

Mit dieser API können Sie Lockerdetails anhand der ID abrufen.
Tipp: Sie können die Id eines Lockers in der Liste der Locker nachsehen, die mit der API zum Auflisten von Lockern abgerufen wurde.
  1. Geben Sie die Parameter „X-Authorization“ und „Content Type“ in Headern an.
  2. Mit der GET-Methode können Sie mit folgenden Parametern auf die APIs für Anmeldedaten zugreifen:

    http(s)://<hostname:port>/v2/credentialvault/lockers/<id>

    • Beispiel: Ein Locker mit der ID 2 wird folgendermaßen abgerufen:

      https://crdevenv.com:81/v2/credentialvault/lockers/2

  3. Klicken Sie auf „Senden”.
  4. Die Aktion war erfolgreich, wenn der Antwortstatus 200 Locker lautet.
  5. Sie können die Antwort in den Textkörperdaten anzeigen:

    {

    "id": 2, "name": "SharePoint Locker", "description": "", "createdBy": 2, "createdOn": "2018-07-04T09:40:49.187Z", "updatedBy": 2, "updatedOn": "2018-07-04T10:10:04.163Z", "tenantId": 1, "version": 2

    }

5. Locker aktualisieren

Mit dieser API können Sie die Werte eines bestimmten Lockers aktualisieren.

  1. Geben Sie die Parameter „X-Authorization“ und „Content Type“ in Headern an.
  2. Mit der PUT-Methode können Sie mit folgenden Parametern auf die APIs für Anmeldedaten zugreifen:

    http(s)://<hostname:port>/v2/credentialvault//lockers/<id>

    • Beispiel: Für den Locker "SharePoint Locker" mit der Id "2" können den Wert wie folgt aktualisieren:

      https://crdevenv.com:81/v2/credentialvault/lockers/2

  3. Geben Sie die Anfrage-Payload im Textkörper an:

    {

    "id": "<locker id>", "name": "<updated lockername>", "description": "<updated description>", "version": 0

    }

  4. Klicken Sie auf Senden.
  5. Die Aktion war erfolgreich, wenn der Antwortstatus 200 Locker updated lautet.
  6. Sie können die Antwort in den Textkörperdaten anzeigen:

    {

    "id": 2, "createdBy": 8, "createdOn": "2018-06-16T10:59:33Z", "updatedBy": 8, "updatedOn": "2018-06-16T10:59:37Z", "version": 1, "name": "SharePoint-Locker", "description": "Locker to manage SharePoint credentials"

    }

Parameterbeschreibung

Parameter Beschreibung
id ID des Lockers. Diese kann mithilfe der API zum Abrufen von Lockern nach ID ermittelt werden
version Versionsnummer des aktualisierten Locker-Werts
name Aktualisierter Name des Lockers
description Aktualisierte Beschreibung des Lockers

6. Locker löschen

Mit dieser API können Sie den Locker löschen, dessen ID Sie als Parameter angeben.

  1. Geben Sie in Headern die „X-Autorisierung“-Parameter an.
  2. Verwenden Sie die DELETE-Methode, um die Anmeldedaten eines Lockers mithilfe von Locker-APIs mit den folgenden Parametern zu entfernen:

    http(s)://<hostname:port>/v2/credentialvault/lockers/<id>

    • Beispiel: Die Anmeldedaten mit der ID 4 werden folgendermaßen gelöscht:

      https://crdevenv.com:81/v2/credentialvault/lockers/4

  3. Klicken Sie auf Senden.
  4. Die Aktion war erfolgreich, wenn der Antwortstatus 204 Successful Delete lautet.

7. Alle Locker-Verbraucher auflisten

Mit dieser API können Sie die Liste der Rollen abrufen, die Anmeldedaten im Locker verwenden können.

  1. Geben Sie in Headern die „X-Autorisierung“-Parameter an.
  2. Mit der GET-Methode können Sie mit folgenden Parametern auf die APIs für Locker zugreifen:

    http(s)://<hostname:port>/v2/credentialvault/lockers/<id>/consumers

    • Beispiel: Im Folgenden werden die Rollen abgerufen, die Anmeldedaten aus dem Locker mit der ID 2 verwenden können:

      https://crdevenv.com:81/v2/credentialvault/lockers/2/consumers

  3. Klicken Sie auf Senden.
  4. Die Aktion war erfolgreich, wenn der Antwortstatus 204 Successful lautet.
  5. Sie können die Antwort in den Textkörperdaten anzeigen:

    {

    "list":

    [

    { "id": "14" }

    ]

    }

8. Locker-Verbraucher hinzufügen

Mit dieser API können Sie einen Verbraucher zum angegebenen Locker hinzufügen.

  1. Geben Sie die Parameter „X-Authorization“ und „Content Type“ in Headern an.
  2. Mit der PUT-Methode können Sie mit folgenden Parametern auf die APIs für Locker zugreifen:

    http(s)://<hostname:port>/v2/credentialvault/lockers/<id>/consumers

    • Beispiel: Im Folgenden stellen Sie eine Verbindung zum Locker mit der ID 2 her, zu dem Sie die Rolle mit der Verbraucher-ID 14 hinzufügen möchten:

      https://crdevenv.com:81/v2/credentialvault/lockers/2

  3. Geben Sie die Anfrage-Payload im Textkörper an:

    {

    "id": "<consumer id>"

    }
    • Beispiel:

      {

      "id": 14

      }

  4. Klicken Sie auf Senden.
  5. Die Aktion ist erfolgreich, wenn der Antwortstatus 204 Successful creation of locker consumer lautet.

Parameterbeschreibung

Parameter Beschreibung
id ID des Locker-Verbrauchers. Diese kann mithilfe der API zum Abrufen von Lockern nach ID ermittelt werden

9. Locker-Verbraucher entfernen

Mit dieser API können Sie Verbraucher aus dem angegebenen Locker entfernen.

  1. Geben Sie in Headern die „X-Autorisierung“-Parameter an.
  2. Verwenden Sie die DELETE-Methode, um die Anmeldedaten eines Locker-Verbrauchers mithilfe von Locker-APIs mit den folgenden Parametern zu entfernen:

    http(s)://<hostname:port>/v2/credentialvault/lockers/<lockerId>/consumers/<roleId>

    • Beispiel: Im Folgenden werden die Anmeldedaten mit der ID 2 gelöscht:

      https://crdevenv.com:81/v2/credentialvault/lockers/2/consumers/14

  3. Klicken Sie auf „Senden”.
  4. Die Aktion war erfolgreich, wenn der Antwortstatus 204 Successful Delete lautet.

10. Alle Locker-Mitglieder auflisten

Mit dieser API können Sie die Liste aller Nutzer abrufen, die Anmeldedaten zum angegebenen Locker hinzufügen, aus ihm entfernen oder die Locker-Einstellungen bearbeiten können.

  1. Geben Sie in Headern die „X-Autorisierung“-Parameter an.
  2. Mit der GET-Methode können Sie mit folgenden Parametern auf die APIs für Locker zugreifen:

    http(s)://<hostname:port>/v2/credentialvault/lockers/<lockerId>/members

    • Beispiel: Im Folgenden werden die Nutzer abgerufen, die Nutzer zum Locker mit der ID 2 hinzufügen bzw. aus ihm entfernen können:

      https://crdevenv.com:81/v2/credentialvault/lockers/2/members

  3. Klicken Sie auf Senden.
  4. Die Aktion war erfolgreich, wenn der Antwortstatus 200 Locker Members lautet.
  5. Sie können die Antwort in den Textkörperdaten anzeigen:

    {

    "list":

    [

    {

    "id": 1, "permissions": [ "participate", "manage" ]

    },

    {

    "id": 2, "permissions": [ "participate", "own", "manage" ]

    }

    ]

    }

11. Locker-Mitglied hinzufügen oder aktualisieren

Mit dieser API können Sie einen Nutzer hinzufügen, der Anmeldedaten zum Locker hinzufügen, aus ihm entfernen oder die Locker-Einstellungen bearbeiten kann.

  1. Geben Sie die Parameter „X-Authorization“ und „Content Type“ in Headern an.
  2. Mit der PUT-Methode können Sie Nutzer mit den APIs für Locker mit folgenden Parametern hinzufügen/aktualisieren:

    http(s)://<hostname:port>/v2/credentialvault/lockers/<lockerId>/members/<userId>

    • Beispiel: Im Folgenden stellen Sie eine Verbindung zum Locker mit der ID 2 her, zu dem Sie den Nutzer mit der Mitglieds-ID 3 hinzufügen möchten:

      https://crdevenv.com:81/v2/credentialvault/lockers/2/members/3

  3. Geben Sie die Anfrage-Payload im Textkörper an:

    {

    "permissions":

    ["permission type"]

    }

    • Beispiel:

      {

      "permissions":

      ["participate", "manage"]

      }

  4. Klicken Sie auf Senden.
  5. Die Aktion ist erfolgreich, wenn der Antwortstatus 204 Successful creation/update of locker member lautet.

Parameterbeschreibung

Parameter Beschreibung
permissions Berechtigung, die dem Nutzer gewährt wird. Mögliche Werte: own, participate und/oder manager.

12. Locker-Mitglied entfernen

Mit dieser API können Sie Locker-Nutzer oder -Mitglieder aus dem angegebenen Locker entfernen.

  1. Geben Sie in Headern die „X-Autorisierung“-Parameter an.
  2. Verwenden Sie die DELETE-Methode, um die Anmeldedaten eines Locker-Verbrauchers mithilfe von Locker-APIs mit den folgenden Parametern zu entfernen:

    http(s)://<hostname:port>/v2/credentialvault/lockers/<lockerId>/members/<userId>

    • Beispiel: Im Folgenden wird der Locker-Nutzer mit der ID 3 gelöscht:

      https://crdevenv.com:81/v2/credentialvault/lockers/2/members/3

  3. Klicken Sie auf Senden.
  4. Die Aktion ist erfolgreich, wenn der Antwortstatus 204 Successful removal of locker member lautet.

13. Anmeldedaten zu einem Locker hinzufügen

Mit dieser API können Sie einem Locker, für den Sie Eigentümer-, Manager- oder Teilnehmerberechtigungen haben, Ihre eigenen Anmeldedaten hinzufügen.

  1. Geben Sie in Headern die „X-Autorisierung“-Parameter an.
  2. Verwenden Sie die PUT-Methode, um einem Locker mithilfe der API für Anmeldedaten mit folgenden Parametern Anmeldedaten hinzuzufügen:

    http(s)://<hostname:port>/v2/credentialvault/lockers/<lockerId>/credentials/<credentialId>

    • Beispiel: Im Folgenden wird dem Locker mit der ID 2 ein Anmeldedatensatz hinzugefügt: https://crdevenv.com:81/v2/credentialvault/lockers/2/credentials/58
  3. Klicken Sie auf Senden.
  4. Die Aktion ist erfolgreich, wenn der Antwortstatus 200 Credential has been added to the locker lautet.

14. Alle Locker-Anmeldedaten auflisten

Mit dieser API können Sie die Liste der Anmeldedaten in einem Locker abrufen, für den Sie Eigentümer-, Manager- oder Teilnehmerberechtigungen haben.

  1. Geben Sie in Headern die „X-Autorisierung“-Parameter an.
  2. Verwenden Sie die GET-Methode, um die Liste der Anmeldedaten mithilfe der API für Anmeldedaten mit folgenden Parametern abzurufen:
    http(s)://<hostname:port>/v2/credentialvault/lockers/<lockerId>/credentials/
    • Beispiel: Im Folgenden werden alle Anmeldedaten aufgelistet, die zum Locker mit der ID 2 hinzugefügt werden:

      https://crdevenv.com:81/v2/credentialvault/lockers/2/credentials/

  3. Klicken Sie auf Senden.
  4. Die Aktion war erfolgreich, wenn der Antwortstatus 200 Locker credentials lautet.
  5. Sie können die Antwort in den Textkörperdaten anzeigen:

    { "list": [

    {

    "id": 10, "name": "SharePoint Credentials", "description": "", "completed": false, "lockerId": 2, "ownerId": 2, "attributes":

    [

    {

    "id": 58, "name": "username", "description": "", "userProvided": true, "masked": false, "createdBy": 2, "createdOn": "2018-07-04T10:09:32.854Z", "updatedBy": 2, "updatedOn": "2018-07-04T10:09:32.854Z", "tenantId": 1, "version": 0

    },

    {

    "id": 59, "name": "password", "description": "", "userProvided": true, "masked": true, "createdBy": 2, "createdOn": "2018-07-04T10:09:32.854Z", "updatedBy": 2, "updatedOn": "2018-07-04T10:09:32.854Z", "tenantId": 1, "version": 0

    }

    ],

    "createdBy": 2, "createdOn": "2018-07-04T10:09:32.854Z", "updatedBy": 2, "updatedOn": "2018-07-04T10:10:04.316Z", "tenantId": 1, "version": 1

    }

    ]}

15. Anmeldedaten aus Locker entfernen

Mit dieser API können Sie Locker-Nutzer oder -Mitglieder aus dem angegebenen Locker entfernen.

  1. Geben Sie in Headern die „X-Autorisierung“-Parameter an.
  2. Verwenden Sie die DELETE-Methode, um die Anmeldedaten eines Locker-Verbrauchers mithilfe von Locker-APIs mit den folgenden Parametern zu entfernen:

    http(s)://<hostname:port>/v2/credentialvault/lockers/<lockerId>/credentials/<credentialId>

    • Beispiel: Im Folgenden wird der Anmeldedatensatz mit der ID 59 aus dem Locker mit der ID 2 gelöscht:

      https://crdevenv.com:81/v2/credentialvault/lockers/2/credentials/59

  3. Klicken Sie auf Senden.
  4. Die Aktion ist erfolgreich, wenn der Antwortstatus 204 credential has been removed from the locker lautet

APIs zum Verwalten des Modus für den Anmeldedatentresor

Als Enterprise Control Room-Administrator mit der Berechtigung Einstellungen anzeigen und verwalten verwenden Sie die APIs zum Verwalten des Credential Vault-Modus, um den Credential Vault-Modus des Enterprise Control Room zu steuern.

Bevor Sie auf diese APIs zugreifen können, müssen Sie zuerst die Authentifizierungs-API verwenden und sie als Token übergeben, um eine bestimmte Credential Vault-API verwenden zu können.

  1. Verwenden Sie die POST-Methode, um ein Token anhand des Endpunkts https://<Hostname:Port>/v1/authentication zu generieren. Geben Sie hierzu die Enterprise Control Room-Instanz als Servernamen/Hostnamen/IP und die Port-Nummer an.

    Beispiel: https://crdevenv.com:81/v1/authentication

  2. Verwenden Sie die POST-Methode, um auf die APIs für Anmeldedaten zuzugreifen.

    Beispiel: GET https://crdevenv.com:81/v2/credentialvault/lockers

  3. Geben Sie die folgende Anfrage-Payload in Headern an:

    "X-Authorization": "Authorization token"

    "Content-Type": “application/json“

Aktuellen Modus für den Credential Vault anzeigen

Mit dieser API können Sie den aktuellen Modus anzeigen, der für die Verbindung zum Credential Vault verwendet wird. Dieser kann entweder „Express” oder „Manual” lauten.

  1. Geben Sie in Headern die „X-Autorisierung“-Parameter an.
  2. Mit der GET-Methode können Sie mit folgenden Parametern auf die Credential Vault-APIs zugreifen:
    http(s)://<hostname:port>/v2/credentialvault/mode
    • Beispiel: Der aktuelle Verbindungsmodus zum Credential Vault wird folgendermaßen angezeigt:

      https://crdevenv.com:81/v2/credentialvault/mode

  3. Klicken Sie auf „Senden/Ausführen”.
  4. Die Aktion ist erfolgreich, wenn der Antwortstatus 200 CV Mode has been successfully received lautet.
  5. Sie können die Antwort in den Textkörperdaten anzeigen:

    {

    "name": "Express"

    }

Modus für den Credential Vault aktualisieren

Mit dieser API können Sie den Modus ändern, der für die Verbindung zum Credential Vault verwendet wird. Dieser kann entweder „Express” oder „Manual” lauten.

  1. Geben Sie in Headern die „X-Autorisierung“-Parameter an.
  2. Mit der PUT-Methode können Sie mit folgenden Parametern auf die Credential Vault-APIs zugreifen:
    http(s)://<hostname:port>/v2/credentialvault/mode
    • Beispiel: Der aktuelle Verbindungsmodus zum Credential Vault wird folgendermaßen angezeigt:

      https://crdevenv.com:81/v2/credentialvault/mode

  3. Geben Sie die Anfrage-Payload im Textkörper an:

    {

    "name": "<mode>",

    "privatekey": "<CV Key>"

    }
    • Beispiel:

      {

      "name": "Manual",

      "privatekey": „ABC123”

      }

  4. Klicken Sie auf Senden/Ausführen.
  5. Die Aktion ist erfolgreich, wenn der Antwortstatus 204 CV Mode has been successfully set lautet.

Parameterbeschreibung

Parameter Beschreibung
name Verbindungstyp: Manual oder Express. Dieser wird bei der Erstkonfiguration von Enterprise Control Room angegeben. Weitere Informationen zum Aktualisieren des Modus über die Benutzeroberfläche von Enterprise Control Room finden Sie unter Enterprise Control RoomEinstellungen.
key Der Hauptschlüssel zum Herstellen einer Verbindung zum Credential Vault.

Prüfen Sie, ob der Hauptschlüssel angewendet wurde oder nicht.

Mit dieser API können Sie überprüfen, ob der Enterprise Control Room-Hauptschlüssel, der eine Verbindung zum Credential Vault herstellt, angewendet wurde oder nicht. Hiermit können Sie den Status des Credential Vault überprüfen.

  1. Geben Sie in Headern die „X-Autorisierung“-Parameter an.
  2. Mit der GET-Methode können Sie mit folgenden Parametern auf die Credential Vault-APIs zugreifen:
    http(s)://<hostname:port>/v2/credentialvault/keys/private
    • Beispiel:

      https://crdevenv.com:81/v2/credentialvault/keys/private

  3. Klicken Sie auf Senden/Ausführen.
  4. Die Aktion war erfolgreich, wenn der Antwortstatus 200 Private key status lautet.
  5. Sie können die Antwort in den Textkörperdaten anzeigen:

    {

    "applied": true

    }
    Anmerkung: Der Wert wird als false angezeigt, wenn der private Schlüssel nicht angewendet wurde.

Wenden Sie den Hauptschlüssel zum Entsperren des Anmeldedatentresors nach einem Neustart von Enterprise Control Room im manuellen Modus an.

Mit dieser API können Sie den Credential Vault nach dem Neustart des Enterprise Control Room im manuellen Verbindungsmodus entsperren. Hiermit können Sie überprüfen, ob eine Verbindung zum Credential Vault besteht.

  1. Geben Sie in Headern die „X-Autorisierung“-Parameter an.
  2. Mit der PUT-Methode können Sie mit folgenden Parametern auf die Credential Vault-APIs zugreifen:
    http(s)://<hostname:port>/v2/credentialvault/keys/private
    • Beispiel:

      https://crdevenv.com:81/v2/credentialvault/keys/private

  3. Geben Sie die Anfrage-Payload im Textkörper an:

    {

    "privateKey": "<CV Key>"

    }

  4. Klicken Sie auf Senden/Ausführen.
  5. Die Aktion ist erfolgreich, wenn der Antwortstatus 200 Private key has been successfully applied lautet.

Parameterbeschreibung

Parameter Beschreibung
privateKey Der Hauptschlüssel zum Herstellen einer Verbindung zum Credential Vault. Dieser wird bei der Erstkonfiguration des Enterprise Control Room angegeben. Sie können den Modus auch in den Enterprise Control RoomEinstellungen ändern, indem Sie diesen Schlüssel angeben.

API-Antwortcodes

Http(s)-Statuscode Antwort/Beschreibung Maßnahme
200/204 Aktion erfolgreich abgeschlossen n. v.
304 Keine Änderungen vorgenommen Aktualisieren nach Bedarf
400 Fehlerhafter Anfrageparameter Mit gültigen Parametern erneut versuchen
401 Authentifizierung erforderlich Authentifizierungsparameter angeben. Beispiel: Schlüssel für die X-Autorisierung
403 Nicht autorisierter Zugriff Sie müssen berechtigt sein, auf den Enterprise Control Room zuzugreifen.
404 Nicht gefunden Achten Sie darauf, dass die Anforderungs-Payload im Enterprise Control Room verfügbar ist
409 Konflikt Die angegebenen Parameter müssen korrekt sein
500 Interner Serverfehler Der Server muss betriebsbereit sein
501 Berechtigungsfehler Sicherstellen, dass Sie über die erforderliche Berechtigung verfügen

Auditprotokolle

Alle API-Aktivitäten werden auf der Auditprotokollseite von Enterprise Control Room protokolliert. Als Enterprise Control Room-Administrator oder -Nutzer mit der Berechtigung „Auditprotokoll-Aktionen aller Nutzer anzeigen” können Sie die Auditeinträge wie folgt anzeigen:

Seite „Überwachungsprotokoll” mit erfasster API-Aktivität

Die folgende Abbildung zeigt die Beispielseite eines Auditprotokolls zur Erstellung eines Lockers mit der Locker-API:

Seite „Auditprotokoll” mit Informationen zum Hinzufügen einer Locker-Aktivität

Feedback senden