Skip to main content

Upgrade Guide: POST users-srv/search/scroll-users Transition to POST user-ext-srv/bulkread/users

This guide provides a structured overview of deprecated APIs/features and their replacements. It includes details on changes in Authorization, RequestBody, RequestPath, Response, and changes in Features. Follow this guide to ensure a seamless transition to the new versions <3.101.3>.

1. API Changes​

https://docs.cidaas.com/docs/cidaas-iam/d3802bd6de1b0-fetch-user-list-by-scroll-id https://docs.cidaas.com/docs/cidaas-iam/p13z06tlcu388-read-users-in-bulk-mode

1.1 Authorization Changes​

Deprecated:

  • Scope: cidaas:admin_read

Replacement:

  • Method: OAuth 2.0
  • Steps:
    1. Obtain a token from the /token-srv/token endpoint.
    2. Use the token in the header: Authorization: Bearer <access_token>
  • Scope: cidaas:users_search or cidaas:users_read

1.2 RequestBody Changes​

Deprecated:
Sending form-encoded data:

{
   "terms": ["john_doe"],
  "filters": {
    "fields": {
      "fieldkey": "email",
      "value": [
       "[email protected]"
      ]
    },
    "range": {
      "fieldkey": "createDate",
      "startRange": "2022-05-10",
      "endRange": "2023-09-10"
    },
    "groups": {
      "groupID": "CIDAAS_USERS",
      "roles": [
        "USER"
      ]
    }
  },
  "skip": 0,
  "take": 50
  "TTL": 0,
  "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAD4WYm9laVYtZndUQlNsdDcwakFMNjU1QQ=="
}

Replacement:
Use JSON structure:

{
  "terms": ["john_doe"],
  "from_value": "2022-05-10T14:15:22Z", //replacing range filter
  "to_value": "2023-09-10T14:15:22Z", //replacing range filter
  "rangefield": "createDate",//replacing range filter
  "fieldsFilter": [
    {
      "field": "email",
      "value": "[email protected]",
      "exactMatch": true
    }
  ],
  "groupsFilter": [ //replacing filters.groups
    {
      "groupId": "CIDAAS_USERS",
      "roles": [
        "USER"
      ],
      "rolesCondition": "and"
    }
  ],
  "from": 0,
  "size": 50,
  "searchAfter": [
    "2022-12-20T05:30:04.832Z",
    4294967298
  ],
  "pit": {
    "id": "gcSHBAM2Y2lkYWFzLWt1YmUtbmlnaHRseWJ1aWxkLWRldl91c2VyLXNlYXJjaC12aWV3LWluZGV4X3YyFmcxMGtrMzJtU3JxWUxMMFhGdFNPRWcAFklsVWc1Y2FpUW1HYjVDQUowVTRYWEEAAAAAAAAoiK4WaVV2R2VGU1NUYmkzTmtjbncxUEVCUQA2Y2lkYWFzLWt1YmUtbmlnaHRseWJ1aWxkLWRldl91c2VyLXNlYXJjaC12aWV3LWluZGV4X3YyFmcxMGtrMzJtU3JxWUxMMFhGdFNPRWcBFnRhTDBzSldpVHV5TlJ5X3FpUGhzQWcAAAAAAAAfDesWNmVjNXcyM3BRaHUwYjd5azZoNU8xdwA2Y2lkYWFzLWt1YmUtbmlnaHRseWJ1aWxkLWRldl91c2VyLXNlYXJjaC12aWV3LWluZGV4X3YyFmcxMGtrMzJtU3JxWUxMMFhGdFNPRWcCFmdKZWhVQ2RhU1pXQk44T1M2QllnNWcAAAAAAAAqOKMWaGNMSUxGcC1TNzItaTVYUm5FUF9ndwABFmcxMGtrMzJtU3JxWUxMMFhGdFNPRWcAAA==",
    "keepAlive": "5"
  }
}

1.3 RequestPath Changes​

Deprecated:
POST users-srv/search/scroll-users

Replacement:
POST user-ext-srv/bulkread/users

1.4 Response Changes​

Documentation: https://docs.cidaas.com/docs/cidaas-iam/d3802bd6de1b0-fetch-user-list-by-scroll-id and https://docs.cidaas.com/docs/cidaas-iam/p13z06tlcu388-read-users-in-bulk-mode