Wie erhalte ich die Benutzerprofilinformationen?

Es gibt verschiedene Möglichkeiten, wie Sie auf Benutzerinformationen zugreifen können, und verschiedene Gründe, warum Sie dies tun sollten. Der Endpunkt, den Sie aufrufen, kann abhängig von Ihrem Anwendungsfall variieren.

Wenn Sie mit einer API arbeiten müssen, sehen Sie in der folgenden Abbildung und den entsprechenden Informationen, wie die Informationen extrahiert werden.

/oauth/v4/<tenantID>/token

Nach erfolgreicher Authentifizierung erhalten Sie Zugriffs- und Identitätstoken mit den allgemeinen Benutzerinformationen, z. B. Namen, Bild oder einer E-Mail-Adresse. Zum Hinzufügen weiterer Informationen können Sie mit custom claims-mapping App ID so konfigurieren, dass die Informationen in das Token eingefügt werden, bevor es an Sie zurückgegeben wird.

/oauth/v4/<tenantID>/userinfo

Wenn Sie eine detaillierte Ansicht der Benutzerprofilinformationen benötigen, die von einem Identitätsprovider zurückgegeben werden, können Sie den /userinfo-Endpunkt aufrufen. Es wird empfohlen, diesen Endpunkt nur dann zu verwenden, wenn die Informationen nicht auf das Token abgebildet werden können, da er zusätzliche Netzwerkaufrufe erfordert.

/api/v1/attributes

Wenn Ihre Anwendung das Lesen und Aktualisieren von benutzerdefinierten Profilattributen für einen derzeit angemeldeten Benutzer erfordert, können Sie den Endpunkt '/attributes' verwenden. Der Benutzer möchte zum Beispiel eine Lebensmittelpräferenz aktualisieren.

/management/v4/<tenantID>/users

Wenn Sie Verwaltungsschnittstellen oder -prozesse erstellen, die für mehrere Benutzer gelten können, können Sie die App ID-Verwaltungs-API verwenden. Insbesondere können Sie den Endpunkt /users verwenden.

Die einfachste Möglichkeit, mit Benutzerinformationen zu arbeiten, ist die Verwendung der GUI oder eines SDK. Mit diesen Optionen werden alle API-Aufrufe im Hintergrund für Sie ausgeführt.

Auf Endpunkt /userinfo zugreifen

Wenn Sie die Informationen zu Benutzern anzeigen möchten, die von den konfigurierten Identitätsprovidern bereitgestellt werden, können Sie auf die vordefinierten Attribute zugreifen.

1. Stellen Sie sicher, dass Sie über ein gültiges Zugriffstoken mit dem Bereich openid verfügen. Sie können mithilfe des Endpunkts /introspect überprüfen, ob Ihr Token gültig ist.

2. Stellen Sie eine Anfrage an den Endpunkt /userinfo. Werden neue Token nicht explizit an das SDK übergeben, verwendet App ID die zuletzt empfangenen Token zum Abrufen und Validieren der Antwort. Die Übergabe eines Identitätstokens ist optional und dient zur Validierung der Antwort.

   GET https://<region>.appid.cloud.ibm.com/oauth/v4/<tenantID>/userinfo
   Authorization: 'Bearer <accessToken>'
   

   // iOS Swift example
   
   AppID.sharedInstance.userProfileManager.getUserInfo(accessToken: String, identityToken: String?) { (error: Error?, userInfo: [String: Any]?) in guard
      let userInfo = userInfo, err == nil {
         return // an error has occurred
      }
      // retrieved user info successfully
   }
   

   AppID appId = AppID.getInstance();
   
   appId.getUserProfileManager().getUserInfo(accessToken, identityToken, new UserProfileResponseListener() {
      @Override
      public void onSuccess(JSONObject userInfo) {
      // retrieved attribute "name" successfully
      }
   
      @Override
      public void onFailure(UserInfoException e) {
      // exception occurred
      }
   });
   

   let userProfileManager = UserProfileManager(options: options)
   
   let accessToken = req.session[WebAppStrategy.AUTH_CONTEXT].accessToken;
   let identityToken = req.session[WebAppStrategy.AUTH_CONTEXT].identityToken;
   
   // Retrieve user info and validate against the given identity token
   userProfileManager.getUserInfo(accessToken, identityToken).then(function (profile) {
      // retrieved user info successfully
   });
   
   // Retrieve user info without validation
   userProfileManager.getUserInfo(accessToken).then(function (profile) {
   // retrieved user info successfully
   });
   

   // Server-side Swift example
   
   let userProfileManager = UserProfileManager(options: options)
   let accessToken = "<accessToken>"
   let identityToken = "<identityToken>"
   
   // If identity token is provided (recommended approach), response is validated against the identity token
   
   userProfileManager.getUserInfo(accessToken: accessToken, identityToken: identityToken) { (err, userInfo) in guard
      let userInfo = userInfo, err == nil {
      return
      }
   }
   
   // Retrieve the UserInfo without any validation
   
   userProfileManager.getUserInfo(accessToken: accessToken) { (err, userInfo) in guard
      let userInfo = userInfo, err == nil {
      return
      }
   }
   

   Beispielausgabe:

   "sub": "cad9f1d4-e23b-3683-b81b-d1c4c4fd7d4c",
   "name": "John Doe",
   "email": "john.doe@gmail.com",
   "picture": "https://lh3.googleusercontent.com/-XdUIqdbhg/AAAAAAAAI/AAAAAAA/42rbcbv5M/photo.jpg",
   "gender": "male",
   "locale": "en",
   "identities": [
      {
            "provider": "google",
            "id": "104560903311317789798",
            "profile": {
               "id": "104560903311317789798",
               "email": "john.doe@gmail.com",
               "verified_email": true,
               "name": "John Doe",
               "given_name": "John",
               "family_name": "Doe",
               "link": "https://plus.google.com/104560903311317789798",
               "picture": "https://lh3.googleusercontent.com/-XdUIqdbhg/AAAAAAAAI/AAAAAAA/42rbcbv5M/photo.jpg",
               "gender": "male",
               "locale": "en",
               "idpType": "google"
            }
      }
   ]
   

