/scim2/Users

Allows you to create a user or get a list of users.

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.

GET /api/v1/scim2/Users

Gets a list of users.

  • HTTP Headers:

    • Authorization: Bearer <access_token>

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

    • Optional: x-csrf-token: <fetch>

  • URL Parameters:

    • (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 user schema for available attributes. All operators are supported.

    Example GET request: <TENANT_URL>/api/v1/scim2/Users?filter=emails.value co "a"&sortOrder=descending&startIndex=3&count=2&sortBy=emails.value

  • Request Body: None

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": 1026,
    "startIndex": 3,
    "itemsPerPage": 2,
    "Resources": [
    {
        "schemas": [
            "urn:sap:params:scim:schemas:extension:sac:2.0:user-custom-parameters",
            "urn:ietf:params:scim:schemas:core:2.0:User",
            "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"
        ],
        "id": "108e42ab-b573-4c0f-93d8-da6978ac04a3",
        "meta": {
            "resourceType": "User",
            "created": "2022-06-07T16:57:49.967Z",
            "location": "/api/v1/scim2/Users/108e42ab-b573-4c0f-93d8-da6978ac04a3"
        },
        "userName": "TEST",
        "name": {
            "familyName": "Test",
            "givenName": "Test",
            "formatted": "test"
        },
        "displayName": "test",
        "active": true,
        "emails": [
        {
            "value": "test@sap.com",
            "type": "work",
            "primary": true
        }
        ],
        "groups": [
        {
            "value": "7a744758-9a7b-48de-a7a1-9f768b23ad1d",
            "display": "TestTeam1",
            "type": "direct",
            "$ref": "/api/v1/scim2/Groups/7a744758-9a7b-48de-a7a1-9f768b23ad1d"
        }
        ],
        "roles": [
        {
            "value": "PROFILE:sap.epm:Admin",
            "display": "Admin",
            "primary": true
        }
        ],
        "urn:sap:params:scim:schemas:extension:sac:2.0:user-custom-parameters": {
            "idpUserId": "test@sap.com",
            "isConcurrent": false,
            "marketingEmailOptIn": true
        },
        "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
            "manager": {
            "value": "9be3326a-6c22-443d-9b50-f828521e31f4",
            "$ref": "/api/v1/scim2/Users/9be3326a-6c22-443d-9b50-f828521e31f4"
            }
        },
        "urn:ietf:params:scim:schemas:extension:sap:2.0:User": {
            "userUuid": "cd387ec9-5a83-4412-983e-7133e9c6dac2"
       },
    },
    {
        "schemas": [
            "urn:sap:params:scim:schemas:extension:sac:2.0:user-custom-parameters",
            "urn:ietf:params:scim:schemas:core:2.0:User"
        ],
        "id": "26c39c83-42b7-4092-bf68-b4a17eb0d9b2",
        "meta": {
            "resourceType": "User",
            "created": "2022-05-12T17:06:10.767Z",
            "location": "/api/v1/scim2/Users/26c39c83-42b7-4092-bf68-b4a17eb0d9b2"
        },
        "userName": "TESTDELTAREADUSERS1",
        "name": {
            "familyName": "test2",
            "givenName": "test2",
            "formatted": "Test2"
        },
        "displayName": "testDeltaReadUsers1",
        "active": true,
        "emails": [
        {
            "value": "testDeltaReadUsers1@example.com",
            "type": "work",
            "primary": true
        }
        ],
        "groups": [
        {
            "value": "04200161-4323-4143-a80f-3548ef2e5786",
            "display": "AdminToolKit_Users_Without_a_Role_and_Without_a_Team",
            "type": "direct",
            "$ref": "/api/v1/scim2/Groups/04200161-4323-4143-a80f-3548ef2e5786"
        },
        {
            "value": "341bfffb-ce57-4138-985e-3372f6057237",
            "display": "AdminToolKit_Users_That_Are_Disabled_With_BI_Named_User_License",
            "type": "direct",
            "$ref": "/api/v1/scim2/Groups/341bfffb-ce57-4138-985e-3372f6057237"
        }
        ],
        "roles": [
        {
            "value": "PROFILE:sap.epm:Admin",
            "display": "Admin",
            "primary": true
        }
        ],
        "urn:sap:params:scim:schemas:extension:sac:2.0:user-custom-parameters": {
        "idpUserId": "testDeltaReadUsers1@example.com",
        "isConcurrent": false
        },
        "urn:ietf:params:scim:schemas:extension:sap:2.0:User": {
            "userUuid": "cd387ec9-5a83-4412-983e-7133e9c6dac2"
       },
    }
    ]   
}

