Search for a User

To search for a user matching the specified criteria, the client must send a POST request to: /aims/rs/scim/v2/Users/.search.

The possible HTTP status codes returned are:

  • 200: OK

  • 400: Bad Request

  • 401: Unauthorized

  • 403: Forbidden

Example request:

Copy

{

{
  "count": 0,
  "filter": "userName eq \"aswift\"",
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:SearchRequest"
  ],
  "startIndex": 0
}

Example response:

Copy
{
  "Resources": [
    {
      "id": "string",
      "meta": {
        "created": "2025-03-27T14:18:22.178Z",
        "lastModified": "2025-03-27T14:18:22.178Z",
        "location": "http://cms.mycompany.com/aims/rs/scim/v2/User/Search/16548",
        "resourceType": "/qbyIpQuEmTVg2OBaLXaLRmil9MTcx"
      },
      "userType": "internal",
      "userName": "string",
      "active": true,
      "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:User"
      ],
      "name": {
        "familyName": "string",
        "givenName": "string",
        "middleName": "string"
      },
      "displayName": "string",
      "emails": [
        {
          "\\$ref": "string",
          "value": "string",
          "display": "string",
          "type": "string",
          "primary": true
        }
      ],
      "title": "string",
      "groups": [
        {
          "\\$ref": "string",
          "value": "string",
          "display": "string",
          "type": "direct"
        }
      ],
      "roles": [
        {
          "display": "/V57e*+V_2N\\!R;61%ynkJ2%/"
        }
      ],
      "urn:hid:scim:api:cms:1.0:UserPermission": [
        {
          "roles": [
            {
              "display": "/bETmpI#6MY;;=TRnTJ3y7\"m;I\"9AP/"
            }
          ],
          "groups": [
            {
              "display": "/lI8&;M[ 1r~b#=Y l|>3~Em{NFfB[l^8&5u/>a}@\"2-~c*,9\""
            }
          ]
        }
      ],
      "x509Certificates": [
        {
          "value": "/MIIOiKavC8slVTYGxALM9d7EkvYoSuQUDvReHFY+30LZ7f8PP/"
        }
      ]
    }
  ],
  "itemsPerPage": 0,
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
  ],
  "startIndex": 0,
  "totalResults": 0
}