REST-API für Benutzer

Verwenden Sie diese REST-API, um Benutzer zu verwalten.

Alle Benutzer abrufen

Tabelle 1. Alle Benutzer abrufen
Informationen zur REST-API Wert Beschreibung
URI /admin/resources/users  
Methode GET  
Rückgabe 200 Gibt eine Liste aller Benutzer zurück
404 Die Liste der Benutzer wurde nicht gefunden
500 Plattform System Manager hat beim Verarbeiten der Anforderung einen internen Fehler festgestellt.

Gibt eine Liste mit Benutzern zurück.

Sie können die Antwort aus GET-Aufrufen mithilfe von optionalen Parametern ändern. Weitere Informationen finden Sie unter Angepasste Antworten von GET-Aufrufen.

Antworthauptteil für "Alle Benutzer abrufen"

[
   {
      "deployment_options": "F",
      "created_time_raw": 1466796519054,
      "bidi_national_calendar": null,
      "state": "available",
      "updated_time": "Fri 24 Jun 2016 19:30:52.014 UTC",
      "version": "2.2.2.0",
      "id": "/admin/resources/users/c39bd607-876f-4f09-9ca2-54b7a91dbb51",
      "user_extras": [
         "/admin/resources/user_extras/6dc165d2-e6b6-4669-b595-d429c2103d48"
      ],
      "full_cloud_group": "T",
      "user_groups": [
         "/admin/resources/user_groups/175d9ecc-a8d1-42bd-aab1-51790e088272"
      ],
      "name": "Default Admin",
      "bidi_text_direction": null,
      "is_internal": "F",
      "user_id": "admin",
      "current_message": null,
      "auth_mode": "internal",
      "isas_rn": 1,
      "label_text": "User",
      "label_key": "pure8500",
      "current_status": null,
      "updated_time_raw": 1466796652014,
      "email": null,
      "roles": [
         "/admin/resources/roles/a6b4475e-b35e-4712-b19b-90d87e7be71e",
         "/admin/resources/roles/90a1dc6c-d6df-4170-bb33-923074a3a1ba",
         "/admin/resources/roles/e0ef6e59-0be9-41df-9a82-b4d9499d0d6b",
         "/admin/resources/roles/18ec963f-6255-413a-9c4d-c78b2059ce4c",
         "/admin/resources/roles/059825f6-4d1c-44c9-8789-583b24573b8e",
         "/admin/resources/roles/0267a153-1965-4af2-afb9-07ebbdc14d8b",
         "/admin/resources/roles/0f5da4f6-92a2-498e-a408-e3c23ab1c9ec",
         "/admin/resources/roles/5f08df4a-920c-47f6-be22-51bd035e6ae1",
         "/admin/resources/roles/e8fd5f19-3436-478e-aca6-25f907f86865",
         "/admin/resources/roles/ade2a33f-2c26-491d-93ca-d0d5c6bbb8ca",
         "/admin/resources/roles/546bf38e-e85c-49f4-8402-1a28961705b7",
         "/admin/resources/roles/dd08fbcc-5063-40c5-9c45-401c13daf240",
         "/admin/resources/roles/db3523e8-6e05-45ac-91da-55ccc1bae6f7",
         "/admin/resources/roles/bd551e91-6e73-4ef1-927e-545c5a940573",
         "/admin/resources/roles/bbe22d24-fee4-4787-ae9f-3f256694807c",
         "/admin/resources/roles/bfa9da5b-adf0-40e2-88cc-83784d0ddfbf",
         "/admin/resources/roles/4f26bc1e-ca6c-424d-8202-df4ac4d9419a",
         "/admin/resources/roles/4797dc65-94a9-43c6-8b61-063a764e7651",
         "/admin/resources/roles/4ff50c2a-bf80-425d-b6a0-82cd43558210",
         "/admin/resources/roles/8b83d2bd-016e-431c-810f-a16aa5ce40ea",
         "/admin/resources/roles/d152825a-817c-4da8-821f-9c464f41eec1",
         "/admin/resources/roles/001b4b26-13f1-4494-8be3-8ea19bd7387e",
         "/admin/resources/roles/3918de4e-9288-4327-9282-5fb7b7aa716a",
         "/admin/resources/roles/7dc0581d-de9e-446f-a608-f550c6114b63",
         "/admin/resources/roles/53e56f48-e6f8-4a62-9ab3-f7e0030c9b2f",
         "/admin/resources/roles/917ec40d-165e-469a-9db9-2290d962ebc0",
         "/admin/resources/roles/fd13c260-9bbd-4c94-a787-01b806d30ca2",
         "/admin/resources/roles/c32a926e-7aa3-4295-ae2f-721ad208cfc4",
         "/admin/resources/roles/56889d55-efc0-4154-8124-ca995067e747",
         "/admin/resources/roles/4ff92ca7-b0c2-4207-8398-aa4dad182933",
         "/admin/resources/roles/cd942abd-6a9a-4585-b485-74d2b1784a31"
      ],
      "acls": [
         "/admin/resources/acls/9bf2a777-151a-421f-a1c1-21282034d6e2",
         "/admin/resources/acls/3d9dc334-a3de-4700-9aca-3e5dcbd7ca2e",
         "/admin/resources/acls/0cb5edce-34fd-45cb-9f5c-1f46e30e3e14",
         "/admin/resources/acls/b163b998-0ea1-4d16-9386-d76ebbc9c936",
         "/admin/resources/acls/2d657b95-fefd-494c-90bc-2c1d5558690b",
         "/admin/resources/acls/f049474f-33e9-4b53-8d11-88d0b1ed79c7",
         "/admin/resources/acls/bf6ac568-eac7-4bcf-8189-eebc83ec64f6",
         "/admin/resources/acls/fe31ba0b-eb35-4d60-addb-434b5fe046c0",
         "/admin/resources/acls/63db275c-cf0d-4a50-891b-ba210fa0d737",
         "/admin/resources/acls/d9f9f719-b244-4124-860f-6ffa78f6bcd7",
         "/admin/resources/acls/674ab78b-a37e-4873-8742-5ade88206592",
         "/admin/resources/acls/081c67b6-0208-482b-b683-9fdf3243f5b2",
         "/admin/resources/acls/bdaa9fd0-1744-4381-8528-3ad1f2fc6b52",
         "/admin/resources/acls/5f14e5ae-cd78-45bd-ac32-f06ce0e40e82",
         "/admin/resources/acls/6d0d357b-c754-45a0-ab85-cb695ef405ee",
         "/admin/resources/acls/0d037351-5737-40ab-9f5e-56e897694b0a",
         "/admin/resources/acls/194362a0-0b2b-4acc-a969-3e12b3cc9005",
         "/admin/resources/acls/7546d132-0b74-46a0-aed6-725b4455ac53",
         "/admin/resources/acls/ef5a4b1d-b5da-4cb9-ad8e-ce94511fb8b1",
         "/admin/resources/acls/ab2b81a9-6750-4014-b24f-ebe57566d616",
         "/admin/resources/acls/72ea00dc-1055-4256-9d72-3904c1e418e4",
         "/admin/resources/acls/ffc2e26d-0f69-4a57-9db8-169abfdcc6c6",
         "/admin/resources/acls/57487335-0a74-4108-b9c2-64264326992a",
         "/admin/resources/acls/206b9de8-68d5-4794-a75e-4848d59ce84d",
         "/admin/resources/acls/796b2b22-9be1-4358-babe-94d0a7254856",
         "/admin/resources/acls/1625b9b2-56bc-4407-8a6d-ecf88672fb88",
         "/admin/resources/acls/9ca02dc2-c236-4d79-891b-01673cdfca55",
         "/admin/resources/acls/0ab3b7b8-a9e6-49d5-839a-59312a2f6c99",
         "/admin/resources/acls/0b05f408-f679-4288-819b-2b69a86886ae",
         "/admin/resources/acls/2c346983-5873-4df0-ab58-304372b5a77a",
         "/admin/resources/acls/c30d2341-844a-4c03-9750-36d64f9a18ef",
         "/admin/resources/acls/d97b4961-a700-431b-9c7b-c9a23c45c466",
         "/admin/resources/acls/a6b94ab5-3e1b-4bab-b950-8a8b1c3f306a",
         "/admin/resources/acls/0a44ae5a-0e38-4230-80b6-0cd3a5944ca3",
         "/admin/resources/acls/3332cf70-52d7-49f9-92a5-b71e0631e25e",
         "/admin/resources/acls/a6a95502-358c-45a8-a1a2-e8d07315fc29",
         "/admin/resources/acls/0377527f-5764-4dc3-900e-b2b360757cbd",
         "/admin/resources/acls/09234bd7-c1b3-4835-a34e-3000a2d22af2",
         "/admin/resources/acls/134606ac-8c81-469f-8559-e81a5b586658",
         "/admin/resources/acls/b34d21e1-ad55-4a85-a88e-b71ee44a6ed2",
         "/admin/resources/acls/533e1595-a076-4949-b8f2-4336c9cf550f",
         "/admin/resources/acls/d5007654-12fb-4c22-a515-de24b47eeaaf",
         "/admin/resources/acls/21d50681-99e3-4b63-8148-4f8338dee8cc",
         "/admin/resources/acls/2e109792-c3d9-4c05-b308-f20b2f10ffbb",
         "/admin/resources/acls/619376ff-00d1-4dd2-9cab-dc38fb4b9fc3",
         "/admin/resources/acls/51eab512-788f-4bbf-af2d-48290e0d0c7f",
         "/admin/resources/acls/d1ce9cd9-8c86-4fc1-b74f-a8c09a0cc8e0",
         "/admin/resources/acls/c1cf8baa-a2a7-46c7-9e6b-c0b0384fcaf8",
         "/admin/resources/acls/1eea1d91-37a4-49d8-bd0f-29ecf4ae7dc6",
         "/admin/resources/acls/14bceabf-0be1-4661-88d8-ddec566dcdc9",
         "/admin/resources/acls/09171ea3-120a-4c74-a59b-83577f5400fa",
         "/admin/resources/acls/9c607db4-80b1-4e15-a1c0-750ffca87668",
         "/admin/resources/acls/facc4c37-47d6-4b92-8b9c-ef3c90e80421",
         "/admin/resources/acls/6ac24410-f431-4dcf-9263-3debc97f1e52",
         "/admin/resources/acls/f61a63b1-32e5-403c-ba3c-03e7be23bdfc",
         "/admin/resources/acls/30a731ec-184b-403b-9abd-c180bdd2b84b",
         "/admin/resources/acls/906bb99a-782d-432c-bf3d-fa9ee63e36eb",
         "/admin/resources/acls/dce4f307-1f5c-4b2d-b304-c9e9350935dc",
         "/admin/resources/acls/f62971df-6df9-42b3-85fa-d5603e11ab6d",
         "/admin/resources/acls/a36b0266-3bb0-40ec-b437-ac63d9871c9e",
         "/admin/resources/acls/370ae1cb-ce9d-4c30-be3b-333801d11cdd",
         "/admin/resources/acls/e3a24b10-f86b-43ec-9a80-05c84b40ab28",
         "/admin/resources/acls/3d352fa2-efcc-4a4a-82e9-9f4f2ac20793",
         "/admin/resources/acls/5f1ebd6f-2bda-42a9-aef5-931fa9d307fa",
         "/admin/resources/acls/13eb4bc2-06f7-43c2-b9cb-bf08e0c17017",
         "/admin/resources/acls/ed93f109-c307-44e0-acc0-1380fff5d892",
         "/admin/resources/acls/4e2f2e7c-64f9-4cf3-865a-15b2f9507228",
         "/admin/resources/acls/1e41d320-3109-40c5-9fe1-2261be618785",
         "/admin/resources/acls/9c30cedd-419b-468e-87cd-4c20e66b4141",
         "/admin/resources/acls/3b2baf0d-0e66-460f-bca9-c5c90076468d"
      ],
      "is_disabled": "F",
      "created_time": "Fri 24 Jun 2016 19:28:39.054 UTC"
   }
]
auth_mode
Der Authentifizierungsmodus des Benutzers: ldap (für externes Repository) oder internal (für lokales Repository).
created_time
Die Erstellungszeit des Objekts.
current_message
Die aktuelle Nachricht für den Benutzer.
current_status
Der aktuelle Status des Benutzers.
deployment_options
Flag, das den Geltungsbereich der Implementierungsmöglichkeiten des Benutzers anzeigt: nur Cloud, nur Umgebungsprofil oder Alle.
E-Mail
Die E-Mail-Adresse des Benutzers.
ID
Die eindeutige ID des Objekts im System.
is_disabled
Flag, das anzeigt, ob der Benutzer inaktiviert ist oder nicht.
is_internal
Flag, das anzeigt, ob der Benutzer ein interner Benutzer ist oder nicht.
label_key
Der Schlüssel für den Abruf der Bezeichnung für den Benutzer.
label_text
Übersetzter Standardnachrichtentext.
Name
Benutzername
public_key
Der öffentliche Schlüssel für den Benutzer.
roles
Die Rollen des Benutzers.
state
Die allgemeine Verfügbarkeit des Objekts. Hat das Objekt den Status "pending", wurde es gefunden, aber nicht aktiviert. Wenn das Objekt den Status "available" hat, ist es im System aktiv.
updated_time
Die Zeit, zu der das Objekt zuletzt aktualisiert wurde.
user_extras
Die modifizierbaren Zusatzdaten für den Benutzer.
user_id
Die ID des Benutzers. Die Benutzer-ID muss im System eindeutig sein.

