Identity v4
The Identity v4 service is designed to create, update, and read user’s core identity profile. This service is also available to look up the SAP Concur UUID to access any v4 API for a single user only.
Limitations
Only the GET operations are available at this time. This API is not available in the China Data Center. This API is only available to partners who have been granted access by SAP Concur. Access to this documentation does not provide access to the API. Filters are available for unique attributes only.
Products and Editions
- Concur Expense Professional Edition
- Concur Expense Standard Edition
- Concur Travel Professional Edition
- Concur Travel Standard Edition
- Concur Invoice Professional Edition
- Concur Invoice Standard Edition
- Concur Request Professional Edition
- Concur Request Standard Edition
Scope Usage
Name | Description | Endpoint |
---|---|---|
identity.user.ids.read |
Read user ID data. | GET |
identity.user.core.read |
Read user core data. | GET |
identity.user.coresensitive.read |
Read core sensitive data. | GET |
identity.user.enterprise.read |
Read user enterprise data. | GET |
identity.user.coreenterprise.writeonly |
Write access to all core and enterprise fields except externalID . |
PUT, POST, PATCH |
identity.user.externalID.writeonly |
Write access to externalID only. |
PUT, POST, PATCH |
identity.user.sap.read |
Read a user’s SAP Global ID. Required for integrations using SAP IPS for user management. | GET |
identity.user.sap.writeonly |
Write a user’s SAP Global ID. Required to assign an SAP Global ID to an existing SAP Concur user. | POST, PUT, PATCH |
identity.user.delete |
Hard delete of users - not recommended. Contact account manager | DELETE NOTE: The DELETE operation should only be used for users that have no transaction history. For users with transaction history, see the Data Retention policy. |
For more information on scope usage and mapping, please see the Identity v4 Scope Mapping page.
Dependencies
None.
Access Token Usage
This API supports only company level access tokens.
Retrieve Users
Retrieves all users of a given company. The filter operation can be used to fetch a unique user’s identity information.
Request
URI
Template
GET https://us2.api.concursolutions.com/profile/identity/v4/Users
GET https://us2.api.concursolutions.com/profile/identity/v4/Users?count=20
GET https://us2.api.concursolutions.com/profile/identity/v4/Users/<Concur UUID>
GET https://us2.api.concursolutions.com/profile/identity/v4/Users?filter=attributes eq "value"
Example
GET https://us2.api.concursolutions.com/profile/identity/v4/Users?filter=employeeNumber eq "123456789_1"
Parameters
Name | Type | Format | Description |
---|---|---|---|
filter |
string |
- | The filter string used to request a subset of resources. Supported attributes: userName , employeeNumber and externalId . |
attributes |
object |
- | A multi-valued list of strings indicating the names of resource attributes to return in the response. It is comma delimited. |
userName |
string |
user@domain |
The requested user’s username. NOTE: The userName must be unique across all SAP Concur products. If a userName is currently in use in any SAP Concur product, it cannot be assigned again unless the original occurrence is changed. For example, assume that a userName was assigned in error. That userName can only be used again if an admin (either manually or via import) renames the original occurrence, allowing the userName to be used again. The following characters cannot be used as a value for this record: % [ # ! * & ( ) ~ ‘ { ^ } \ / ? > < , ; : “ + = ], and pipe. |
companyId |
string |
- | Required, if employeeNumber is used The ID of the company the user belongs to. |
employeeNumber |
string |
- | Required, if companyId is used User’s employee number. NOTE: The employeeNumber must be unique within the CompanyId. |
externalId |
string |
- | User’s external ID. NOTE: The externalId must be unique within the CompanyId. |
excludedAttributes |
string |
- | A multi-valued list of strings indicating the names of resource attributes to be removed from the default set of attributes to return. |
startIndex |
string |
- | The 1-based index of the first query result. Default: 1 |
count |
string |
- | The desired maximum number of query results per page. Maximum count: 100 . Default: 10 |
Headers
Payload
None.
Response
Status Codes
- 200 OK
- 400 Bad Request
- 401 Unauthorized
- 404 Not Found
- 500 Internal Server Error
- 501 Not Implemented
- 502 Bad Gateway
- 503 Service Unavailable
- 504 Gateway Timeout
Headers
concur-correlationid
is a SAP Concur specific custom header used for technical support in the form of a RFC 4122 A Universally Unique IDentifier (UUID) URN Namespace- RFC 7231 Content-Type
Payload
Example
Request
GET https://us2.api.concursolutions.com/profile/identity/v4/Users/
Accept: application/json
Authorization: BEARER {token}
Response
200 OK
Content-Type: application/json
{
"schemas": [
"urn:ietf:params:scim:api:messages:2.0:ListResponse"
],
"totalResults": 107705,
"startIndex": 1,
"itemsPerPage": 20,
"Resources": [
{User 1 …},
{User 2…},…
{User 20…}
]
}
Retrieve a User’s Identity Profile
Retrieves a unique user based on the user’s UUID.
Request
URI
Template
GET https://us2.api.concursolutions.com/profile/identity/v4/Users/
Parameters
Name | Type | Format | Description |
---|---|---|---|
id |
string |
- | Requested user’s UUID. |
Headers
Payload
None.
Response
Status Codes
- 200 OK
- 400 Bad Request
- 401 Unauthorized
- 404 Not Found
- 500 Internal Server Error
- 501 Not Implemented
- 502 Bad Gateway
- 503 Service Unavailable
- 504 Gateway Timeout
Headers
concur-correlationid
is a SAP Concur specific custom header used for technical support in the form of a RFC 4122 A Universally Unique IDentifier (UUID) URN Namespace- RFC 7231 Content-Type
Payload
Example
Request
GET https://us2.api.concursolutions.com/profile/identity/v4/Users/
Accept: application/json
Authorization: BEARER {token}
Response
200 OK
Content-Type: application/json
{
"localeOverrides": {
"preferenceEndDayViewHour": 20,
"preferenceFirstDayOfWeek": "Sunday",
"preferenceDateFormat": "mm/dd/yyyy",
"preferenceCurrencySymbolLocation": "BeforeAmount",
"preferenceHourMinuteSeparator": ":",
"preferenceDistance": "mile",
"preferenceDefaultCalView": "month",
"preference24Hour": "H:mm AM/PM",
"preferenceNumberFormat": "1,000.00",
"preferenceStartDayViewHour": 8,
"preferenceNegativeCurrencyFormat": null,
"preferenceNegativeNumberFormat": null
},
"addresses": [],
"timezone": "America/New_York",
"meta": {
"resourceType": "User",
"created": "2021-11-17T22:44:09.000164Z",
"lastModified": "2021-11-17T22:48:31.000891Z",
"version": 4,
"location": "https://us2.api.concursolutions.com/profile/identity/v4/Users/3df11695-e8bb-40ff-8e98-c85913ab2789"
},
"displayName": "John",
"name": {
"familyName": "Doe",
"givenName": "John",
"honorificSuffix": "VI",
"familyNamePrefix": null
},
"phoneNumbers": [],
"emergencyContacts": null,
"preferredLanguage": "en-US",
"title": null,
"dateOfBirth": null,
"nickName": null,
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User",
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User",
"urn:ietf:params:scim:schemas:extension:sap:2.0:User"
],
"externalId": "1234_externalId",
"active": true,
"id": "3df11695-e8bb-40ff-8e98-c85913ab2789",
"emails": [
{
"verified": false,
"type": "work",
"value": "John11_17_1@sap.com",
"notifications": true
}
],
"userName": "John11_17_1@sap.com",
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
"terminationDate": null,
"companyId": "aa076ada-80a9-4f57-8e98-9300b1c3171d",
"manager": null,
"costCenter": null,
"startDate": "2021-11-17T00:00:00.000",
"employeeNumber": "1234_employeeNumber"
}
}
Create a User’s Identity Profile with POST
Creates a user’s identity profile.
Request
URI
Template
POST https://us2.api.concursolutions.com/profile/identity/v4/Users
Parameters
Name | Type | Format | Description |
---|---|---|---|
user |
string |
- | The user identity to create. |
Headers
Payload
None.
Response
Status Codes
- 200 OK
- 400 Bad Request
- 401 Unauthorized
- 404 Not Found
- 500 Internal Server Error
- 501 Not Implemented
- 502 Bad Gateway
- 503 Service Unavailable
- 504 Gateway Timeout
Headers
concur-correlationid
is a SAP Concur specific custom header used for technical support in the form of a RFC 4122 A Universally Unique IDentifier (UUID) URN Namespace- RFC 7231 Content-Type
- RFC 7235 Authorization
Payload
Example
Request
{
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User"
],
"userName": "John12_15_1@cs-sso-us-prod.com",
"active": true,
"name": {
"familyName": "Doe",
"givenName": "John"
},
"emails": [
{
"value": "John12_15_1@cs-sso-us-prod.com",
"type": "work"
}
],
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
"employeeNumber": "12345_employeeNumber",
"companyId": "aa076ada-80a9-4f57-8e98-9300b1c3171d"
}
}
Response
{
"localeOverrides": {
"preferenceEndDayViewHour": 20,
"preferenceFirstDayOfWeek": "Sunday",
"preferenceDateFormat": "mm/dd/yyyy",
"preferenceCurrencySymbolLocation": "BeforeAmount",
"preferenceHourMinuteSeparator": ":",
"preferenceDistance": "mile",
"preferenceDefaultCalView": "month",
"preference24Hour": "H:mm AM/PM",
"preferenceNumberFormat": "1,000.00",
"preferenceStartDayViewHour": 8
},
"timezone": "America/New_York",
"meta": {
"resourceType": "User",
"created": "2021-12-16T18:59:39.000543Z",
"lastModified": "2021-12-16T18:59:39.000543Z",
"version": 0,
"location": "https://us2.api.concursolutions.com/profile/identity/v4/Users/5e68f37d-26f2-417e-ac90-a6157f6d7e15"
},
"displayName": "John",
"name": {
"familyName": "Doe",
"givenName": "John",
"formatted": "Doe, John "
},
"preferredLanguage": "en-US",
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User",
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User",
"urn:ietf:params:scim:schemas:extension:sap:2.0:User"
],
"active": true,
"id": "5e68f37d-26f2-417e-ac90-a6157f6d7e15",
"emails": [
{
"value": "John12_15_1@cs-sso-us-prod.com",
"type": "work",
"notifications": false,
"verified": false
}
],
"userName": "John12_15_1@cs-sso-us-prod.com",
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
"employeeNumber": "12345_employeeNumber",
"companyId": "aa076ada-80a9-4f57-8e98-9300b1c3171d"
}
}
Update a User’s Identity Profile with PATCH
Updates applicable attributes in the user’s identity profile. Supported PATCH Operations:
- add
- replace
- remove
Request
URI
Template
PATCH https://us2.api.concursolutions.com/profile/identity/v4/Users/UUID
Parameters
Name | Type | Format | Description |
---|---|---|---|
id |
string |
- | The user’s UUID. |
Headers
Payload
None.
Response
Status Codes
- 200 OK
- 400 Bad Request
- 401 Unauthorized
- 404 Not Found
- 500 Internal Server Error
- 501 Not Implemented
- 502 Bad Gateway
- 503 Service Unavailable
- 504 Gateway Timeout
Headers
concur-correlationid
is a SAP Concur specific custom header used for technical support in the form of a RFC 4122 A Universally Unique IDentifier (UUID) URN Namespace- RFC 7231 Content-Type
- RFC 7235 Authorization
Payload
Example
Request
{
"schemas": [
"urn:ietf:params:scim:api:messages:2.0:PatchOp"
],
"Operations": [
{
"op": "add",
"path": "nickName",
"value": "Updated_Nickanme"
}
]
}
Response
{
"localeOverrides": {
"preferenceEndDayViewHour": 20,
"preferenceFirstDayOfWeek": "Sunday",
"preferenceDateFormat": "mm/dd/yyyy",
"preferenceCurrencySymbolLocation": "BeforeAmount",
"preferenceHourMinuteSeparator": ":",
"preferenceDistance": "mile",
"preferenceDefaultCalView": "month",
"preference24Hour": "H:mm AM/PM",
"preferenceNumberFormat": "1,000.00",
"preferenceStartDayViewHour": 8,
"preferenceNegativeCurrencyFormat": null,
"preferenceNegativeNumberFormat": null
},
"addresses": [],
"timezone": "America/New_York",
"meta": {
"resourceType": "User",
"created": "2021-12-16T18:59:39.000543Z",
"lastModified": "2021-12-16T19:08:34.000659Z",
"version": 4,
"location": "https://us2.api.concursolutions.com/profile/identity/v4/Users/5e68f37d-26f2-417e-ac90-a6157f6d7e15"
},
"displayName": "John",
"name": {
"honorificSuffix": null,
"formatted": "Doe, John ",
"familyName": "Doe",
"givenName": "John",
"familyNamePrefix": null,
"honorificPrefix": null,
"middleName": null
},
"phoneNumbers": [],
"emergencyContacts": null,
"preferredLanguage": "en-US",
"title": null,
"dateOfBirth": null,
"nickName": "Updated_Nickanme",
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User",
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User",
"urn:ietf:params:scim:schemas:extension:sap:2.0:User"
],
"active": true,
"id": "5e68f37d-26f2-417e-ac90-a6157f6d7e15",
"emails": [
{
"verified": false,
"type": "work",
"value": "John12_15_1@cs-sso-us-prod.com",
"notifications": false
}
],
"userName": "John12_15_1@cs-sso-us-prod.com",
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
"terminationDate": null,
"companyId": "aa076ada-80a9-4f57-8e98-9300b1c3171d",
"manager": null,
"costCenter": null,
"startDate": "2021-12-16T10:59:00.000",
"employeeNumber": "12345_employeeNumber"
}
}
Replace a User’s Identity Profile with PUT
Replaces a user’s identity profile. All data must be supplied or system will replace with system default or null
Request
URI
Template
PUT https://us2.api.concursolutions.com/profile/identity/v4/Users/UUID
Parameters
Name | Type | Format | Description |
---|---|---|---|
id |
string |
- | The user’s UUID. |
user |
string |
- | The user identity to update. |
Headers
Payload
Response
Status Codes
- 200 OK
- 400 Bad Request
- 401 Unauthorized
- 404 Not Found
- 500 Internal Server Error
- 501 Not Implemented
- 502 Bad Gateway
- 503 Service Unavailable
- 504 Gateway Timeout
Headers
concur-correlationid
is a SAP Concur specific custom header used for technical support in the form of a RFC 4122 A Universally Unique IDentifier (UUID) URN Namespace- RFC 7231 Content-Type
- RFC 7235 Authorization
Payload
Example
Request
{
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User"
],
"userName": "Jane12_15_2@cs-sso-us-prod.com",
"active": true,
"name": {
"familyName": "Doe",
"givenName": "Jane"
},
"emails": [
{
"value": "Jane12_15_2@cs-sso-us-prod.com",
"type": "work"
}
],
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
"employeeNumber": "123_employeeNumber",
"companyId": "aa076ada-80a9-4f57-8e98-9300b1c3171d"
}
}
Response
{
"localeOverrides": {
"preferenceEndDayViewHour": 20,
"preferenceFirstDayOfWeek": "Sunday",
"preferenceDateFormat": "mm/dd/yyyy",
"preferenceCurrencySymbolLocation": "BeforeAmount",
"preferenceHourMinuteSeparator": ":",
"preferenceDistance": "mile",
"preferenceDefaultCalView": "month",
"preference24Hour": "H:mm AM/PM",
"preferenceNumberFormat": "1,000.00",
"preferenceStartDayViewHour": 8,
"preferenceNegativeCurrencyFormat": null,
"preferenceNegativeNumberFormat": null
},
"timezone": "America/New_York",
"meta": {
"resourceType": "User",
"created": "2021-12-16T18:59:39.000543Z",
"lastModified": "2021-12-16T19:17:08.000500Z",
"version": 10,
"location": "https://us2.api.concursolutions.com/profile/identity/v4/Users/5e68f37d-26f2-417e-ac90-a6157f6d7e15"
},
"displayName": "Jane",
"name": {
"familyName": "Doe",
"givenName": "Jane",
"formatted": "Doe, Jane "
},
"preferredLanguage": "en-US",
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User",
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User",
"urn:ietf:params:scim:schemas:extension:sap:2.0:User"
],
"active": true,
"id": "5e68f37d-26f2-417e-8e98-a6157f6d7e15",
"emails": [
{
"value": "Jane12_15_2@cs-sso-us-prod.com",
"type": "work",
"verified": false,
"notifications": false
}
],
"userName": "Jane12_15_2@cs-sso-us-prod.com",
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
"employeeNumber": "123_employeeNumber",
"companyId": "aa076ada-80a9-4f57-8e98-9300b1c3171d",
"startDate": "2021-12-16T10:59:00.000",
"terminationDate": null
}
}
Schema
User
Name | Type | Format | Description |
---|---|---|---|
active |
boolean |
true /false |
Required If true , the user is active. |
addresses |
object |
- | A physical mailing address for this user. Supported values (only 1 per type): work , home , other , billing , bank , shipping |
addresses.country |
string |
- | A two-letter country code defined in ISO 3166-1 alpha-2. |
addresses.locality |
string |
- | The city or locality. |
addresses.postalCode |
string |
- | The zip code or postal code. |
addresses.region |
string |
- | The state or region. |
addresses.streetAddress |
string |
- | The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information. |
addresses.type |
string |
- | A label indicating the function of the address.Supported values: work , home , other , billing , bank , shipping |
dateOfBirth |
string |
YYYY-MM-DD |
The user’s date of birth. |
displayName |
string |
- | The name of the user, suitable for public display. |
emails |
object |
- | Required Email addresses for the user. The value should be canonicalized by the service provider. |
dateAdded |
string |
- | The date and time the email was added to the user’s profile. |
dateVerified |
string |
- | The date and time the email was verified. |
emails.notifications |
boolean |
true /false |
If true , notifications have been opted-in for emails. |
emails.type |
string |
- | A label indicating the attribute’s function. Supported values (only 1 per type): work , home , work2 , other , other2 |
emails.value |
string |
- | Required Email address value. |
emails.verified |
boolean |
true /false |
If true , the email has been verified by the user. |
emergencyContacts |
object |
- | Emergency contact information for the user. Only 1 contact is allowed. |
emergencyContacts.country |
string |
- | A two-letter country code defined in ISO 3166-1 alpha-2. |
emergencyContacts.emails |
string |
- | Emails of the emergency contact. |
emergencyContacts.locality |
string |
- | The city or locality of the emergency contact. |
emergencyContacts.name |
string |
- | Required The emergency contact’s name. |
emergencyContacts.phones |
string |
- | Phone numbers of the emergency contact. |
emergencyContacts.postalCode |
string |
- | The zip code or postal code of the emergency contact. |
emergencyContacts.region |
string |
- | The state or region of the emergency contact. |
emergencyContacts.relationship |
string |
- | Required The emergency contact’s relationship to the user. Supported values: Spouse , Brother , Parent , Sister , Life Partner , Other |
emergencyContacts.streetAddress |
string |
- | The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information. |
entitlements |
string |
- | The features enabled for the user. Supported values: Expense , Invoice , Locate , Request , Travel |
externalId |
string |
- | User identifier from the provisioning client. |
id |
string |
- | Required. Read Only Unique identifier for the user, also known as the UUID. |
localeOverrides |
object |
- | Read Only Support for users who want to override locale settings. |
localeOverrides.preference24Hour |
string |
- | Preferred 24 hour format for the user. Supported values: h:mm AM/PM , H:mm |
localeOverrides.preferenceCurrencySymbolLocation |
string |
- | Preferred currency symbol location for the user. Supported values: BeforeAmount , AfterAmount |
localeOverrides.preferenceDateFormat |
string |
- | Preferred date format for the user. |
localeOverrides.preferenceDefaultCalView |
string |
- | Preferred default calendar view for the user. Supported values: day , week , month |
localeOverrides.preferenceDistance |
string |
- | Preferred distance metric. Supported values: mile , km |
localeOverrides.preferenceEndDayViewHour |
integer |
- | Preferred hour setting for the end of day. Supported values: 0-23 |
localeOverrides.preferenceFirstDayOfWeek |
string |
- | Preferred first day of the week for the user. |
localeOverrides.preferenceHourMinuteSeparator |
string |
- | Preferred separator between hour and minute. Supported values: : , . |
localeOverrides.preferenceNegativeCurrencyFormat |
string |
- | Preferred negative currency format for the user. |
localeOverrides.preferenceNegativeNumberFormat |
string |
- | Preferred negative number format for the user. |
localeOverrides.preferenceNumberFormat |
string |
- | Preferred number format for the user. |
localeOverrides.preferenceStartDayViewHour |
integer |
- | Preferred start of day for the user, from 1 . |
meta |
object |
- | Read Only |
name |
object |
- | Required The user’s name. |
name.academicTitle |
string |
- | Title signifying level of academic achievement. |
name.familyName |
string |
- | Required The family or last name of the user. |
name.familyNamePrefix |
string |
- | The family name prefix of the user, if applicable. |
name.formatted |
string |
- | The full name of the user, formatted for display. Example: Jensen, Barbara Jane |
name.givenName |
string |
- | Required The given or first name of the user. |
name.honorificPrefix |
string |
- | The honorific or title prefix(es) of the user. |
name.honorificSuffix |
string |
- | The honorific suffix(es) of the user. |
name.legalName |
string |
- | The legal name of the user. |
name.middleInitial |
string |
- | The middle initial of the user, if applicable. |
name.middleName |
string |
- | The middle name(s) of the user, if applicable. |
nickName |
string |
- | The casual way to address the user. This attribute should not be used to represent a user’s username. Displays as Preferred Name in UI. |
phoneNumbers |
object |
- | Phone numbers for the user. The value should be canonicalized by the service provider according to the format specified in RFC 3966. Duplicates are not allowed for types other than mobile. |
phoneNumbers.display |
string |
- | A human-readable phone number for display. |
phoneNumbers.notifications |
boolean |
true /false |
If true , notifications have been opted in for phone numbers. This is only available for mobile phone numbers. |
phoneNumbers.operatingSystem |
string |
- | The operating system of the device, when the phone is a cellphone type. |
phoneNumbers.primary |
boolean |
true /false |
If true , this is the primary mobile device. This is only available for mobile phone numbers. One mobile phone number must be set as the primary number and only one phone number can be set to primary at a time. |
phoneNumbers.type |
string |
- | A label indicating the attribute’s function. Supported values (only 1 per type): work , home , mobile , fax , pager , other |
phoneNumbers.value |
string |
- | Required The phone number value. |
preferredLanguage |
string |
- | Indicates the user’s preferred written or spoken language. Default: en-US |
timezone |
string |
- | The user’s time zone in the Olson time zone database format. See Time Zones Default: America/New_York |
title |
string |
- | The user’s job title in the company. |
userName |
string |
user@domain |
Required The name that can be used to login to Concur Travel and Expense. NOTE: The userName must be unique across all SAP Concur products. If a userName is currently in use in any SAP Concur product, it cannot be assigned again unless the original occurrence is changed. For example, assume that a userName was assigned in error. That userName can only be used again if an admin (either manually or via import) renames the original occurrence, allowing the userName to be used again. The following characters cannot be used as a value for this record: % [ # ! * & ( ) ~ ‘ { ^ } \ / ? > < , ; : “ + = ] and pipe |
Enterprise User
Name | Type | Format | Description |
---|---|---|---|
companyId |
string |
- | Required. Immutable The SAP Concur ID of the company. |
costCenter |
string |
- | The employee cost center for product. The value of this parameter is provisioned and is not related to the Concur Expense costCenter . |
department |
string |
- | Client supplied department name. The value of this parameter is provisioned and is not related to the Concur Expense department . |
division |
string |
- | Client supplied division name. The value of this parameter is provisioned and is not related to the Concur Expense division . |
employeeNumber |
string |
- | Client supplied employee number within the company, unique for the company. |
manager |
object |
- | The user’s manager. To provision manager of this user, use UUID of the manager. |
manager.$ref |
string |
- | The URI of the SCIM resource representing the manager. |
manager.displayName |
string |
- | Read Only The managers display name. |
manager.employeeNumber |
string |
- | The managers employee number. |
manager.value |
string |
- | The Manager UUID. |
organization |
string |
- | Read Only The company name. |
startDate |
string |
YYYY-MM-DD |
The user’s start date. |
terminationDate |
string |
YYYY-MM-DD |
The user’s termination date. |
SAP User
User reference identifier for a user’s SAP Global ID. Used for intra SAP service communication.
Name | Type | Format | Description |
---|---|---|---|
userUuid |
string |
uuid |
User’s SAP Global ID. |
UserList
Name | Type | Format | Description |
---|---|---|---|
totalResults |
integer |
- | The total number of results matching the client query. |
itemsPerPage |
integer |
- | The number of query results returned in a query response page. |
startIndex |
integer |
- | The 1-based index of the first result in the current set of query results. |
Resources |
User |
- | - |
Company
Name | Type | Format | Description |
---|---|---|---|
active |
boolean |
true /false |
Required If true , the company is active. To set false, must also set terminationDate to current date. To set true, must also set terminationDate to future date. |
addresses |
object |
- | - |
country |
string |
- | A two-letter country code defined in ISO 3166-1 alpha-2. |
locality |
string |
- | The city or locality of the company address. |
postalCode |
string |
- | The zip code or postal code of the company address. |
region |
string |
- | The state or region of the company address. |
streetAddress |
string |
- | The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information. |
companyDomain |
string |
- | The company’s company domain name. |
contact |
object |
- | - |
country |
string |
- | A two-letter country code defined in ISO 3166-1 alpha-2. |
emails |
string |
- | Emails of the contact. |
locality |
string |
- | The city or locality of the contact. |
name |
string |
- | Required Name of the contact. |
phones |
string |
- | Phone numbers of the contact. |
postalCode |
string |
- | The zip code or postal code of the contact. |
region |
string |
- | The state or region. |
streetAddress |
string |
- | The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information. |
defaultLanguage |
string |
- | Indicates the default language for the company. |
entitlements |
string |
- | The features enabled for the company. Supported values: Expense , Invoice , Locate , Request , Travel |
id |
string |
- | Required Unique identifier for the company, also known as the company UUID. |
internetDomain |
string |
- | The company’s internet domain name. |
meta |
object |
- | - |
name |
string |
- | The name of the company. |
schemas |
string |
- | Read Only |
loginPolicy |
object |
- | - |
hideForgotLoginIdLink |
boolean |
true /false |
If true , the Forgot LoginId Link will be hidden. |
loginFailureLockoutDuration |
integer |
- | The duration of the login failure lockout. |
loginFailureWindowDuration |
integer |
- | The window duration of the login failure. |
loginFailuresAllowed |
integer |
- | The amount of login failures allowed. |
loginIPRestriction |
string |
- | The login IP restrictions. |
loginOneTimeLinkExpirationLength |
integer |
- | The length of the one time login expiration link. |
loginViaSsoOnly |
boolean |
true /false |
If true , the login is available via SSO only. |
passwordPolicy |
object |
- | - |
daysUntilExpiration |
integer |
- | Number of days until password expiration. |
expirePasswordOnUserCreation |
boolean |
true /false |
If true , the password will expire on user creation. |
maxLength |
integer |
- | Maximum length of the password. |
minLength |
integer |
- | Minimum length of the password. |
mobileAuthenticationLifetime |
integer |
- | The mobile session timeout in seconds. |
mobileMinLength |
integer |
- | The minimum length of the password for mobile. |
mobileRequiresMixedCase |
boolean |
true /false |
If true , the password will require mixed cases for mobile. |
mobileRequiresNonalphanum |
boolean |
true /false |
If true , the password will require non-alphanumeric characters for mobile. |
numGenerationsBeforeCanReuse |
integer |
- | Number of generations before the password can be reused. |
numSecurityQuestions |
integer |
- | The number of required security questions. |
numSecurityQuestionsUsersPick |
integer |
- | The number of security questions users can pick. |
passwordResetEmailPolicy |
string |
- | When the password reset email should be sent. Supported values: never , anyTime , afterFirstLogin |
passwordResetSupportEmail |
string |
- | The from address of the password or PIN reset email. |
requiresMixedCase |
boolean |
true /false |
If true , the password will require mixed cases. |
requiresNonAlpha |
boolean |
true /false |
If true , the password will requires non-alphabetic characters. |
requiresNonAlphanum |
boolean |
true /false |
If true , the password will require non-alphanumeric characters. |
requiresNumber |
boolean |
true /false |
If true , the password will require numbers. |
requiresSecurityQuestions |
boolean |
true /false |
If true , security questions will be required. |
restrictPasswordResetOncePerDay |
boolean |
true /false |
If true , password resets will be limited to once a day. |
channels |
string |
- | - |
enabled |
boolean |
true /false |
If true , channels will be enabled. |
tenantIdSpend |
string |
- | The ID of the spend tenant for the company. |
tenantIdTravel |
string |
- | The ID of the travel tenant for the company. |
Schema Extension
Name | Type | Format | Description |
---|---|---|---|
schema |
string |
- | Required The string identifier of the extension. |
required |
boolean |
true /false |
Required If true , this extension is a required part of the schema. |
Resource Type
Name | Type | Format | Description |
---|---|---|---|
attributes |
SchemaExtension |
- | Required The resource’s extensions. |
description |
string |
- | Required The resource’s description. |
endpoint |
string |
- | Required The resource’s HTTP addressable endpoint relative to the base URL. Example: /Users |
id |
string |
- | Required The resource’s ID. |
name |
string |
- | Required The resource’s name. Example: User |
schema |
string |
- | Required The resource’s associated schema. |
Authenticated Schemas
Name | Type | Format | Description |
---|---|---|---|
description |
string |
- | Required The description of the authentication schema. |
documentationUrl |
string |
- | Required An HTTP addressable URL pointing to the authentication schema’s usage documentation. |
name |
string |
- | Required The common authentication schema name. Example: HTTP Basic |
specUrl |
string |
- | Required An HTTP addressable URL pointing to the authentication schema’s specification. |
Service Provider Config
Name | Type | Format | Description |
---|---|---|---|
authenticationSchemes |
AuthenticationSchemes |
- | Required Specifies supported authentication schema properties. |
bulk |
ServiceProviderConfigSetting |
- | Required Details about the feature support for the service provider. |
changePassword |
ServiceProviderConfigSetting |
- | Required Details about the feature support for the service provider. |
documentationUrl |
string |
- | Required An HTTP addressable URL pointing to the service provider’s help documentation. |
etag |
ServiceProviderConfigSetting |
- | Required Details about the feature support for the service provider. |
filter |
ServiceProviderConfigSetting |
- | Required Details about the feature support for the service provider. |
patch |
ServiceProviderConfigSetting |
- | Required Details about the feature support for the service provider. |
sort |
ServiceProviderConfigSetting |
- | Required Details about the feature support for the service provider. |
Service Provider Config Setting
Name | Type | Format | Description |
---|---|---|---|
supported |
boolean |
true /false |
If true , the feature is supported. |
Concur Error
Name | Type | Format | Description |
---|---|---|---|
messages |
object |
- | Additional messages in case of errors/warnings. |
code |
string |
- | Required The error message code. |
message |
string |
- | The error message description. |
schemaPath |
string |
- | The relative schema path of attribute. |
type |
string |
- | Required The error message type. Supported values: error , warning |
Error Response
Name | Type | Format | Description |
---|---|---|---|
scimType |
string |
- | The SCIM detail error keyword. |
detail |
string |
- | The human readable message. |
status |
string |
- | Required The HTTP status code. |