How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

American Express Global Business Travel SCIM User Sync V1 API

SCIM 2.0 compliant user sync APIs

American Express Global Business Travel SCIM User Sync V1 API is one of 26 APIs that American Express Global Business Travel publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include SCIM User Sync V1. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, API documentation, and authentication docs.

This API exposes 6 operations across 3 paths, and defines 26 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against a single base URL, https://apis.egencia.com/openconnect/api.

6 operations 3 paths 26 schemas 1 DELETE1 GET1 PATCH2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://apis.egencia.com/openconnect/api
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

American Express Global Business Travel SCIM User Sync V1 API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2) using the clientCredentials flow.

Paths & Operations 6

Across 3 paths, the API surfaces 6 operations — 1 DELETE, 1 GET, 1 PATCH, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

SCIM User Sync V1 6

SCIM 2.0 compliant user sync APIs

POST
/scim/v1/users
Create a new user in the system with the requested information.
createUser_2 body → 200400401403422500503
POST
/scim/v1/users/search
Return list of users based on the filter condition.
getUserByCondition body → 200400401403422500503
DELETE
/scim/v1/users/{userId}
Delete the user in the system with the given user Id.
deleteUserUser_2 1 param → 204401403404422500503
GET
/scim/v1/users/{userId}
Retrieves the user details for a requested user identifier.
getUser_2 1 param → 200400401403404422500503
PATCH
/scim/v1/users/{userId}
Perform patch operation on the user with the given user Id.
patchUser_2 1 param body → 200401403404422500503
PUT
/scim/v1/users/{userId}
Updates an existing user in the system with the requested information.
updateUser_2 1 param body → 200400401403422500503

Schemas 26

The contract defines 26 schemas that model the data the API accepts and returns. The most detailed are UserSchema_2 (17 properties), EnterpriseUserSchema (14 properties), LoyaltyProgramSchema (10 properties), PreferenceSchema (10 properties). Each schema is shown below with its type and property counts.

UserSchema
object
The user resource schema.
6 properties 4 required
PointOfSaleSchema
object
The complex model containing point of sale association.
5 properties 2 required
SearchRequest
object
The user search schema. Currently it supports only emails with eq operator.
3 properties 2 required
AdminUserSchema
object
The extended custom attributes specific to Egencia travel management system.
5 properties 4 required
ScimPatchOperationSchema
object
A complex object for scim patch oeration.
3 properties
ScimPatchSchema
object
The user patch request schema.
3 properties 2 required
NameSchema
object
The complex model containing name attributes of the user.
4 properties 2 required
EmailSchema
object
The complex model containing email details of the user.
3 properties 2 required
MetaSchema
object
A complex attribute containing resource metadata.
4 properties
LoyaltyProgramSchema
object
The complex model containing details of loyalty programs associated with the user.
10 properties 4 required
NameSchema_2
object
The complex model containing name attributes of the user.
5 properties 2 required
ApproverSchema
object
Approver details for the user like level 1, level 2 approvers etc. Approver of a user must already exist and its unique id needs to be passed to associate that…
3 properties
GroupSchema
object
The complex model containing details of traveller group to which user is associated.
2 properties 1 required
AddressSchema
object
The complex model containing contact address attributes of the user.
7 properties 5 required
UserSettingsSchema
object
Schema to denote the user settings.
1 property
UserNotificationsSchema
object
Schema to denote user notifications settings.
2 properties
CustomDataFieldSchema
object
Egencia reporting fields. A complex attribute containing custom data fields associated with the user.
2 properties 2 required
EmailSchema_2
object
The complex model containing email details of the user.
3 properties 2 required
ArrangerSchema
object
The complex model containing arrangers of the user.
3 properties
DocumentSchema
object
The complex model containing user document details like passport, Id card, etc.
6 properties 2 required
RoleSchema
object
The complex model containing role details to which the user is associated.
3 properties 1 required
UserSchema_2
object
The user resource schema.
17 properties 9 required
EnterpriseUserSchema
object
The extended custom attributes specific to Egencia travel management system.
14 properties 1 required
ContactSchema
object
The complex model containing contact attributes of the user.
3 properties 2 required
PreferenceSchema
object
The complex model containing details of the user preferences.
10 properties 1 required
MetaSchema_2
object
A complex attribute containing resource metadata.
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

amex-gbt-scim-user-sync-v1-api-openapi.yml Raw ↑

Other APIs American Express Global Business Travel publishes across the network.

American Express Global Business Travel Agent Assist Notes API
American Express Global Business Travel Approval API
American Express Global Business Travel Availability Probes Controller API
American Express Global Business Travel bookings v1 API
American Express Global Business Travel bookings v2 API
American Express Global Business Travel Company Details API
American Express Global Business Travel Custom Data Field Cleanup Controller API
American Express Global Business Travel Custom Data Fields (CDF) API
American Express Global Business Travel Doc Audit Clean Up Controller API
American Express Global Business Travel DutyOfCare Data API
American Express Global Business Travel Ecommerce Settings Controller API
American Express Global Business Travel Expense SPI API
Where this information came from

This is an independent, third-party profile of American Express Global Business Travel SCIM User Sync V1 API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.