Unsupported Search Filter when calling the User Search SCIM API
2 years ago
Originally Published: 2023-03-20
Article Number
000068140
Applies To
RSA Product Set: SecurID Access
RSA Product/Service Type: Cloud Administration console
Issue
After implementing the GET method to search for users in the RSA Unified Directory with the SCIM API, an error is thrown.

1. The GET method: GET <Base_URI>/Users?filter=userName sw "<username>"

2. The Error message: Unsupported Search Filter

Testing the same method with Postman yields the same result.

image.png 
Cause
The Search Filter sw (starts with) is currently not supported with the RSA Unified Directory, the only supported Filter is eq (equals).

Refer to the RSA Unified Directory documentation RSA Unified Directory - SCIM API for more information on the Search Filters, how to obtain the Base_URI, needed parameters, etc.
Resolution
Modify the Search Filter in the GET request from sw to eq.

1. The modified GET method: GET <Base_URI>/Users?filter=userName eq "<username>"

2. The expected Response:

{
    "schemas": [
        "urn:ietf:params:scim:api:messages:2.0:ListResponse"
    ],
    "totalResults": 1,
    "Resources": [
        {
            "schemas": [
                "urn:ietf:params:scim:schemas:core:2.0:User"
            ],
            "id": "<user's UUID>",
            "meta": {
                "resourceType": "User",
                "created": "<Timestamp>",
                "lastModified": "<Timestamp>"
            },
            "userName": "<username>",
            "active": true,
            "emails": [
                {
                    "value": "<user's email>",
                    "type": "work"
                }
            ]
        }
    ],
    "startIndex": 1,
    "itemsPerPage": 1
}
Workaround
N/A
Notes
N/A
Don't see what you're looking for?