Untergeordnete Elemente:

ACLs

Bestimmten Benutzer abrufen

Tabelle 2. Bestimmten Benutzer abrufen
Informationen zur REST-API Wert Beschreibung
URI /admin/resources/users/{id}  
Methode GET  
Rückgabe 200 Der Benutzer wurde zurückgegeben
404 Der Benutzer wurde nicht gefunden
500 Plattform System Manager hat beim Verarbeiten der Anforderung einen internen Fehler festgestellt.

Gibt den mit {id} angegebenen Benutzer zurück.

Sie können die Antwort aus GET-Aufrufen mithilfe von optionalen Parametern ändern. Weitere Informationen finden Sie unter Angepasste Antworten von GET-Aufrufen.

Benutzer erstellen

Tabelle 3. Benutzer erstellen
Informationen zur REST-API Wert Beschreibung
URI /admin/resources/users/{id}  
Methode POST  
Rückgabe 201 Der Benutzer wurde definiert und ist im Antwortteil enthalten. Die URL des neuen Benutzers ist in die Kopfzeile "Location" der Antwort eingeschlossen.
400 Dieser Code wird zurückgegeben, wenn beim Parsen der JSON-Daten in der Anforderung Probleme festgestellt werden.
403 Dieser Code wird zurückgegeben, wenn der anfordernde Benutzer über keine ausreichende Berechtigung verfügt, den neuen Benutzer zu definieren.
500 Dieser Code wird zurückgegeben, wenn Cloud Pak System Software beim Verarbeiten der Anforderung einen internen Fehler festgestellt hat.

