This API endpoint is helpful when you want to retrieve the user details of all the users present in the Adobe Learning Manager account. The data extracted provides useful information such as ALM user ID, user Type, Avatar URL, BIN User ID, Bio, Content Locale, Email, Enroll On Click, Active Fields, Gamification Enabled, Last Login Date, Metadata, Name, Points Earned, Points Redeemed, Preferred Resolution, Profile, Roles, State, Time Zone Code, UI Locale, User Type, User Unique ID, Relationships (Account, Manager) etc in JSON format.
-
-
GET /users
Implementation Notes
Obtain the list of All Users within your Organization’s Adobe Learning Manager Account, featuring Usernames, Badge Information, Earned Points, and More. Please be mindful that the endpoint’s maximum supported offset value is 500. If you require data for additional users, explore utilizing the jobs API.
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-8Parameters
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 Mention the starting range value of the records to be displayed in page query integer 2 Mention the maximum number of records to be displayed per page. Max allowed is 10 query integer Mention the last cursor till the records are fetched query string 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 gamification gamificationAll Choose ‘gamification’, to fetch 10 users around the user specified by userId. Choose ‘gamificationAll’, to fetch all users in the scope of the current learner. query string Mention the id of the user to retrieve data of all the users linked to it with gamification, which is subject to necessary permissions. This field works only if ‘gamification’ is selected in ‘filter’ parameter. query string Filter by User ID – ex: “123456” or
Filter by User’s email – ex: “email:abcd@workemail.com”
Mention users Ids for which data is being requested.filter and userId field can not be selected if this field is mentioned. page[offset] & page[limit] are not honored if this field is mentioned.Max allowed number of ids that can be included is 10 query Array[] Response Messages
Curl
curl -X GET --header 'Accept: application/vnd.api+json' --header 'Authorization: oauth 2fd8739c4fe8e203' 'https://learningmanager.adobe.com/primeapi/v2/users?page[offset]=0&page[limit]=2&sort=id'
Request URL
https://learningmanager.adobe.com/primeapi/v2/users?page[offset]=0&page[limit]=2&sort=id
Response Body
{ "links": { "self": "https://learningmanager.adobe.com/primeapi/v2/users?page[limit]=2&sort=id", "next": "https://learningmanager.adobe.com/primeapi/v2/users?page[limit]=2&sort=id&page[cursor]=15310486" }, "data": [ { "id": "15263446", "type": "user", "attributes": { "avatarUrl": "https://cpcontents.adobe.com/protected/account/108079/accountassets/108079/userassets/15263446/1677755507456_profile.png?cp_oauth_jwt=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJwIjoidXJsIiwicmFuZCI6IjI0MzdkZDQ1ZWY3ZjE3ZDhiMTlhZDI1NTJhMWNiNjQxIiwidiI6IjEiLCJvcmlnaW5hbFVybEhhc2giOiI0MzFlYjVkY2MxMDg4OWI2ZDAxMGZkZWFkYTQ3NzgxMjVjZDJmMGRiIiwiZXhwIjoxNzE3MzQ5ODc5LCJyaWQiOiIxNjI0NTU4MyIsImlhdCI6MTcxNjc0NTA3OSwiY2lkIjoiMSJ9.1fqZIOYioWgGPqOPL15pFHssU_vnkxQMwAPZ7-Mz9cM", "binUserId": "aa892b95-eba4-4a74-9001-57a558101443", "bio": "", "contentLocale": "fr-FR", "email": "SomeemailID2work.com", "enrollOnClick": true, "fields": { "Learning Categories": [ "Business" ], "Categories": "IT" }, "gamificationEnabled": false, "lastLoginDate": "2024-05-25T08:06:35.000Z", "metadata": {}, "name": "Anupam Gogoi", "pointsEarned": 7875, "pointsRedeemed": 200, "preferredResolution": "AUTO", "profile": "Engineer", "roles": [ "Learner", "Admin", "Author", "Instructor", "Integration Admin", "Manager" ], "state": "ACTIVE", "timeZoneCode": "IST", "uiLocale": "en-US", "userType": "Internal", "userUniqueId": "wewe399344" }, "relationships": { "account": { "data": { "id": "108079", "type": "account" } }, "manager": { "data": { "id": "20941371", "type": "user" } } } }, { "id": "15310486", "type": "user", "attributes": { "avatarUrl": "https://cpcontents.adobe.com/public/images/default_user_avatar.svg", "binUserId": "7b0db37f-011b-47b8-af1d-4e27b3d05cd3", "email": "adoberanup@niliiii.com", "enrollOnClick": false, "gamificationEnabled": false, "lastLoginDate": "2022-02-23T21:49:55.000Z", "name": "Adober AnupNIL", "pointsEarned": 0, "pointsRedeemed": 0, "preferredResolution": "AUTO", "profile": "EXT VNDR", "roles": [ "Learner" ], "state": "SUSPENDED", "userType": "External", "userUniqueId": "456866" }, "relationships": { "account": { "data": { "id": "108079", "type": "account" } } } } ] }
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, 26 May 2024 17:37:59 GMT", "requested-accept-language": "en-US,en;q=0.9", "server": "openresty", "server-timing": "server_resp;dur=84", "strict-transport-security": "max-age=31536000; includeSubDomains", "x-content-type-options": "nosniff", "x-frame-options": "SAMEORIGIN", "x-request-id": "gw7105dbffc697e74d7d06388a0", "x-xss-protection": "1" }
-
You must be logged in to post a comment.