List Users

List all the users of the company.

The following scopes are required to run this action:

• identity.user.ids.read
• identity.user.core.read
• identity.user.coresensitive.read
• identity.user.enterprise.read
• identity.user.sap.read

External Documentation

To learn more, visit the SAP Concur documentation.

​

Parameters

Parameter	Description
Attributes	A comma-separated list of resource attributes to return in the response. For example: id,active,emails.
Count	The maximum number of users to return in the result.
Cursor	The cursor to the next page of results, retrieve this value from a previous response to fetch subsequent data.
Excluded Attributes	A comma-separated list of resource attributes to remove from the response.
Return All Pages	Automatically fetch all resources, page by page.

​

Example Output

{
	"schemas": [
		"urn:ietf:params:scim:api:messages:2.0:ListResponse"
	],
	"totalResults": 0,
	"itemsPerPage": 0,
	"startIndex": 0,
	"Resources": [
		{
			"active": true,
			"addresses": [
				{
					"country": "string",
					"locality": "string",
					"postalCode": "string",
					"region": "string",
					"streetAddress": "string",
					"type": "work"
				}
			],
			"dateOfBirth": "string",
			"displayName": "string",
			"emails": [
				{
					"notifications": true,
					"type": "work",
					"value": "string",
					"verified": true
				}
			],
			"emergencyContacts": [
				{
					"country": "string",
					"emails": [
						"string"
					],
					"locality": "string",
					"name": "string",
					"phones": [
						"string"
					],
					"postalCode": "string",
					"region": "string",
					"relationship": "Spouse",
					"streetAddress": "string"
				}
			],
			"entitlements": [
				"Expense"
			],
			"externalId": "string",
			"id": "string",
			"localeOverrides": {
				"preference24Hour": "H:mm AM/PM",
				"preferenceCurrencySymbolLocation": "BeforeAmount",
				"preferenceDateFormat": "mm/dd/yyyy",
				"preferenceDefaultCalView": "day",
				"preferenceDistance": "mile",
				"preferenceEndDayViewHour": 0,
				"preferenceFirstDayOfWeek": "Sunday",
				"preferenceHourMinuteSeparator": ":",
				"preferenceNegativeCurrencyFormat": "-100",
				"preferenceNegativeNumberFormat": "-100",
				"preferenceNumberFormat": "1,000.00",
				"preferenceStartDayViewHour": 0
			},
			"meta": {
				"created": "string",
				"lastModified": "string",
				"location": "string",
				"resourceType": "string",
				"version": 0
			},
			"name": {
				"academicTitle": "Dr.",
				"familyName": "string",
				"familyNamePrefix": "string",
				"formatted": "string",
				"givenName": "string",
				"honorificPrefix": "string",
				"honorificSuffix": "string",
				"legalName": "string",
				"middleInitial": "s",
				"middleName": "string"
			},
			"nickName": "string",
			"phoneNumbers": [
				{
					"display": "string",
					"issuingCountry": "string",
					"notifications": true,
					"primary": true,
					"type": "work",
					"value": "string",
					"workExtension": "string"
				}
			],
			"preferredLanguage": "string",
			"schemas": [
				"string"
			],
			"timezone": "string",
			"title": "string",
			"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
				"companyId": "string",
				"costCenter": "string",
				"department": "string",
				"division": "string",
				"employeeNumber": "string",
				"leavesOfAbsence": [
					{
						"endDate": "string",
						"startDate": "string",
						"type": "voluntary"
					}
				],
				"legalEntity": "string",
				"manager": {
					"$ref": "string",
					"displayName": "string",
					"employeeNumber": "string",
					"value": "string"
				},
				"organization": "string",
				"startDate": "string",
				"terminationDate": "string"
			},
			"urn:ietf:params:scim:schemas:extension:sap:2.0:User": {
				"userUuid": "string"
			},
			"userName": "string"
		}
	],
	"nextCursor": "string"
}