openapi: 3.2.0 info: title: OpenAPI definition SCIM V1 Admin Users API version: v0 description: SCIM 2.0 compliant admin-users sync APIs servers: - url: https://apis.egencia.com/openconnect/api description: Generated server url tags: - description: SCIM 2.0 compliant admin-users sync APIs name: scim-v1-admin-users paths: /scim/v1/admin-users: get: description: "\n \n
\n
\n
\n
\n \n

\n 1. Create\n

\n \n

\n 1.1. API Details\n

\n
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
\n Method\n \n POST\n
\n URL\n \n \n {{URL}}/\n \n openconnect-service/scim/v1/admin\n \n \n
\n
\n \n

\n 1.2. Request\n

\n \n

\n 1.2.1. Sample Request\n

\n
\n
\n 
{\n            \"schemas\": [\n              \"urn:ietf:params:scim:schemas:core:2.0:User\",\n              \"urn:ietf:params:scim:schemas:extension:egencia:2.0:Admin\"\n            ],\n            \"name\": {\n              \"familyName\": \"Sample\",\n              \"givenName\": \"Api\",\n              \"middleName\": \"Test\"\n            },\n            \"emails\": [\n              {\n                \"type\": \"WORK\",\n                \"value\": \"api.sample@egencia.com\",\n                \"primary\": true\n              }\n            ],\n            \"urn:ietf:params:scim:schemas:extension:egencia:2.0:Admin\": {\n              \"department\": \"ect - contact center\",\n              \"partner\": \"Egencia\",\n              \"geography\": \"Dubai\",\n              \"pointOfSales\": [\n                {\n                  \"pointOfSaleId\": 60006,\n                  \"role\": \"SITE_RELEASE_ROLE_ADMIN\"\n                },\n                {\n                  \"pointOfSaleId\": 60008,\n                  \"role\": \"SUPER_TIER_III\"\n                }\n              ]\n            }\n            }
\n
\n
\n \n

\n 1.2.2. Modals\n

\n \n
\n 1.2.2.1. User\n
\n
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
\n Name\n \n Type\n \n Required\n
schemas\n array[String]\n \n Yes\n
name\n \n Name\n \n \n Yes\n
\n emails\n \n array[ Email] \n \n Yes\n
customAttributes\n Admin\n \n Yes\n
\n
\n \n
\n 1.2.2.2. Name\n
\n
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
\n Name\n \n Type\n \n Required\n
familyName\n String\n \n Yes\n
givenName\n String\n \n Yes\n
\n middleName\n \n String\n \n No\n
\n
\n \n
\n 1.2.2.3. Email\n
\n
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
\n Name\n \n Type\n \n Required\n \n Notes\n
type\n String\n \n Yes\n \n See Appendix 4 for possible values \n
value\n String\n \n Yes\n \n \n
\n \n
\n primary\n \n Boolean\n \n No\n \n \n
\n \n
\n
\n \n
\n 1.2.2.4. Admin\n
\n
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
\n Name\n \n Type\n \n Required\n
department\n String\n \n Yes\n
partner\n String\n \n Yes\n
\n geography\n \n String\n \n Yes\n
\n pointOfSales\n \n \n PosAssociation\n \n \n Yes\n
\n
\n \n
\n 1.2.2.5. \n PosAssociation\n
\n
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
\n Name\n \n Type\n \n Required\n \n Notes\n
pointOfSaleId\n Integer\n \n Yes\n \n
\n
role\n AdminRole\n \n Yes\n See Appendix 1 for possible values
\n
\n \n

\n 1.3. Response\n

\n \n

\n 1.3.1. Sample Response\n

\n
\n
\n 
{\n              \"schemas\": [\n                  \"urn:ietf:params:scim:schemas:extension:egencia:2.0:AdminSearchResponse\",\n                  \"urn:ietf:params:scim:api:messages:2.0:ListResponse\",\n                  \"urn:ietf:params:scim:api:messages:2.0:SearchResponse\"\n              ],\n              \"Resources\": [\n                  {\n                      \"name\": {\n                          \"familyName\": \"adminuser\",\n                          \"givenName\": \"egencia\"\n                      },\n                      \"username\": \"ECTDUBegenciaa34\",\n                      \"emails\": [\n                          {\n                              \"type\": \"WORK\",\n                              \"value\": \"adminuser@egencia.com\",\n                              \"primary\": true\n                          }\n                      ],\n                      \"urn:ietf:params:scim:schemas:extension:egencia:2.0:AdminSearchResponse\": {\n                          \"partner\": \"Egencia\",\n                          \"department\": \"ect - contact center\",\n                          \"geography\": \"Dubai\",\n                          \"pointOfSales\": [\n                              {\n                                  \"pointOfSaleId\": 60123,\n                                  \"userId\": 6999933,\n                                  \"role\": \"Fulfillment Manager\",\n                                  \"status\": \"ACTIVE\"\n                              },\n                              {\n                                  \"pointOfSaleId\": 60084,\n                                  \"userId\": 6999948,\n                                  \"role\": \"Super User\",\n                                  \"status\": \"ACTIVE\"\n                              },\n                              {\n                                  \"pointOfSaleId\": 60004,\n                                  \"userId\": 6999808,\n                                  \"role\": \"Fraud Manager\",\n                                  \"status\": \"ACTIVE\"\n                              },\n                              {\n                                  \"pointOfSaleId\": 60095,\n                                  \"userId\": 6999819,\n                                  \"role\": \"Travelshops Admin\",\n                                  \"status\": \"ACTIVE\"\n                              },\n                              {\n                                  \"pointOfSaleId\": 60006,\n                                  \"userId\": 6999261,\n                                  \"role\": \"Fraud Agent\",\n                                  \"status\": \"INACTIVE\"\n                              }\n                          ]\n                      }\n                  }\n              ]\n            }
\n
\n
\n \n

\n 1.3.2. Modals\n

\n \n
\n 1.3.2.1. ListResponse\n
\n
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
\n Name\n \n Type\n
schemas\n array[String]\n
resources\n array[ Resource] \n
\n
\n \n
\n 1.3.2.2. Resource\n
\n
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
\n Name\n \n Type\n
name\n Name\n
userName\n String\n
emails\n array[ Email] \n
customAttributes\n \n AdminResponse\n \n
\n
\n \n
\n 1.3.2.3. AdminResponse\n
\n
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
\n Name\n \n Type\n
partner\n Name\n
department\n String\n
geography\n String\n
pointOfSales\n \n PosAssociationResponse\n \n
\n
\n \n
\n 1.3.2.4. \n PosAssociationResponse\n
\n
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
\n Name\n \n Type\n \n Notes\n
pointOfSaleId\n Integer\n \n
\n
userId\n Integer\n \n
\n
role\n String\n \n
\n
status\n AdminStatus\n See Appendix 2 for possible values
\n
\n

\n 3. Appendix\n

\n \n

\n 3.1. AdminRole\n

\n
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
1FULFILLMENT_STAFF
2FULFILLMENT_MANAGER
3GUEST
4FRAUD_AGENT
5FRAUD_MANAGER
6INTERNAL_USER
7TS_LEAD_AGENT
8TS_CALL_CENTER_MANAGER
9TS_AGENT
10REGIONAL_MANAGER
11SUPER_USER
12TRAVELSHOPS_ADMIN
13MERCHANT_ACCOUNT_HELP_ADMIN
14ECT_AGENT
15ECT_AGENT_LEAD
16ECT_CALL_CENTER_MANAGER
17ECT_IMPLEMENTATIONS_STAFF
18ECT_SALES_ACCOUNT_MANAGEMENT
19CRUISE_PROMO_MGR
20CHARTER_EXTRANET
21DATA_AND_CONTENT_READ_ONLY_USER
22UBER_ROLE_ADMIN
23FRAUD_ROLE_ADMIN
24FRAUD_INVESTIGATOR
25TRANSPORTATION_ROLE_ADMIN
26AGENCY_OPS_ROLE_ADMIN
27CUSTOMER_SERVICE_REP
28EXCEPTION_REFUNDS
29SME
30TS_ACCOUNTING_REP_CARS
31CCS_AGENT
32CCS_LEAD_AGENT
33SITE_RELEASE_NORTHAM
34SITE_RELEASE_ROLE_ADMIN
35CRUISE_CONTENT_ROLE_ADMIN
36TIER_III
37AGENCY_OPS_HIMS
38CLIENT_SERVICES
39CRUISE_GROUP_LEADER
40LOCAL_AIR_BUSINESS_MANAGER
41ECT_REPORTING_ADMINISTRATOR
42COUPON_CREATOR
43SUPER_TIER_III
44REDEMPTION_LEAD
45SENIOR_INTERNAL_USER
46GLOBAL_ADMIN
47READ_ONLY_ITINERARY_USER
48TRAVEL_PROMOTIONS
\n
\n \n

\n 3.2. AdminStatus\n

\n
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
1ACTIVE
2INACTIVE
\n
\n \n

\n 3.3. Filter\n

\n \n

\n 3.3.1. Mandatory Parameters\n

\n
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
1userNameAt least one of these parameters should be present in the filter query. They can be given individually or simultaneously by combining these parameters by using \"and\" operator. The optional parameters, which are given in the following table can also be combined together with these mandatory parameters.
2name[givenName]
3name[familyName]
4email
\n
\n \n

\n 3.3.2. Optional Parameters\n

\n
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
1statusThis parameter is used to filter out point of sales based on the status. This parameter can only be given along with the mandatory parameters. See AdminStatus for possible values.
2exactMatch\n

The possible values for exactMatch parameter are \"true\" and \"false\". The default value for this parameter is \"false\". This parameter can only be passed along with the mandatory parameters. If this parameter not passed in the query or set it as \"false\", then the search response contains resources with their values start with the required parameter. If it is \"true\", then the search response contains resources with exact value.

\n
\n
\n \n

\n 3.4. Email Type\n

\n
\n \n \n \n \n \n \n \n \n \n \n \n
1WORK
\n
\n
\n
\n
\n
\n \n \n" operationId: getAllAdminUsers parameters: - description: 1-based index of the first query result in: query name: startIndex required: false schema: type: integer format: int32 - description: Maximum number of query results per page in: query name: count required: false schema: type: integer format: int32 - description: Status of the admin user in: query name: status required: false schema: type: string default: ACTIVE responses: '400': content: application/scim+json: schema: $ref: '#/components/schemas/ListResponse' description: 'Bad Request : Invalid input or request' '401': content: application/scim+json: schema: $ref: '#/components/schemas/ListResponse' description: 'Unauthorized : Authentication token empty, invalid or expired.' '403': content: application/scim+json: schema: $ref: '#/components/schemas/ListResponse' description: 'Forbidden : User is not authorized to perform this operation.' '422': content: application/scim+json: schema: $ref: '#/components/schemas/ListResponse' description: 'Invalid input : Invalid or missing required input.' '500': content: application/scim+json: schema: $ref: '#/components/schemas/ListResponse' description: 'Internal Server Error : Unable to process request.' '503': content: application/scim+json: schema: $ref: '#/components/schemas/ListResponse' description: 'Service unavailable : Unable to process request at the moment.' security: - OAuth2: [] summary: Get all admin users in the system based on status. tags: - scim-v1-admin-users post: description: "\n \n
\n
\n
\n
\n \n

\n 1. Create\n

\n \n

\n 1.1. API Details\n

\n
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
\n Method\n \n POST\n
\n URL\n \n \n {{URL}}/\n \n openconnect-service/scim/v1/admin\n \n \n
\n
\n \n

\n 1.2. Request\n

\n \n

\n 1.2.1. Sample Request\n

\n
\n
\n 
{\n            \"schemas\": [\n              \"urn:ietf:params:scim:schemas:core:2.0:User\",\n              \"urn:ietf:params:scim:schemas:extension:egencia:2.0:Admin\"\n            ],\n            \"name\": {\n              \"familyName\": \"Sample\",\n              \"givenName\": \"Api\",\n              \"middleName\": \"Test\"\n            },\n            \"emails\": [\n              {\n                \"type\": \"WORK\",\n                \"value\": \"api.sample@egencia.com\",\n                \"primary\": true\n              }\n            ],\n            \"urn:ietf:params:scim:schemas:extension:egencia:2.0:Admin\": {\n              \"department\": \"ect - contact center\",\n              \"partner\": \"Egencia\",\n              \"geography\": \"Dubai\",\n              \"pointOfSales\": [\n                {\n                  \"pointOfSaleId\": 60006,\n                  \"role\": \"SITE_RELEASE_ROLE_ADMIN\"\n                },\n                {\n                  \"pointOfSaleId\": 60008,\n                  \"role\": \"SUPER_TIER_III\"\n                }\n              ]\n            }\n            }
\n
\n
\n \n

\n 1.2.2. Modals\n

\n \n
\n 1.2.2.1. User\n
\n
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
\n Name\n \n Type\n \n Required\n
schemas\n array[String]\n \n Yes\n
name\n \n Name\n \n \n Yes\n
\n emails\n \n array[ Email] \n \n Yes\n
customAttributes\n Admin\n \n Yes\n
\n
\n \n
\n 1.2.2.2. Name\n
\n
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
\n Name\n \n Type\n \n Required\n
familyName\n String\n \n Yes\n
givenName\n String\n \n Yes\n
\n middleName\n \n String\n \n No\n
\n
\n \n
\n 1.2.2.3. Email\n
\n
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
\n Name\n \n Type\n \n Required\n \n Notes\n
type\n String\n \n Yes\n \n See Appendix 4 for possible values \n
value\n String\n \n Yes\n \n \n
\n \n
\n primary\n \n Boolean\n \n No\n \n \n
\n \n
\n
\n \n
\n 1.2.2.4. Admin\n
\n
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
\n Name\n \n Type\n \n Required\n
department\n String\n \n Yes\n
partner\n String\n \n Yes\n
\n geography\n \n String\n \n Yes\n
\n pointOfSales\n \n \n PosAssociation\n \n \n Yes\n
\n
\n \n
\n 1.2.2.5. \n PosAssociation\n
\n
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
\n Name\n \n Type\n \n Required\n \n Notes\n
pointOfSaleId\n Integer\n \n Yes\n \n
\n
role\n AdminRole\n \n Yes\n See Appendix 1 for possible values
\n
\n \n

\n 1.3. Response\n

\n \n

\n 1.3.1. Sample Response\n

\n
\n
\n 
{\n              \"schemas\": [\n                  \"urn:ietf:params:scim:schemas:extension:egencia:2.0:AdminSearchResponse\",\n                  \"urn:ietf:params:scim:api:messages:2.0:ListResponse\",\n                  \"urn:ietf:params:scim:api:messages:2.0:SearchResponse\"\n              ],\n              \"Resources\": [\n                  {\n                      \"name\": {\n                          \"familyName\": \"adminuser\",\n                          \"givenName\": \"egencia\"\n                      },\n                      \"username\": \"ECTDUBegenciaa34\",\n                      \"emails\": [\n                          {\n                              \"type\": \"WORK\",\n                              \"value\": \"adminuser@egencia.com\",\n                              \"primary\": true\n                          }\n                      ],\n                      \"urn:ietf:params:scim:schemas:extension:egencia:2.0:AdminSearchResponse\": {\n                          \"partner\": \"Egencia\",\n                          \"department\": \"ect - contact center\",\n                          \"geography\": \"Dubai\",\n                          \"pointOfSales\": [\n                              {\n                                  \"pointOfSaleId\": 60123,\n                                  \"userId\": 6999933,\n                                  \"role\": \"Fulfillment Manager\",\n                                  \"status\": \"ACTIVE\"\n                              },\n                              {\n                                  \"pointOfSaleId\": 60084,\n                                  \"userId\": 6999948,\n                                  \"role\": \"Super User\",\n                                  \"status\": \"ACTIVE\"\n                              },\n                              {\n                                  \"pointOfSaleId\": 60004,\n                                  \"userId\": 6999808,\n                                  \"role\": \"Fraud Manager\",\n                                  \"status\": \"ACTIVE\"\n                              },\n                              {\n                                  \"pointOfSaleId\": 60095,\n                                  \"userId\": 6999819,\n                                  \"role\": \"Travelshops Admin\",\n                                  \"status\": \"ACTIVE\"\n                              },\n                              {\n                                  \"pointOfSaleId\": 60006,\n                                  \"userId\": 6999261,\n                                  \"role\": \"Fraud Agent\",\n                                  \"status\": \"INACTIVE\"\n                              }\n                          ]\n                      }\n                  }\n              ]\n            }
\n
\n
\n \n

\n 1.3.2. Modals\n

\n \n
\n 1.3.2.1. ListResponse\n
\n
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
\n Name\n \n Type\n
schemas\n array[String]\n
resources\n array[ Resource] \n
\n
\n \n
\n 1.3.2.2. Resource\n
\n
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
\n Name\n \n Type\n
name\n Name\n
userName\n String\n
emails\n array[ Email] \n
customAttributes\n \n AdminResponse\n \n
\n
\n \n
\n 1.3.2.3. AdminResponse\n
\n
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
\n Name\n \n Type\n
partner\n Name\n
department\n String\n
geography\n String\n
pointOfSales\n \n PosAssociationResponse\n \n
\n
\n \n
\n 1.3.2.4. \n PosAssociationResponse\n
\n
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
\n Name\n \n Type\n \n Notes\n
pointOfSaleId\n Integer\n \n
\n
userId\n Integer\n \n
\n
role\n String\n \n
\n
status\n AdminStatus\n See Appendix 2 for possible values
\n
\n

\n 3. Appendix\n

\n \n

\n 3.1. AdminRole\n

\n
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
1FULFILLMENT_STAFF
2FULFILLMENT_MANAGER
3GUEST
4FRAUD_AGENT
5FRAUD_MANAGER
6INTERNAL_USER
7TS_LEAD_AGENT
8TS_CALL_CENTER_MANAGER
9TS_AGENT
10REGIONAL_MANAGER
11SUPER_USER
12TRAVELSHOPS_ADMIN
13MERCHANT_ACCOUNT_HELP_ADMIN
14ECT_AGENT
15ECT_AGENT_LEAD
16ECT_CALL_CENTER_MANAGER
17ECT_IMPLEMENTATIONS_STAFF
18ECT_SALES_ACCOUNT_MANAGEMENT
19CRUISE_PROMO_MGR
20CHARTER_EXTRANET
21DATA_AND_CONTENT_READ_ONLY_USER
22UBER_ROLE_ADMIN
23FRAUD_ROLE_ADMIN
24FRAUD_INVESTIGATOR
25TRANSPORTATION_ROLE_ADMIN
26AGENCY_OPS_ROLE_ADMIN
27CUSTOMER_SERVICE_REP
28EXCEPTION_REFUNDS
29SME
30TS_ACCOUNTING_REP_CARS
31CCS_AGENT
32CCS_LEAD_AGENT
33SITE_RELEASE_NORTHAM
34SITE_RELEASE_ROLE_ADMIN
35CRUISE_CONTENT_ROLE_ADMIN
36TIER_III
37AGENCY_OPS_HIMS
38CLIENT_SERVICES
39CRUISE_GROUP_LEADER
40LOCAL_AIR_BUSINESS_MANAGER
41ECT_REPORTING_ADMINISTRATOR
42COUPON_CREATOR
43SUPER_TIER_III
44REDEMPTION_LEAD
45SENIOR_INTERNAL_USER
46GLOBAL_ADMIN
47READ_ONLY_ITINERARY_USER
48TRAVEL_PROMOTIONS
\n
\n \n

\n 3.2. AdminStatus\n

\n
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
1ACTIVE
2INACTIVE
\n
\n \n

\n 3.3. Filter\n

\n \n

\n 3.3.1. Mandatory Parameters\n

\n
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
1userNameAt least one of these parameters should be present in the filter query. They can be given individually or simultaneously by combining these parameters by using \"and\" operator. The optional parameters, which are given in the following table can also be combined together with these mandatory parameters.
2name[givenName]
3name[familyName]
4email
\n
\n \n

\n 3.3.2. Optional Parameters\n

\n
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
1statusThis parameter is used to filter out point of sales based on the status. This parameter can only be given along with the mandatory parameters. See AdminStatus for possible values.
2exactMatch\n

The possible values for exactMatch parameter are \"true\" and \"false\". The default value for this parameter is \"false\". This parameter can only be passed along with the mandatory parameters. If this parameter not passed in the query or set it as \"false\", then the search response contains resources with their values start with the required parameter. If it is \"true\", then the search response contains resources with exact value.

\n
\n
\n \n

\n 3.4. Email Type\n

\n
\n \n \n \n \n \n \n \n \n \n \n \n
1WORK
\n
\n
\n
\n
\n
\n \n \n" operationId: createAdminUser requestBody: content: application/scim+json: schema: $ref: '#/components/schemas/UserSchema' required: true responses: '201': content: application/scim+json: schema: $ref: '#/components/schemas/UserSchema' description: Created. '400': content: application/scim+json: schema: $ref: '#/components/schemas/UserSchema' description: 'Bad Request : Invalid input or request' '401': content: application/scim+json: schema: $ref: '#/components/schemas/UserSchema' description: 'Unauthorized : Authentication token empty, invalid or expired.' '403': content: application/scim+json: schema: $ref: '#/components/schemas/UserSchema' description: 'Forbidden : User is not authorized to perform this operation.' '422': content: application/scim+json: schema: $ref: '#/components/schemas/UserSchema' description: 'Invalid input : Invalid or missing required input.' '500': content: application/scim+json: schema: $ref: '#/components/schemas/UserSchema' description: 'Internal Server Error : Unable to process request.' '503': content: application/scim+json: schema: $ref: '#/components/schemas/UserSchema' description: 'Service unavailable : Unable to process request at the moment.' security: - OAuth2: [] summary: Create a new admin user in the system with the requested information. tags: - scim-v1-admin-users /scim/v1/admin-users/search: post: description: "\n \n \n \n \n \n \n \n \n
\n
\n
\n
\n

\n 2. Search\n

\n \n

\n 2.1. API Details\n

\n
\n \n \n \n \n \n \n \n \n \n \n \n
\n Method\n \n POST\n
\n URL\n \n \n {{URL}}/\n \n openconnect-service/scim/v1/admin/search\n \n \n
\n
\n \n

\n 2.2. Request\n

\n \n

\n 2.2.1. Sample Requests\n

\n \n
\n 2.2.1.1. Search by userName
\n
\n
\n
\n
\n 
{\n            \"schemas\": [\n              \"urn:ietf:params:scim:api:messages:2.0:SearchRequest\"\n            ],\n            \"filter\": \"userName eq \\\\\"ECTCOKadminFirstNamea\\\\\"\"\n            }
\n
\n
\n \n
\n 2.2.1.2. Search by givenName
\n
\n
\n
\n
\n 
{\n            \"schemas\": [\n              \"urn:ietf:params:scim:api:messages:2.0:SearchRequest\"\n            ],\n            \"filter\": \"name[givenName eq \\\\\"egencia\\\\\"]\"\n            }
\n
\n
\n \n
\n 2.2.1.3. Search by familyName
\n
\n
\n
\n
\n 
{\n            \"schemas\": [\n              \"urn:ietf:params:scim:api:messages:2.0:SearchRequest\"\n            ],\n            \"filter\": \"name[familyName eq \\\\\"adminUser\\\\\"]\"\n            }
\n
\n
\n \n
\n 2.2.1.4. Search by email
\n
\n
\n
\n
\n 
{\n            \"schemas\": [\n              \"urn:ietf:params:scim:api:messages:2.0:SearchRequest\"\n            ],\n            \"filter\": \"email eq \\\\\"adminUser@egencia.com\\\\\"\"\n            }
\n
\n
\n \n
\n 2.2.1.5. Search by givenName and familyName
\n
\n
\n
\n
\n 
{\n            \"schemas\": [\n              \"urn:ietf:params:scim:api:messages:2.0:SearchRequest\"\n            ],\n            \"filter\": \"name[givenName eq \\\\\"egencia\\\\\"] and name[familyName eq \\\\\"adminUser\\\\\"]\"\n            }
\n
\n
\n \n

\n 2.2.2. Modals\n

\n \n
\n 2.2.2.1. SearchRequest\n
\n
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
\n Input name\n \n Type\n \n Required\n \n Notes\n
schemas\n array[String]\n \n Yes\n \n
\n
filter\n String\n \n Yes\n See Appendix 3 for possible filter values
\n
\n \n

\n 2.3. Response\n

\n \n

\n 2.3.1. Sample response\n

\n

The following response will be returned back by the application for all the valid requests.

\n
\n
\n 
{\n              \"schemas\": [\n                  \"urn:ietf:params:scim:schemas:extension:egencia:2.0:AdminSearchResponse\",\n                  \"urn:ietf:params:scim:api:messages:2.0:ListResponse\",\n                  \"urn:ietf:params:scim:api:messages:2.0:SearchResponse\"\n              ],\n              \"Resources\": [\n                  {\n                      \"name\": {\n                          \"familyName\": \"adminuser\",\n                          \"givenName\": \"egencia\"\n                      },\n                      \"username\": \"ECTDUBegenciaa34\",\n                      \"emails\": [\n                          {\n                              \"type\": \"WORK\",\n                              \"value\": \"adminuser@egencia.com\",\n                              \"primary\": true\n                          }\n                      ],\n                      \"urn:ietf:params:scim:schemas:extension:egencia:2.0:AdminSearchResponse\": {\n                          \"partner\": \"Egencia\",\n                          \"department\": \"ect - contact center\",\n                          \"geography\": \"Dubai\",\n                          \"pointOfSales\": [\n                              {\n                                  \"pointOfSaleId\": 60123,\n                                  \"userId\": 6999933,\n                                  \"role\": \"Fulfillment Manager\",\n                                  \"status\": \"ACTIVE\"\n                              },\n                              {\n                                  \"pointOfSaleId\": 60084,\n                                  \"userId\": 6999948,\n                                  \"role\": \"Super User\",\n                                  \"status\": \"ACTIVE\"\n                              },\n                              {\n                                  \"pointOfSaleId\": 60004,\n                                  \"userId\": 6999808,\n                                  \"role\": \"Fraud Manager\",\n                                  \"status\": \"ACTIVE\"\n                              },\n                              {\n                                  \"pointOfSaleId\": 60095,\n                                  \"userId\": 6999819,\n                                  \"role\": \"Travelshops Admin\",\n                                  \"status\": \"ACTIVE\"\n                              },\n                              {\n                                  \"pointOfSaleId\": 60006,\n                                  \"userId\": 6999261,\n                                  \"role\": \"Fraud Agent\",\n                                  \"status\": \"INACTIVE\"\n                              }\n                          ]\n                      }\n                  }\n              ]\n            }
\n
\n
\n \n

\n 3. Appendix\n

\n \n

\n 3.1. AdminRole\n

\n
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
1FULFILLMENT_STAFF
2FULFILLMENT_MANAGER
3GUEST
4FRAUD_AGENT
5FRAUD_MANAGER
6INTERNAL_USER
7TS_LEAD_AGENT
8TS_CALL_CENTER_MANAGER
9TS_AGENT
10REGIONAL_MANAGER
11SUPER_USER
12TRAVELSHOPS_ADMIN
13MERCHANT_ACCOUNT_HELP_ADMIN
14ECT_AGENT
15ECT_AGENT_LEAD
16ECT_CALL_CENTER_MANAGER
17ECT_IMPLEMENTATIONS_STAFF
18ECT_SALES_ACCOUNT_MANAGEMENT
19CRUISE_PROMO_MGR
20CHARTER_EXTRANET
21DATA_AND_CONTENT_READ_ONLY_USER
22UBER_ROLE_ADMIN
23FRAUD_ROLE_ADMIN
24FRAUD_INVESTIGATOR
25TRANSPORTATION_ROLE_ADMIN
26AGENCY_OPS_ROLE_ADMIN
27CUSTOMER_SERVICE_REP
28EXCEPTION_REFUNDS
29SME
30TS_ACCOUNTING_REP_CARS
31CCS_AGENT
32CCS_LEAD_AGENT
33SITE_RELEASE_NORTHAM
34SITE_RELEASE_ROLE_ADMIN
35CRUISE_CONTENT_ROLE_ADMIN
36TIER_III
37AGENCY_OPS_HIMS
38CLIENT_SERVICES
39CRUISE_GROUP_LEADER
40LOCAL_AIR_BUSINESS_MANAGER
41ECT_REPORTING_ADMINISTRATOR
42COUPON_CREATOR
43SUPER_TIER_III
44REDEMPTION_LEAD
45SENIOR_INTERNAL_USER
46GLOBAL_ADMIN
47READ_ONLY_ITINERARY_USER
48TRAVEL_PROMOTIONS
\n
\n \n

\n 3.2. AdminStatus\n

\n
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
1ACTIVE
2INACTIVE
\n
\n \n

\n 3.3. Filter\n

\n \n

\n 3.3.1. Mandatory Parameters\n

\n
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
1userNameAt least one of these parameters should be present in the filter query. They can be given individually or simultaneously by combining these parameters by using \"and\" operator. The optional parameters, which are given in the following table can also be combined together with these mandatory parameters.
2name[givenName]
3name[familyName]
4email
\n
\n \n

\n 3.3.2. Optional Parameters\n

\n
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
1statusThis parameter is used to filter out point of sales based on the status. This parameter can only be given along with the mandatory parameters. See AdminStatus for possible values.
2exactMatch\n

The possible values for exactMatch parameter are \"true\" and \"false\". The default value for this parameter is \"false\". This parameter can only be passed along with the mandatory parameters. If this parameter not passed in the query or set it as \"false\", then the search response contains resources with their values start with the required parameter. If it is \"true\", then the search response contains resources with exact value.

\n
\n
\n \n

\n 3.4. Email Type\n

\n
\n \n \n \n \n \n \n \n \n \n \n \n
1WORK
\n
\n
\n
\n
\n
\n \n \n" operationId: searchAdminUsers requestBody: content: application/scim+json: schema: $ref: '#/components/schemas/SearchRequestSchema' required: true responses: '200': content: application/scim+json: schema: $ref: '#/components/schemas/ListResponse' description: Search api success. '400': content: application/scim+json: schema: $ref: '#/components/schemas/ErrorSchema' description: 'Bad Request : Invalid input or request' '401': content: application/scim+json: schema: $ref: '#/components/schemas/ListResponse' description: 'Unauthorized : Authentication token empty, invalid or expired.' '403': content: application/scim+json: schema: $ref: '#/components/schemas/ListResponse' description: 'Forbidden : User is not authorized to perform this operation.' '422': content: application/scim+json: schema: $ref: '#/components/schemas/ErrorSchema' description: 'Invalid input : Invalid or missing required input.' '500': content: application/scim+json: schema: $ref: '#/components/schemas/ErrorSchema' description: 'Internal Server Error : Unable to process request.' '503': content: application/scim+json: schema: $ref: '#/components/schemas/ErrorSchema' description: 'Service unavailable : Unable to process request at the moment.' security: - OAuth2: [] summary: Return list of admin users based on the filter condition. tags: - scim-v1-admin-users /scim/v1/admin-users/{userName}: patch: description: "

\n 3. Modify [NOT available on lab]\n

\n

\n 3.1. API Details\n

\n
\n \n \n \n \n \n \n \n \n \n \n \n
\n Method\n \n PATCH\n
\n URL\n \n \n {{URL}}/\n \n openconnect-service/scim/v1/admin-users/{username}\n \n \n
\n
\n

\n 3.2. Requests and Responses\n

\n

\n 3.2.1. Add new point of sale\n

\n
\n 3.2.1.1. Request
\n
\n
\n
\n
\n 
{\n    \"schemas\": [\n        \"urn:ietf:params:scim:api:messages:2.0:PatchOp\"\n    ],\n    \"Operations\": [\n        {\n            \"op\": \"add\",\n            \"path\": \"urn:ietf:params:scim:schemas:extension:egencia:2.0:Admin:pointOfSales\",\n            \"value\": [\n                {\n                    \"pointOfSaleId\": 60123,\n                    \"role\": \"REGIONAL_MANAGER\"\n                }\n            ]\n        }\n    ]\n}
\n
\n
\n
\n 3.2.1.2. Response
\n
\n
\n
\n
\n 
{\n    \"schemas\": [\n        \"urn:ietf:params:scim:schemas:extension:egencia:2.0:AdminSearchResponse\",\n        \"urn:ietf:params:scim:api:messages:2.0:ListResponse\",\n        \"urn:ietf:params:scim:api:messages:2.0:SearchResponse\"\n    ],\n    \"Resources\": [\n        {\n            \"name\": {\n                \"familyName\": \"adminuser\",\n                \"givenName\": \"egencia\"\n            },\n            \"username\": \"ECTDUBegenciaa34\",\n            \"emails\": [\n                {\n                    \"type\": \"WORK\",\n                    \"value\": \"\n\n\t\t\t\t\t\t\t[email protected]\",\n                    \"primary\": true\n                }\n            ],\n            \"urn:ietf:params:scim:schemas:extension:egencia:2.0:AdminSearchResponse\": {\n                \"partner\": \"Egencia\",\n                \"department\": \"ect - contact center\",\n                \"geography\": \"Dubai\",\n                \"pointOfSales\": [\n                    {\n                        \"pointOfSaleId\": 60123,\n                        \"userId\": 6999933,\n                        \"role\": \"Regional Manager\",\n                        \"status\": \"ACTIVE\"\n                    },\n                    {\n                        \"pointOfSaleId\": 60084,\n                        \"userId\": 6999948,\n                        \"role\": \"Super User\",\n                        \"status\": \"ACTIVE\"\n                    },\n                    {\n                        \"pointOfSaleId\": 60008,\n                        \"userId\": 6999808,\n                        \"role\": \"Fraud Manager\",\n                        \"status\": \"ACTIVE\"\n                    }\n                ]\n            }\n        }\n    ]\n}\n\n\t\t\t\t\t\t
\n
\n
\n

\n 3.2.2. Remove point of sale by point of sale Id\n

\n
\n 3.2.2.1. Request
\n
\n
\n
\n
\n 
{\n    \"schemas\": [\n        \"urn:ietf:params:scim:api:messages:2.0:PatchOp\"\n    ],\n    \"Operations\": [\n        {\n            \"op\": \"remove\",\n            \"path\": \"urn:ietf:params:scim:schemas:extension:egencia:2.0:Admin:pointOfSales[pointOfSaleId eq \\\"60008\\\"]\"\n        }\n    ]\n}
\n
\n
\n
\n 3.2.2.2. Response
\n
\n
\n
\n
\n 
{\n    \"schemas\": [\n        \"urn:ietf:params:scim:schemas:extension:egencia:2.0:AdminSearchResponse\",\n        \"urn:ietf:params:scim:api:messages:2.0:ListResponse\",\n        \"urn:ietf:params:scim:api:messages:2.0:SearchResponse\"\n    ],\n    \"Resources\": [\n        {\n            \"name\": {\n                \"familyName\": \"adminuser\",\n                \"givenName\": \"egencia\"\n            },\n            \"username\": \"ECTDUBegenciaa34\",\n            \"emails\": [\n                {\n                    \"type\": \"WORK\",\n                    \"value\": \"\n\n\t\t\t\t\t\t\t\t\t\t\t[email protected]\",\n                    \"primary\": true\n                }\n            ],\n            \"urn:ietf:params:scim:schemas:extension:egencia:2.0:AdminSearchResponse\": {\n                \"partner\": \"Egencia\",\n                \"department\": \"ect - contact center\",\n                \"geography\": \"Dubai\",\n                \"pointOfSales\": [\n                    {\n                        \"pointOfSaleId\": 60123,\n                        \"userId\": 6999933,\n                        \"role\": \"Regional Manager\",\n                        \"status\": \"ACTIVE\"\n                    },\n                    {\n                        \"pointOfSaleId\": 60084,\n                        \"userId\": 6999948,\n                        \"role\": \"Super User\",\n                        \"status\": \"ACTIVE\"\n                    }\n                ]\n            }\n        }\n    ]\n}\n\n\t\t\t\t\t\t\t\t\t\t
\n
\n
\n

\n 3.2.3. Update role for a point of sale\n

\n
\n 3.2.3.1. Request
\n
\n
\n
\n
\n 
{\n    \"schemas\": [\n        \"urn:ietf:params:scim:api:messages:2.0:PatchOp\"\n    ],\n    \"Operations\": [\n        {\n            \"op\": \"replace\",\n            \"path\": \"urn:ietf:params:scim:schemas:extension:egencia:2.0:Admin:pointOfSales[pointOfSaleId eq \\\"60084\\\"].role\",\n            \"value\": \"FULFILLMENT_MANAGER\"\n        }\n    ]\n}
\n
\n
\n
\n 3.2.3.2. Response
\n
\n
\n
\n
\n 
{\n    \"schemas\": [\n        \"urn:ietf:params:scim:schemas:extension:egencia:2.0:AdminSearchResponse\",\n        \"urn:ietf:params:scim:api:messages:2.0:ListResponse\",\n        \"urn:ietf:params:scim:api:messages:2.0:SearchResponse\"\n    ],\n    \"Resources\": [\n        {\n            \"name\": {\n                \"familyName\": \"adminuser\",\n                \"givenName\": \"egencia\"\n            },\n            \"username\": \"ECTDUBegenciaa34\",\n            \"emails\": [\n                {\n                    \"type\": \"WORK\",\n                    \"value\": \"\n\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t[email protected]\",\n                    \"primary\": true\n                }\n            ],\n            \"urn:ietf:params:scim:schemas:extension:egencia:2.0:AdminSearchResponse\": {\n                \"partner\": \"Egencia\",\n                \"department\": \"ect - contact center\",\n                \"geography\": \"Dubai\",\n                \"pointOfSales\": [\n                    {\n                        \"pointOfSaleId\": 60123,\n                        \"userId\": 6999933,\n                        \"role\": \"Regional Manager\",\n                        \"status\": \"ACTIVE\"\n                    },\n                    {\n                        \"pointOfSaleId\": 60084,\n                        \"userId\": 6999948,\n                        \"role\": \"Fulfillment Manager\",\n                        \"status\": \"ACTIVE\"\n                    }\n                ]\n            }\n        }\n    ]\n}\n\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t
\n
\n
\n

\n 3.2.4. Change the status of a point of sale\n

\n
\n 3.2.4.1. Request
\n
\n
\n
\n
\n 
{\n    \"schemas\": [\n        \"urn:ietf:params:scim:api:messages:2.0:PatchOp\"\n    ],\n    \"Operations\": [\n        {\n            \"op\": \"replace\",\n            \"path\": \"urn:ietf:params:scim:schemas:extension:egencia:2.0:Admin:pointOfSales[pointOfSaleId eq \\\"60123\\\"].status\",\n            \"value\": \"INACTIVE\"\n        }\n    ]\n}
\n
\n
\n
\n 3.2.4.2. Response
\n
\n
\n
\n
\n 
{\n    \"schemas\": [\n        \"urn:ietf:params:scim:schemas:extension:egencia:2.0:AdminSearchResponse\",\n        \"urn:ietf:params:scim:api:messages:2.0:ListResponse\",\n        \"urn:ietf:params:scim:api:messages:2.0:SearchResponse\"\n    ],\n    \"Resources\": [\n        {\n            \"name\": {\n                \"familyName\": \"adminuser\",\n                \"givenName\": \"egencia\"\n            },\n            \"username\": \"ECTDUBegenciaa34\",\n            \"emails\": [\n                {\n                    \"type\": \"WORK\",\n                    \"value\": \"\n\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t[email protected]\",\n                    \"primary\": true\n                }\n            ],\n            \"urn:ietf:params:scim:schemas:extension:egencia:2.0:AdminSearchResponse\": {\n                \"partner\": \"Egencia\",\n                \"department\": \"ect - contact center\",\n                \"geography\": \"Dubai\",\n                \"pointOfSales\": [\n                    {\n                        \"pointOfSaleId\": 60123,\n                        \"userId\": 6999933,\n                        \"role\": \"Regional Manager\",\n                        \"status\": \"INACTIVE\"\n                    },\n                    {\n                        \"pointOfSaleId\": 60084,\n                        \"userId\": 6999948,\n                        \"role\": \"Fulfillment Manager\",\n                        \"status\": \"ACTIVE\"\n                    }\n                ]\n            }\n        }\n    ]\n}\n\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t
\n
\n
\n

\n 3.2.5. Change the status for all point of sales\n

\n
\n 3.2.5.1. Request
\n
\n
\n
\n
\n 
{\n    \"schemas\": [\n        \"urn:ietf:params:scim:api:messages:2.0:PatchOp\"\n    ],\n    \"Operations\": [\n        {\n            \"op\": \"replace\",\n            \"path\": \"urn:ietf:params:scim:schemas:extension:egencia:2.0:Admin:status\",\n            \"value\": \"INACTIVE\"\n        }\n    ]\n}
\n
\n
\n
\n 3.2.5.2. Response
\n
\n
\n
\n
\n 
{\n    \"schemas\": [\n        \"urn:ietf:params:scim:schemas:extension:egencia:2.0:AdminSearchResponse\",\n        \"urn:ietf:params:scim:api:messages:2.0:ListResponse\",\n        \"urn:ietf:params:scim:api:messages:2.0:SearchResponse\"\n    ],\n    \"Resources\": [\n        {\n            \"name\": {\n                \"familyName\": \"adminuser\",\n                \"givenName\": \"egencia\"\n            },\n            \"username\": \"ECTDUBegenciaa34\",\n            \"emails\": [\n                {\n                    \"type\": \"WORK\",\n                    \"value\": \"\n\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t[email protected]\",\n                    \"primary\": true\n                }\n            ],\n            \"urn:ietf:params:scim:schemas:extension:egencia:2.0:AdminSearchResponse\": {\n                \"partner\": \"Egencia\",\n                \"department\": \"ect - contact center\",\n                \"geography\": \"Dubai\",\n                \"pointOfSales\": [\n                    {\n                        \"pointOfSaleId\": 60123,\n                        \"userId\": 6999933,\n                        \"role\": \"Regional Manager\",\n                        \"status\": \"INACTIVE\"\n                    },\n                    {\n                        \"pointOfSaleId\": 60084,\n                        \"userId\": 6999948,\n                        \"role\": \"Fulfillment Manager\",\n                        \"status\": \"INACTIVE\"\n                    }\n                ]\n            }\n        }\n    ]\n}\n\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t
\n
\n
\n

\n 3.3. Modals\n

\n

\n 3.3.1. Request Modals\n

\n
\n 3.3.1.1. PatchSchema\n
\n
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
\n Name\n \n Type\n
schemas\n array[String]\n
Operations\n array[ PatchOperationSchema] \n
\n
\n
\n 3.3.1.2. PatchOperationSchema\n
\n
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
\n Name\n \n Type\n \n Required\n \n Notes\n
op\n array[String]\n \n Yes\n \n \n
\n \n
path\n
\n 		\n Yes\n \n \n
\n \n
value\n Object | AdminUserRole | PointOfSaleStatus\n \n \n No\n \n Type of the value attribute will always be depending upon the given operation. For example, in case of 'add' operation, value would be an object, for 'replace' operation, it would either be AdminUserRole or PointOfSaleStatus, and for 'remove' operation, it won't even be required. \n
\n
\n

\n 3.3.2. Response Modals\n

\n

Response modals are already given in 2.3.2. Modals\n

" operationId: patchAdmin parameters: - in: path name: userName required: true schema: type: string requestBody: content: application/scim+json: schema: $ref: '#/components/schemas/ScimPatchSchema' required: true responses: '204': content: application/scim+json: schema: $ref: '#/components/schemas/UserSchema' description: Updated. '400': content: application/scim+json: schema: $ref: '#/components/schemas/UserSchema' description: 'Bad Request : Invalid input or request' '401': content: application/scim+json: schema: $ref: '#/components/schemas/UserSchema' description: 'Unauthorized : Authentication token empty, invalid or expired.' '403': content: application/scim+json: schema: $ref: '#/components/schemas/UserSchema' description: 'Forbidden : User is not authorized to perform this operation.' '422': content: application/scim+json: schema: $ref: '#/components/schemas/UserSchema' description: 'Invalid input : Invalid or missing required input.' '500': content: application/scim+json: schema: $ref: '#/components/schemas/UserSchema' description: 'Internal Server Error : Unable to process request.' '503': content: application/scim+json: schema: $ref: '#/components/schemas/UserSchema' description: 'Service unavailable : Unable to process request at the moment.' security: - OAuth2: [] summary: Updates an existing user in the system with the requested information. tags: - scim-v1-admin-users components: schemas: UserSchema: type: object description: The user resource schema. properties: emails: type: array description: The email addresses associated with the user account. items: $ref: '#/components/schemas/EmailSchema' maxItems: 1 minItems: 1 meta: $ref: '#/components/schemas/MetaSchema' description: The attribute containing the resource metadata. name: $ref: '#/components/schemas/NameSchema' description: The name details of the user like first name, last name, etc. This is a mandatory property. schemas: type: array description: The schema urns for the associated resource. items: type: string uniqueItems: true urn:ietf:params:scim:schemas:extension:egencia:2.0:Admin: $ref: '#/components/schemas/AdminUserSchema' description: Extended custom attributes specific to Egencia travel management system. userName: type: string description: A service provider's unique identifier for the user, typically used by the user to directly authenticate to the service provider. The value must be an email value with valid @ domain. Maximum supported characters is 60. required: - emails - name - schemas - urn:ietf:params:scim:schemas:extension:egencia:2.0:Admin title: User schema PointOfSaleSchema: type: object description: The complex model containing point of sale association. properties: operation: type: string description: The operation for point of sale enum: - REMOVE - ADD - UPDATE - STATUS_CHANGE pointOfSaleId: type: integer format: int64 description: The point of sale id minimum: 1 role: type: string description: The role of the user against POS status: type: string description: The admin user status enum: - ACTIVE - INACTIVE - PENDING - DELETED userId: type: integer format: int64 description: The admin user id required: - pointOfSaleId - role title: Name DataSchema: type: object description: The data schema for representing error details of different attributes properties: attribute: type: string description: The name of the schema-defined attribute, if missing or invalid. message: type: string description: The error message related to the erroneous attribute. required: - attribute - message title: Data schema AdminUserSchema: type: object description: The extended custom attributes specific to Egencia travel management system. properties: department: type: string description: The department of the admin user. maxLength: 40 minLength: 0 geography: type: string description: The geography of the admin user. maxLength: 40 minLength: 0 partner: type: string description: The partner of the admin user. maxLength: 40 minLength: 0 pointOfSales: type: array description: The pointOfSales of the admin user. items: $ref: '#/components/schemas/PointOfSaleSchema' maxItems: 2147483647 minItems: 1 status: type: string description: To update status for all Point Of Sales required: - department - geography - partner - pointOfSales title: Admin user ScimPatchOperationSchema: type: object description: A complex object for scim patch oeration. properties: op: type: string path: type: string value: {} title: ScimPatchOperation SearchRequestSchema: type: object description: The user search schema. Currently it supports only emails with eq operator. properties: filter: type: string description: Contains the expression for filtering the request. Currently only search by email, name and username is supported with eq operator. This filter attribute can be used to collect Egencia ID by searching via email and Egencia website ID example: '"name[givenName eq \"egencia\"] and name[familyName eq \"adminUser\"]"' title: FilterRequest meta: $ref: '#/components/schemas/MetaSchema' description: The attribute containing the resource metadata. schemas: type: array description: The schema urns for the associated resource. items: type: string uniqueItems: true required: - filter - schemas title: User Search schema ScimPatchSchema: type: object description: The user patch request schema. properties: Operations: type: array description: List of scim patch operations. items: $ref: '#/components/schemas/ScimPatchOperationSchema' maxItems: 2147483647 minItems: 1 meta: $ref: '#/components/schemas/MetaSchema' description: The attribute containing the resource metadata. schemas: type: array description: The schema urns for the associated resource. items: type: string uniqueItems: true required: - Operations - schemas title: ScimPatchSchema NameSchema: type: object description: The complex model containing name attributes of the user. properties: familyName: type: string description: The family or last name of the user. This field is mandatory and cannot be empty. Maximum supported characters is 40. maxLength: 40 minLength: 0 formatted: type: string description: The formatted name of the user givenName: type: string description: The given or first name of the user. This field is mandatory and cannot be empty. Maximum supported characters is 40. maxLength: 40 minLength: 0 middleName: type: string description: The middle name of the user. Maximum supported characters is 40. maxLength: 40 minLength: 0 required: - familyName - givenName title: Name EmailSchema: type: object description: The complex model containing email details of the user. properties: primary: type: boolean description: Identifier flag to determine whether the address is primary or not. type: type: string description: Type of email. Ex. WORK. Please refer the Enumerations section for the values supported. enum: - WORK value: type: string description: The value of the email address. It needs to be in a standard format and cannot be empty. minLength: 1 required: - type - value title: Email ErrorSchema: type: object description: The error schema for representing error details. properties: data: type: array description: The list of data objects associated with the error. (e.g. invalid attributes). items: $ref: '#/components/schemas/DataSchema' detail: type: string description: The detailed description of the error. meta: $ref: '#/components/schemas/MetaSchema' description: The attribute containing the resource metadata. schemas: type: array description: The schema urns for the associated resource. items: type: string uniqueItems: true status: type: string description: The status code of the error. required: - detail - schemas - status title: Error schema SearchResponse: type: object description: The complex model containing filtered fields from user schema. properties: emails: type: array description: The email addresses associated with the user account. items: $ref: '#/components/schemas/EmailSchema' maxItems: 1 minItems: 1 name: $ref: '#/components/schemas/NameSchema' description: The name details of the user like first name, last name, etc. This is a mandatory property. urn:ietf:params:scim:schemas:extension:egencia:2.0:AdminUserSearchResponse: $ref: '#/components/schemas/AdminUserSchema' description: Extended custom attributes specific to Egencia travel management system. userName: type: string description: The username of the user required: - emails - name - urn:ietf:params:scim:schemas:extension:egencia:2.0:AdminUserSearchResponse MetaSchema: type: object description: A complex attribute containing resource metadata. properties: created: type: string format: date-time description: The creation time metadata. lastModified: type: string format: date-time description: The last modification time. location: type: string format: uri description: The location of the user resource accessible by URI. version: type: string description: The version of the resource. title: Meta ListResponse: type: object description: This is a list response schema containing the resources returned based on the filtering condition. properties: Resources: type: array items: $ref: '#/components/schemas/SearchResponse' itemsPerPage: type: integer format: int32 meta: $ref: '#/components/schemas/MetaSchema' description: The attribute containing the resource metadata. schemas: type: array description: The schema urns for the associated resource. items: type: string uniqueItems: true startIndex: type: integer format: int32 totalResults: type: integer format: int32 required: - schemas title: User Search Response schema securitySchemes: OAuth2: flows: clientCredentials: tokenUrl: https://apis.egencia.com/auth/v1/token type: oauth2