3. Stellen Sie sicher, dass der Claim sub genau mit dem Claim sub im Identitätstoken übereinstimmt. Verwenden Sie die zurückgegebenen Informationen nicht, wenn diese Claims nicht übereinstimmen. Weitere Informationen zur Token-Substitution finden Sie in der OIDC-Spezifikation.

Wenn Änderungen von einem externen Identitätsprovider vorgenommen werden, erhalten Sie die aktualisierten Informationen bei der nächsten Anmeldung der Benutzer. Ihre neuen Token rufen die aktuellen Daten ab.

Auf Endpunkt /attributes zugreifen

Abhängig von Ihrer Konfiguration werden Attribute verschlüsselt und als Teil eines Benutzerprofils gespeichert, wenn ein Benutzer mit Ihrer Anwendung interagiert. Die Interaktion könnte durch einen Benutzer erfolgen, der sich anmeldet oder eine Benutzervorgabe in Ihrer App festlegt. Übergeben Sie für den Zugriff auf die Attribute ein Zugriffstoken über eine API-Methode.

curl -X GET 'https://<region>.appid.cloud.ibm.com/api/v1/attributes'
-H 'Accept: application/json'
-H 'Authorization: Bearer <accessToken>'

//iOS Swift example

func setAttribute(key: String, value: String, completionHandler: @escaping(Error?, [String:Any]?) -> Void)
func setAttribute(key: String, value: String, accessTokenString: String, completionHandler: @escaping(Error?, [String:Any]?) -> Void)

func getAttribute(key: String, completionHandler: @escaping(Error?, [String:Any]?) -> Void)
func getAttribute(key: String, accessTokenString: String, completionHandler: @escaping(Error?, [String:Any]?) -> Void)

func getAttributes(completionHandler: @escaping(Error?, [String:Any]?) -> Void)
func getAttributes(accessTokenString: String, completionHandler: @escaping(Error?, [String:Any]?) -> Void)

func deleteAttribute(key: String, completionHandler: @escaping(Error?, [String:Any]?) -> Void)
func deleteAttribute(key: String, accessTokenString: String, completionHandler: @escaping(Error?, [String:Any]?) -> Void)

void setAttribute(@NonNull String name, @NonNull String value, UserAttributeResponseListener listener);
void setAttribute(@NonNull String name, @NonNull String value, @NonNull AccessToken accessToken, UserAttributeResponseListener listener);

void getAttribute(@NonNull String name, UserAttributeResponseListener listener);
void getAttribute(@NonNull String name, @NonNull AccessToken accessToken, UserAttributeResponseListener listener);

void deleteAttribute(@NonNull String name, UserAttributeResponseListener listener);
void deleteAttribute(@NonNull String name, @NonNull AccessToken accessToken, UserAttributeResponseListener listener);

void getAllAttributes(@NonNull UserAttributeResponseListener listener);
void getAllAttributes(@NonNull AccessToken accessToken, @NonNull UserAttributeResponseListener listener);

const userProfileManager = require("ibmcloud-appid").UserProfileManager;
userProfileManager.init();
var accessToken = req.session[WebAppStrategy.AUTH_CONTEXT].accessToken;

// get all attributes
userProfileManager.getAllAttributes(accessToken).then(function (attributes) {

        });

// get single attribute
userProfileManager.getAttribute(accessToken, name).then(function (attributes) {

        });

// set attribute value
userProfileManager.setAttribute(accessToken, name, value).then(function (attributes) {

        });

// delete attribute
userProfileManager.deleteAttribute(accessToken, name).then(function () {

        });

//Server-side Swift example

func getAllAttributes(accessToken: String, completionHandler: (Swift.Error?, [String: Any]?) -> Void)
func getAttribute(accessToken: String, attributeName: String, completionHandler: (Swift.Error?, [String: Any]?) -> Void)
func setAttribute(accessToken: String, attributeName: String, attributeValue : "abc", completionHandler: (Swift.Error?, [String: Any]?) -> Void)
func deleteAllAttributes(accessToken: String, completionHandler: (Swift.Error?, [String: Any]?) -> Void)