June 9, 2024
How to Retrieve List of Users Present in a User Group of Adobe Learning Manager using V2 API
Comments
(0)
June 9, 2024
How to Retrieve List of Users Present in a User Group of Adobe Learning Manager using V2 API
https://www.linkedin.com/in/anupam-gogoi-97a14888/
Wizard
Followers: 21 people
(0)
    • GET /userGroups/{userGroupId}/users

      • Retrieves the list of users with the given user group ID.

      Implementation Notes

      Retrieves the list of users that are present in a user group of Adobe Learning Manager account.

      Response Class (Status 200)

      Operation successful

      • Example Value
      {
        "data": [
          {
            "id": "string",
            "type": "string",
            "attributes": {
              "avatarUrl": "string",
              "binUserId": "string",
              "bio": "string",
              "contentLocale": "string",
              "email": "string",
              "enrollOnClick": true,
              "fields": {},
              "gamificationEnabled": true,
              "lastLoginDate": "string",
              "metadata": {},
              "name": "string",
              "pointsEarned": 0,
              "pointsRedeemed": 0,
              "preferredResolution": "string",
              "profile": "string",
              "roles": [
                "string"
              ],
              "state": "string",
              "timeZoneCode": "string",
              "uiLocale": "string",
              "userType": "string",
              "userUniqueId": "string"
            },
            "relationships": {
              "account": {
                "data": {
                  "type": "string",
                  "id": "string"
                }
              },
              "manager": {
                "data": {
                  "type": "string",
                  "id": "string"
                }
              }
            }
          }
        ]
      }

       

          application/vnd.api+json;charset=UTF-8

      Parameters

      Parameter Value Description Parameter Type Data Type
      refer-

      https://elearning.adobe.com/?p=171607

      Mention any additional model to be tagged along with this model query string
      refer –

      https://elearning.adobe.com/?p=171611

      Mention the id of the user group whose users have to be retrieved path string
      Mention the starting range value of the records to be displayed in page query integer
      Mention the maximum number of records to be displayed per page. Max allowed is 10 query integer
                        id  (default)            -id Choose the type of sorting to be applied to the results. Sorting based on recommendation score will only be applicable for PRL enabled LOs query string

      Response Messages

      HTTP Status Code Reason Response Model
      400 A generic http bad request error
      {
        "meta": {
          "error": "string",
          "detail": "string"
        }
      }
      401 A generic http unauthorized access error. Access is denied due to invalid credentials
      {
        "meta": {
          "error": "string",
          "detail": "string"
        }
      }

      Curl 

      curl -X GET --header 'Accept: application/vnd.api+json' --header 'Authorization: oauth eea25e6e1e03c379c46e5ccc29932899' 'https://learningmanager.adobe.com/primeapi/v2/userGroups/10408434/users?page[offset]=0&page[limit]=5&sort=id'

      Request URL 

      https://learningmanager.adobe.com/primeapi/v2/userGroups/10408434/users?page[offset]=0&page[limit]=5&sort=id

      Response Body 

      {
        "links": {
          "self": "https://learningmanager.adobe.com/primeapi/v2/userGroups/10408434/users?page[offset]=0&page[limit]=5&sort=id",
          "next": "https://learningmanager.adobe.com/primeapi/v2/userGroups/10408434/users?page[offset]=5&page[limit]=5&sort=id"
        },
        "data": [
          {
            "id": "15523684",
            "type": "user",
            "attributes": {
              "avatarUrl": "https://cpcontents.adobe.com/public/images/default_user_avatar.svg",
              "binUserId": "f5f99689-ed72-4404-8984-7488d5a99e72",
              "email": "dexter_123456_dexter1285656@gmail.com",
              "enrollOnClick": false,
              "fields": {
                "Learning Categories": [
                  "Finance"
                ],
                "Categories": "Business"
              },
              "gamificationEnabled": false,
              "lastLoginDate": "2023-05-22T14:07:12.000Z",
              "name": "Dexter123",
              "pointsEarned": 0,
              "pointsRedeemed": 0,
              "preferredResolution": "AUTO",
              "profile": "Helpdesk specialist",
              "roles": [
                "Learner",
                "Instructor"
              ],
              "state": "ACTIVE",
              "userType": "Internal",
              "userUniqueId": "dexter_123456_dexter1285656@gmail.com"
            },
            "relationships": {
              "account": {
                "data": {
                  "id": "108079",
                  "type": "account"
                }
              },
              "manager": {
                "data": {
                  "id": "20941371",
                  "type": "user"
                }
              }
            }
          },
          {
            "id": "15523697",
            "type": "user",
            "attributes": {
              "avatarUrl": "https://cpcontents.adobe.com/public/images/default_user_avatar.svg",
              "binUserId": "bb3cd750-7ca7-43f3-98bc-94383b046b73",
              "email": "Ricky123Ricky123Ricky123_Ricky123Ricky123@gmail.com",
              "enrollOnClick": false,
              "fields": {
                "Learning Categories": [
                  "Finance"
                ],
                "Categories": "Business"
              },
              "gamificationEnabled": false,
              "name": "Ricky123",
              "pointsEarned": 0,
              "pointsRedeemed": 0,
              "preferredResolution": "AUTO",
              "profile": "Helpdesk specialist",
              "roles": [
                "Learner",
                "Instructor"
              ],
              "state": "ACTIVE",
              "userType": "Internal",
              "userUniqueId": "Ricky123Ricky123Ricky123_Ricky123Ricky123@gmail.com"
            },
            "relationships": {
              "account": {
                "data": {
                  "id": "108079",
                  "type": "account"
                }
              },
              "manager": {
                "data": {
                  "id": "20941371",
                  "type": "user"
                }
              }
            }
          },
          {
            "id": "15667073",
            "type": "user",
            "attributes": {
              "avatarUrl": "https://cpcontents.adobe.com/public/images/default_user_avatar.svg",
              "binUserId": "cd861741-742a-4e32-9e37-f762eea2f95e",
              "email": "ttestuseranupamgogoi123456@gmail.com",
              "enrollOnClick": true,
              "fields": {
                "Learning Categories": [
                  "Finance"
                ],
                "Categories": "Business"
              },
              "gamificationEnabled": false,
              "lastLoginDate": "2022-08-11T18:50:04.000Z",
              "name": "TEST USER",
              "pointsEarned": 40,
              "pointsRedeemed": 0,
              "preferredResolution": "AUTO",
              "profile": "Helpdesk specialist",
              "roles": [
                "Learner",
                "Instructor"
              ],
              "state": "ACTIVE",
              "userType": "Internal",
              "userUniqueId": "ttestuseranupamgogoi123456@gmail.com"
            },
            "relationships": {
              "account": {
                "data": {
                  "id": "108079",
                  "type": "account"
                }
              },
              "manager": {
                "data": {
                  "id": "20941371",
                  "type": "user"
                }
              }
            }
          },
          {
            "id": "16611789",
            "type": "user",
            "attributes": {
              "avatarUrl": "https://cpcontents.adobe.com/public/images/default_user_avatar.svg",
              "binUserId": "24d9620e-191c-487c-b4ed-6c44c4434913",
              "email": "1boxytun123@gmail.com",
              "enrollOnClick": true,
              "fields": {
                "Learning Categories": [
                  "Security"
                ],
                "Categories": "IT"
              },
              "gamificationEnabled": true,
              "lastLoginDate": "2024-04-17T17:14:38.000Z",
              "name": "Bali",
              "pointsEarned": 360,
              "pointsRedeemed": 0,
              "preferredResolution": "AUTO",
              "profile": "Doctor",
              "roles": [
                "Learner",
                "Instructor"
              ],
              "state": "ACTIVE",
              "userType": "Internal",
              "userUniqueId": "1boxytun123@gmail.com"
            },
            "relationships": {
              "account": {
                "data": {
                  "id": "108079",
                  "type": "account"
                }
              },
              "manager": {
                "data": {
                  "id": "20941371",
                  "type": "user"
                }
              }
            }
          },
          {
            "id": "16619015",
            "type": "user",
            "attributes": {
              "avatarUrl": "https://cpcontents.adobe.com/public/images/default_user_avatar.svg",
              "binUserId": "de4998d4-57e9-4746-83e7-8100e2d27d09",
              "email": "blablablacksheephaveyoublaablaa@gmail.com",
              "enrollOnClick": false,
              "fields": {
                "Learning Categories": [
                  "Security"
                ],
                "Categories": "IT"
              },
              "gamificationEnabled": false,
              "name": "RickyMartin",
              "pointsEarned": 0,
              "pointsRedeemed": 0,
              "preferredResolution": "AUTO",
              "profile": "Helpdesk specialist",
              "roles": [
                "Learner",
                "Instructor"
              ],
              "state": "ACTIVE",
              "userType": "Internal",
              "userUniqueId": "blablablacksheephaveyoublaablaa@gmail.com"
            },
            "relationships": {
              "account": {
                "data": {
                  "id": "108079",
                  "type": "account"
                }
              },
              "manager": {
                "data": {
                  "id": "20941371",
                  "type": "user"
                }
              }
            }
          }
        ]
      }

      Response Code

      200

      Response Headers

      {
        "access-control-allow-credentials": "true",
        "access-control-allow-headers": "X-acap-all-roles, X-acap-account,X-acap-user,X-acap-caller-role,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type, x-experience-api-version, Authorization, X-CSRF-TOKEN, X-HTTP-Method-Override, X-acap-ug-manager-scope, X-acap-extension-token",
        "access-control-allow-methods": "GET, POST, OPTIONS, PUT, HEAD, DELETE, PATCH",
        "access-control-expose-headers": "Requested-Accept-Language, x-rate-limit, x-burst, x-excess-requests-per-second, Retry-After",
        "content-encoding": "gzip",
        "content-type": "application/vnd.api+json;charset=UTF-8",
        "date": "Sun, 09 Jun 2024 12:19:26 GMT",
        "requested-accept-language": "en-US,en;q=0.9",
        "server": "openresty",
        "server-timing": "server_resp;dur=30",
        "strict-transport-security": "max-age=31536000; includeSubDomains",
        "x-content-type-options": "nosniff",
        "x-frame-options": "SAMEORIGIN",
        "x-request-id": "csvbscitrace",
        "x-xss-protection": "1"
      }
0 Comments
Add Comment