Sie können die Antwort aus GET-Aufrufen mithilfe von optionalen Parametern ändern. Weitere Informationen finden Sie unter Angepasste Antworten von GET-Aufrufen.

Anforderungshauptteil für "Benutzer erstellen"

 {
"auth_mode": "internal",  
"name": "testNewE",  
"email": "testNewE@us.ibm.com", 
"user_id": "testNewE", 
"password": "mypassword"
}

Antworthauptteil "Benutzer erstellen"

{
   "currentmessage": "RM02013",
   "currentmessage_text": "User has not logged in yet",
   "currentstatus": "RM01062",
   "currentstatus_text": "Inactive",
   "email": "testNewE@us.ibm.com",
   "fullname": "New User",
   "groups": [
      "/resources/groups/1"
   ],
   "id": 3,
   "user_extras": [
   ],   
   "patterns": [
   ],
   "user_id": "newuser",
   "virtualsystems": [
   ]
}

Benutzer sperren und entsperren

Tabelle 4. Benutzer sperren und entsperren
Informationen zur REST-API Wert Beschreibung
URI /admin/resources/users/{id}  
Methode PUT  
Rückgabe 202 Der Benutzer wurde gesperrt oder entsperrt.
400 Ein ungültiger Anforderungshauptteil wurde angegeben.
403 Der anfordernde Benutzer ist nicht berechtigt, einen Benutzer zu sperren oder zu entsperren.
404 Der Benutzer wurde nicht gefunden.
500 Während der Verarbeitung der Anforderung ist ein interner Fehler aufgetreten

Sie können die Antwort aus GET-Aufrufen mithilfe von optionalen Parametern ändern. Weitere Informationen finden Sie unter Angepasste Antworten von GET-Aufrufen.

Anforderungshauptteil für "Benutzer sperren und entsperren"

Benutzer sperren:
{"locked":"T"}
Benutzer ohne Kennwortänderung entsperren:
{"locked":"F"}
Benutzer entsperren und Kennwort ändern:
{"locked":"F", "password":"newPW"}

Antworthauptteil für "Benutzer sperren und entsperren"

Der Inhalt der Zusatzdaten (user_extras) wird zurückgegeben.
{
"users": "/admin/resources/users/312c5985-767b-4262-aac2-d66b3da44b26",
"locked_time_raw": -1,
"failed_login_first_time_raw": 0,
"label_text": "Extra User Data",
"event_message": "User account is unlocked. user_extras data entry updated.",
"id": "/admin/resources/user_extras/054f70c4-cb4d-48aa-a09b-9521b1c9777e",
"failed_login_count": 0,
"pw_set_time_raw": 1394133857680,
"user_id": "testNewE"
}