POST /api/v1/scim2/Users

Creates a user based on the information provided.

  • HTTP Headers:

    • Authorization: Bearer <access_token>

    • x-csrf-token: <csrf_token>

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

  • Parameters: None

  • Request Body: User Schema

    The following example schema creates a new user: 
    {
    "schemas": [
        "urn:sap:params:scim:schemas:extension:sac:2.0:user-custom-parameters",
        "urn:ietf:params:scim:schemas:core:2.0:User",
        "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"
    ],
    "userName": "TEST",
    "name": {
        "familyName": "test",
        "givenName": "test",
        "formatted": "test"
    },
    "displayName": "test",
    "preferredLanguage": "en",
    "active": true,
    "emails": [
    {
        "value": test@sap.com,
        "type": "work",
        "primary": true
    }
    ],
    "groups": [],
    "roles": [
    {
        "value": "PROFILE:sap.epm:Admin",
        "display": "Admin",
        "primary": true
    }
    ],
    "urn:sap:params:scim:schemas:extension:sac:2.0:user-custom-parameters": {
        "dataAccessLanguage": "en",
        "systemNotificationsEmailOptIn": true,
        "numberFormatting": "1,234.56",
        "timeFormatting": "H:mm:ss",
        "isConcurrent": false,
        "dateFormatting": "MMM d, yyyy",
        "marketingEmailOptIn": true,
        "cleanUpNotificationsNumberOfDays": 0,
        "idpUserId": test@sap.com
    },
    "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
        "manager": {
            "value": "",
            "$ref": "/api/v1/scim2/Users/"
        }
    },
    "urn:ietf:params:scim:schemas:extension:sap:2.0:User": { 
        "userUuid": "<Global_User_ID>" 
    }
}
    For information on role assignment, see Assigning Roles to Users and Groups. For information on additional parameter options, see Optional User Parameters.

Response

Example Response

  • 500: Internal server error

  • 409: User name conflict

  • 403: Forbidden

  • 401: Not authorized

  • 400: User changes cannot be saved. The maximum number of licenses have been reached. Please check your current license usage limits, then deactivate users, delete inactive users, or consider an upgrade to your plan.

  • 201: Created

Format: application/scim+json (User Schema)

The response should include the user information you provided.

{
    "schemas": [
        "urn:sap:params:scim:schemas:extension:sac:2.0:user-custom-parameters",
        "urn:ietf:params:scim:schemas:core:2.0:User"
    ],
    "id": "82a24fe1-fb49-41f4-b038-ad1fe390bdd6",
    "meta": {
        "resourceType": "User",
        "created": "2022-07-07T00:44:47.765Z",
        "location": "/api/v1/scim2/Users/82a24fe1-fb49-41f4-b038-ad1fe390bdd6"
    },
    "userName": "test",
    "name": {
        "familyName": "test",
        "givenName": "test",
        "formatted": "test"
    },
    "displayName": "test",
    "preferredLanguage": "en",
    "active": true,
    "emails": [
    {
        "value": test@sap.com,
        "type": "work",
        "primary": true
    }
    ],
    "groups": [],
    "roles": [
    {
        "value": "PROFILE:sap.epm:Admin",
        "display": "Admin",
        "primary": true
    }
    ],
    "urn:sap:params:scim:schemas:extension:sac:2.0:user-custom-parameters": {
        "dataAccessLanguage": "en",
        "systemNotificationsEmailOptIn": true,
        "numberFormatting": "1,234.56",
        "idpUserId": test@sap.com,
        "timeFormatting": "H:mm:ss",
        "isConcurrent": false,
        "dateFormatting": "MMM d, yyyy",
        "marketingEmailOptIn": false,
        "cleanUpNotificationsNumberOfDays": 0
    },
    "urn:ietf:params:scim:schemas:extension:sap:2.0:User": { 
        "userUuid": "108e42ab-b573-4c0d-23d8-da6978ac04x8"
    }
}
Related Information