사용자 프로파일 정보를 얻으려면 어떻게 해야 합니까?

사용자 정보에 액세스할 수 있는 여러 가지 방법과 함께 해당 정보에 액세스하려는 몇 가지 다른 이유가 있습니다. 호출하기 위해 선택하는 엔드포인트는 유스 케이스에 따라 다를 수 있습니다.

API를 사용하여 작업해야 하는 경우 다음 이미지와 해당 정보를 참조하여 정보를 가져오는 방법을 확인하십시오.

/oauth/v4/<tenantID>/token

인증에 성공하고 나면 가장 일반적인 사용자 정보(이름, 사진 또는 이메일)를 포함하는 액세스 및 ID 토큰을 받습니다. 정보를 추가하려면 사용자 정의 청구-맵핑을 사용하여 사용자에게 리턴하기 전에 정보를 토큰에 삽입하도록 App ID를 구성할 수 있습니다.

/oauth/v4/<tenantID>/userinfo

ID 제공자가 리턴하는 사용자 프로파일 정보를 자세히 보려면 /userinfo 엔드포인트를 호출할 수 있습니다. 이 엔드포인트는 추가 네트워크 호출이 필요하므로 정보를 토큰에 매핑할 수 없는 경우에만 사용하는 것이 좋습니다.

/api/v1/attributes

애플리케이션에서 현재 로그인된 사용자의 사용자 정의 프로파일 속성을 읽고 업데이트해야 하는 경우, /attributes 엔드포인트를 사용할 수 있습니다. 예를 들어, 사용자가 음식 선호도를 업데이트하려고 합니다.

/management/v4/<tenantID>/users

여러 사용자에게 적용할 수 있는 관리 인터페이스 또는 프로세스를 빌드하는 경우 App ID 관리 API를 사용할 수 있습니다. 특히 /users 엔드포인트를 사용할 수 있습니다.

사용자 정보를 사용하는 가장 쉬운 방법은 GUI 또는 SDK를 사용하는 것입니다. 해당 옵션을 사용하면 모든 API 호출이 백그라운드에서 수행됩니다.

/userinfo 엔드포인트 액세스

구성된 ID 제공자가 제공하는 사용자 정보를 확인하기 위해 사전 정의된 속성에 액세스할 수 있습니다.

1. openid 범위를 사용하여 올바른 액세스 토큰이 있는지 확인하십시오. /introspect 엔드포인트를 사용하여 토큰이 올바른지 확인할 수 있습니다.

2. /userinfo 엔드포인트에 요청합니다. 새 토큰이 SDK에 명시적으로 전달되지 않으면 App ID에서 마지막으로 수신된 토큰을 사용하여 응답을 검색하고 유효성을 검증합니다. ID 토큰 전달은 선택사항이지만 전달은 응답의 유효성을 검증하는 데 사용됩니다.

   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
      }
   }
   

   출력 예:

   "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. sub 청구가 ID 토큰의 sub 청구와 정확히 일치하는지 확인하십시오. 일치하지 않는 경우 리턴된 정보를 사용하지 마십시오. 토큰 대체에 대해 자세히 알아보려면 OIDC 사양을 참조하세요.

외부 ID 제공자가 변경사항을 작성한 경우 사용자가 다시 로그인할 때 업데이트된 정보를 가져올 수 있습니다. 새 토큰이 최신 데이터를 검색합니다.

/attributes 엔드포인트 액세스

구성에 따라 속성은 사용자가 애플리케이션과 상호작용할 때 암호화되어 사용자 프로파일의 일부로 저장됩니다. 이 상호작용은 사용자의 사인인 또는 앱의 환경 설정이 될 수 있습니다. 속성에 액세스하려면 API 메소드를 통해 액세스 토큰을 전달하십시오.

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)