June 9, 2024
How to Retrieve User Group Details Using Adobe Learning Manager V2 API
Comments
(0)
June 9, 2024
How to Retrieve User Group Details Using Adobe Learning Manager V2 API
https://www.linkedin.com/in/anupam-gogoi-97a14888/
Wizard
Followers: 21 people
(0)
    • GET /userGroups

      • Retrieves a list of User Groups for an account

      Implementation Notes

      Get a list of User Groups for an account. It includes the user group name, description, state and so on.

      Response Class (Status 200)

      Operation successful

      • Example Value
      {
        "data": [
          {
            "id": "string",
            "type": "string",
            "attributes": {
              "dateCreated": "string",
              "description": "string",
              "name": "string",
              "readOnly": true,
              "state": "string",
              "userCount": 0
            }
          }
        ]
      }

       

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

      Parameters

      Parameter Value Description Parameter Type Data Type
      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
                        name  (default)            dateCreated            -name            -dateCreated 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
                        true            false Select true for auto generated groups and false for Custom user groups query string
                        Active            Deleted Select a state as a filter to be applied on the result query string
      Filter the list based on this catalog id. Currently this can be used only with Admin related scopes. query string

      Response Messages

      HTTP Status Code Reason Response Model Headers
      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?page[offset]=0&page[limit]=5&sort=name'

      Request URL 

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

      Response Body 

      {
        "links": {
          "self": "https://learningmanager.adobe.com/primeapi/v2/userGroups?page[offset]=0&page[limit]=5&sort=name",
          "next": "https://learningmanager.adobe.com/primeapi/v2/userGroups?page[offset]=5&page[limit]=5&sort=name"
        },
        "data": [
          {
            "id": "10946436",
            "type": "userGroup",
            "attributes": {
              "dateCreated": "2024-05-22T18:33:52.000Z",
              "description": "All users who directly report to Ab Rosa",
              "name": "Ab Rosa 's Direct Team",
              "readOnly": true,
              "state": "Active",
              "userCount": 1
            }
          },
          {
            "id": "10946437",
            "type": "userGroup",
            "attributes": {
              "dateCreated": "2024-05-22T18:33:52.000Z",
              "description": "All users who directly or indirectly report to Ab Rosa",
              "name": "Ab Rosa 's Team",
              "readOnly": true,
              "state": "Active",
              "userCount": 1
            }
          },
          {
            "id": "6672030",
            "type": "userGroup",
            "attributes": {
              "dateCreated": "2022-03-01T16:37:47.000Z",
              "description": "Aberdeen",
              "name": "Aberdeen",
              "readOnly": false,
              "state": "Active",
              "userCount": 2
            }
          },
          {
            "id": "10599055",
            "type": "userGroup",
            "attributes": {
              "dateCreated": "2024-02-08T11:53:48.000Z",
              "description": "All users who directly report to Adobe Amu2",
              "name": "Adobe Amu2's Direct Team",
              "readOnly": true,
              "state": "Active",
              "userCount": 2
            }
          },
          {
            "id": "10599056",
            "type": "userGroup",
            "attributes": {
              "dateCreated": "2024-02-08T11:53:48.000Z",
              "description": "All users who directly or indirectly report to Adobe Amu2",
              "name": "Adobe Amu2's Team",
              "readOnly": true,
              "state": "Active",
              "userCount": 2
            }
          }
        ]
      }

      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:25:49 GMT",
        "requested-accept-language": "en-US,en;q=0.9",
        "server": "openresty",
        "server-timing": "server_resp;dur=19",
        "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