/scim2/Groups/.search

Search for and get a list of teams.

Prerequisite - x-csrf-token

You must get a x-csrf-token and include it in the header of every POST, PUT, PATCH or DELETE request.

For more information, see Valid CSRF Token.

POST /api/v1/scim2/Groups/.search

Searches for and gets a list of users.

  • HTTP Headers:

    • Authorization: Bearer <access_token>

    • x-sap-sac-custom-auth: true

    • x-csrf-token: <csrf_token>

  • Parameters: None

  • Request Body: User Schema

    The following example schema searches for teams: 
    {
    "schemas": ["urn:ietf:params:scim:api:messages:2.0:SearchRequest"],
    "startIndex": 1,
    "count": 1
}
The following filter options are supported in the request body:

  • (Optional) sortBy: a user attribute to sort the results by. For example, username.

  • (Optional) sortOrder: the order to used to display the results. Set to either ascending or descending. By default, an ascending sort order is used.

  • (Optional) startIndex: the index of the first user to fetch. For example, if the start index is set to 10, the tenth user will be the first user returned.

  • (Optional) count: the number of users to return on each page.

  • (Optional) filter=<attribute>: adds a filter to the request. See the group schema for available attributes. All operators are supported.

Example POST request: <TENANT_URL>/api/v1/scim2/Groups/.search

Response

Example Response

  • 500: Internal server error

  • 403: Forbidden

  • 400: Bad request

  • 200: OK

Format: application/json

 
{
    "schemas": [
       "urn:ietf:params:scim:api:messages:2.0:ListResponse"
    ],
    "totalResults": 131,
    "startIndex": 1,
    "itemsPerPage": 1,
    "Resources": [
    {
        "schemas": [
            "urn:ietf:params:scim:schemas:core:2.0:Group"
        ],
        "id": "c3ed1d55-e081-4b04-994a-fbf5ba305c58",
        "meta": {
            "resourceType": "Group",
            "created": "2022-06-22T16:06:38.150Z",
            "lastModified": "2022-06-22T16:06:38.150Z",
            "location": "/api/v1/scim2/Groups/c3ed1d55-e081-4b04-994a-fbf5ba305c58"
        },
        "displayName": "TestGroup2",
        "members": [
        {
            "value": "87748b0b-0c98-4710-97bd-a8dda0b1a93e",
            "type": "User",
            "display": "testCreateUserWithIllegalEmail400",
            "$ref": "/api/v1/scim2/Users/87748b0b-0c98-4710-97bd-a8dda0b1a93e"
        },
        {
            "value": "26c39c83-42b7-4092-bf68-b4a17eb0d9b2",
            "type": "User",
            "display": "testDeltaReadUsers1",
            "$ref": "/api/v1/scim2/Users/26c39c83-42b7-4092-bf68-b4a17eb0d9b2"
        }
        ]
    }
    ]
}
Related Information