| \n Method\n | \n\n POST\n | \n
| \n URL\n | \n\n \n {{URL}}/\n \n openconnect-service/scim/v1/admin\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 Name\n | \n\n Type\n | \n\n Required\n | \n
|---|---|---|
| schemas | \n\n array[String]\n | \n\n Yes\n | \n
| name | \n\n \n Name\n \n | \n\n Yes\n | \n
| \n emails\n | \n\n array[ Email] \n | \n\n Yes\n | \n
| customAttributes | \n\n Admin\n | \n\n Yes\n | \n
| \n Name\n | \n\n Type\n | \n\n Required\n | \n
|---|---|---|
| familyName | \n\n String\n | \n\n Yes\n | \n
| givenName | \n\n String\n | \n\n Yes\n | \n
| \n middleName\n | \n\n String\n | \n\n No\n | \n
| \n Name\n | \n\n Type\n | \n\n Required\n | \n\n Notes\n | \n
|---|---|---|---|
| type | \n\n String\n | \n\n Yes\n | \n\n See Appendix 4 for possible values \n | \n
| value | \n\n String\n | \n\n Yes\n | \n\n \n \n \n | \n
| \n primary\n | \n\n Boolean\n | \n\n No\n | \n\n \n \n \n | \n
| \n Name\n | \n\n Type\n | \n\n Required\n | \n
|---|---|---|
| department | \n\n String\n | \n\n Yes\n | \n
| partner | \n\n String\n | \n\n Yes\n | \n
| \n geography\n | \n\n String\n | \n\n Yes\n | \n
| \n pointOfSales\n | \n\n \n PosAssociation\n \n | \n\n Yes\n | \n
| \n Name\n | \n\n Type\n | \n\n Required\n | \n\n Notes\n | \n
|---|---|---|---|
| pointOfSaleId | \n\n Integer\n | \n\n Yes\n | \n\n \n | \n
| role | \n\n AdminRole\n | \n\n Yes\n | \nSee Appendix 1 for possible values | \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 Name\n | \n\n Type\n | \n
|---|---|
| schemas | \n\n array[String]\n | \n
| resources | \n\n array[ Resource] \n | \n
| \n Name\n | \n\n Type\n | \n
|---|---|
| name | \n\n Name\n | \n
| userName | \n\n String\n | \n
| emails | \n\n array[ Email] \n | \n
| customAttributes | \n\n \n AdminResponse\n \n | \n
| \n Name\n | \n\n Type\n | \n
|---|---|
| partner | \n\n Name\n | \n
| department | \n\n String\n | \n
| geography | \n\n String\n | \n
| pointOfSales | \n\n \n PosAssociationResponse\n \n | \n
| \n Name\n | \n\n Type\n | \n\n Notes\n | \n
|---|---|---|
| pointOfSaleId | \n\n Integer\n | \n\n \n | \n
| userId | \n\n Integer\n | \n\n \n | \n
| role | \n\n String\n | \n\n \n | \n
| status | \n\n AdminStatus\n | \nSee Appendix 2 for possible values | \n
| 1 | \nFULFILLMENT_STAFF | \n
| 2 | \nFULFILLMENT_MANAGER | \n
| 3 | \nGUEST | \n
| 4 | \nFRAUD_AGENT | \n
| 5 | \nFRAUD_MANAGER | \n
| 6 | \nINTERNAL_USER | \n
| 7 | \nTS_LEAD_AGENT | \n
| 8 | \nTS_CALL_CENTER_MANAGER | \n
| 9 | \nTS_AGENT | \n
| 10 | \nREGIONAL_MANAGER | \n
| 11 | \nSUPER_USER | \n
| 12 | \nTRAVELSHOPS_ADMIN | \n
| 13 | \nMERCHANT_ACCOUNT_HELP_ADMIN | \n
| 14 | \nECT_AGENT | \n
| 15 | \nECT_AGENT_LEAD | \n
| 16 | \nECT_CALL_CENTER_MANAGER | \n
| 17 | \nECT_IMPLEMENTATIONS_STAFF | \n
| 18 | \nECT_SALES_ACCOUNT_MANAGEMENT | \n
| 19 | \nCRUISE_PROMO_MGR | \n
| 20 | \nCHARTER_EXTRANET | \n
| 21 | \nDATA_AND_CONTENT_READ_ONLY_USER | \n
| 22 | \nUBER_ROLE_ADMIN | \n
| 23 | \nFRAUD_ROLE_ADMIN | \n
| 24 | \nFRAUD_INVESTIGATOR | \n
| 25 | \nTRANSPORTATION_ROLE_ADMIN | \n
| 26 | \nAGENCY_OPS_ROLE_ADMIN | \n
| 27 | \nCUSTOMER_SERVICE_REP | \n
| 28 | \nEXCEPTION_REFUNDS | \n
| 29 | \nSME | \n
| 30 | \nTS_ACCOUNTING_REP_CARS | \n
| 31 | \nCCS_AGENT | \n
| 32 | \nCCS_LEAD_AGENT | \n
| 33 | \nSITE_RELEASE_NORTHAM | \n
| 34 | \nSITE_RELEASE_ROLE_ADMIN | \n
| 35 | \nCRUISE_CONTENT_ROLE_ADMIN | \n
| 36 | \nTIER_III | \n
| 37 | \nAGENCY_OPS_HIMS | \n
| 38 | \nCLIENT_SERVICES | \n
| 39 | \nCRUISE_GROUP_LEADER | \n
| 40 | \nLOCAL_AIR_BUSINESS_MANAGER | \n
| 41 | \nECT_REPORTING_ADMINISTRATOR | \n
| 42 | \nCOUPON_CREATOR | \n
| 43 | \nSUPER_TIER_III | \n
| 44 | \nREDEMPTION_LEAD | \n
| 45 | \nSENIOR_INTERNAL_USER | \n
| 46 | \nGLOBAL_ADMIN | \n
| 47 | \nREAD_ONLY_ITINERARY_USER | \n
| 48 | \nTRAVEL_PROMOTIONS | \n
| 1 | \nACTIVE | \n
| 2 | \nINACTIVE | \n
| 1 | \nuserName | \nAt 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. | \n
| 2 | \nname[givenName] | \n|
| 3 | \nname[familyName] | \n|
| 4 | \n
| 1 | \nstatus | \nThis 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. | \n
| 2 | \nexactMatch | \n\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
| 1 | \nWORK | \n
| \n Method\n | \n\n POST\n | \n
| \n URL\n | \n\n \n {{URL}}/\n \n openconnect-service/scim/v1/admin\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 Name\n | \n\n Type\n | \n\n Required\n | \n
|---|---|---|
| schemas | \n\n array[String]\n | \n\n Yes\n | \n
| name | \n\n \n Name\n \n | \n\n Yes\n | \n
| \n emails\n | \n\n array[ Email] \n | \n\n Yes\n | \n
| customAttributes | \n\n Admin\n | \n\n Yes\n | \n
| \n Name\n | \n\n Type\n | \n\n Required\n | \n
|---|---|---|
| familyName | \n\n String\n | \n\n Yes\n | \n
| givenName | \n\n String\n | \n\n Yes\n | \n
| \n middleName\n | \n\n String\n | \n\n No\n | \n
| \n Name\n | \n\n Type\n | \n\n Required\n | \n\n Notes\n | \n
|---|---|---|---|
| type | \n\n String\n | \n\n Yes\n | \n\n See Appendix 4 for possible values \n | \n
| value | \n\n String\n | \n\n Yes\n | \n\n \n \n \n | \n
| \n primary\n | \n\n Boolean\n | \n\n No\n | \n\n \n \n \n | \n
| \n Name\n | \n\n Type\n | \n\n Required\n | \n
|---|---|---|
| department | \n\n String\n | \n\n Yes\n | \n
| partner | \n\n String\n | \n\n Yes\n | \n
| \n geography\n | \n\n String\n | \n\n Yes\n | \n
| \n pointOfSales\n | \n\n \n PosAssociation\n \n | \n\n Yes\n | \n
| \n Name\n | \n\n Type\n | \n\n Required\n | \n\n Notes\n | \n
|---|---|---|---|
| pointOfSaleId | \n\n Integer\n | \n\n Yes\n | \n\n \n | \n
| role | \n\n AdminRole\n | \n\n Yes\n | \nSee Appendix 1 for possible values | \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 Name\n | \n\n Type\n | \n
|---|---|
| schemas | \n\n array[String]\n | \n
| resources | \n\n array[ Resource] \n | \n
| \n Name\n | \n\n Type\n | \n
|---|---|
| name | \n\n Name\n | \n
| userName | \n\n String\n | \n
| emails | \n\n array[ Email] \n | \n
| customAttributes | \n\n \n AdminResponse\n \n | \n
| \n Name\n | \n\n Type\n | \n
|---|---|
| partner | \n\n Name\n | \n
| department | \n\n String\n | \n
| geography | \n\n String\n | \n
| pointOfSales | \n\n \n PosAssociationResponse\n \n | \n
| \n Name\n | \n\n Type\n | \n\n Notes\n | \n
|---|---|---|
| pointOfSaleId | \n\n Integer\n | \n\n \n | \n
| userId | \n\n Integer\n | \n\n \n | \n
| role | \n\n String\n | \n\n \n | \n
| status | \n\n AdminStatus\n | \nSee Appendix 2 for possible values | \n
| 1 | \nFULFILLMENT_STAFF | \n
| 2 | \nFULFILLMENT_MANAGER | \n
| 3 | \nGUEST | \n
| 4 | \nFRAUD_AGENT | \n
| 5 | \nFRAUD_MANAGER | \n
| 6 | \nINTERNAL_USER | \n
| 7 | \nTS_LEAD_AGENT | \n
| 8 | \nTS_CALL_CENTER_MANAGER | \n
| 9 | \nTS_AGENT | \n
| 10 | \nREGIONAL_MANAGER | \n
| 11 | \nSUPER_USER | \n
| 12 | \nTRAVELSHOPS_ADMIN | \n
| 13 | \nMERCHANT_ACCOUNT_HELP_ADMIN | \n
| 14 | \nECT_AGENT | \n
| 15 | \nECT_AGENT_LEAD | \n
| 16 | \nECT_CALL_CENTER_MANAGER | \n
| 17 | \nECT_IMPLEMENTATIONS_STAFF | \n
| 18 | \nECT_SALES_ACCOUNT_MANAGEMENT | \n
| 19 | \nCRUISE_PROMO_MGR | \n
| 20 | \nCHARTER_EXTRANET | \n
| 21 | \nDATA_AND_CONTENT_READ_ONLY_USER | \n
| 22 | \nUBER_ROLE_ADMIN | \n
| 23 | \nFRAUD_ROLE_ADMIN | \n
| 24 | \nFRAUD_INVESTIGATOR | \n
| 25 | \nTRANSPORTATION_ROLE_ADMIN | \n
| 26 | \nAGENCY_OPS_ROLE_ADMIN | \n
| 27 | \nCUSTOMER_SERVICE_REP | \n
| 28 | \nEXCEPTION_REFUNDS | \n
| 29 | \nSME | \n
| 30 | \nTS_ACCOUNTING_REP_CARS | \n
| 31 | \nCCS_AGENT | \n
| 32 | \nCCS_LEAD_AGENT | \n
| 33 | \nSITE_RELEASE_NORTHAM | \n
| 34 | \nSITE_RELEASE_ROLE_ADMIN | \n
| 35 | \nCRUISE_CONTENT_ROLE_ADMIN | \n
| 36 | \nTIER_III | \n
| 37 | \nAGENCY_OPS_HIMS | \n
| 38 | \nCLIENT_SERVICES | \n
| 39 | \nCRUISE_GROUP_LEADER | \n
| 40 | \nLOCAL_AIR_BUSINESS_MANAGER | \n
| 41 | \nECT_REPORTING_ADMINISTRATOR | \n
| 42 | \nCOUPON_CREATOR | \n
| 43 | \nSUPER_TIER_III | \n
| 44 | \nREDEMPTION_LEAD | \n
| 45 | \nSENIOR_INTERNAL_USER | \n
| 46 | \nGLOBAL_ADMIN | \n
| 47 | \nREAD_ONLY_ITINERARY_USER | \n
| 48 | \nTRAVEL_PROMOTIONS | \n
| 1 | \nACTIVE | \n
| 2 | \nINACTIVE | \n
| 1 | \nuserName | \nAt 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. | \n
| 2 | \nname[givenName] | \n|
| 3 | \nname[familyName] | \n|
| 4 | \n
| 1 | \nstatus | \nThis 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. | \n
| 2 | \nexactMatch | \n\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
| 1 | \nWORK | \n
| \n Method\n | \n\n POST\n | \n
| \n URL\n | \n\n \n {{URL}}/\n \n openconnect-service/scim/v1/admin/search\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 \"schemas\": [\n \"urn:ietf:params:scim:api:messages:2.0:SearchRequest\"\n ],\n \"filter\": \"name[givenName eq \\\\\"egencia\\\\\"]\"\n }\n {\n \"schemas\": [\n \"urn:ietf:params:scim:api:messages:2.0:SearchRequest\"\n ],\n \"filter\": \"name[familyName eq \\\\\"adminUser\\\\\"]\"\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 \"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 Input name\n | \n\n Type\n | \n\n Required\n | \n\n Notes\n | \n
|---|---|---|---|
| schemas | \n\n array[String]\n | \n\n Yes\n | \n\n \n | \n
| filter | \n\n String\n | \n\n Yes\n | \nSee Appendix 3 for possible filter values | \n
The following response will be returned back by the application for all the valid requests.
\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 | 1 | \nFULFILLMENT_STAFF | \n
| 2 | \nFULFILLMENT_MANAGER | \n
| 3 | \nGUEST | \n
| 4 | \nFRAUD_AGENT | \n
| 5 | \nFRAUD_MANAGER | \n
| 6 | \nINTERNAL_USER | \n
| 7 | \nTS_LEAD_AGENT | \n
| 8 | \nTS_CALL_CENTER_MANAGER | \n
| 9 | \nTS_AGENT | \n
| 10 | \nREGIONAL_MANAGER | \n
| 11 | \nSUPER_USER | \n
| 12 | \nTRAVELSHOPS_ADMIN | \n
| 13 | \nMERCHANT_ACCOUNT_HELP_ADMIN | \n
| 14 | \nECT_AGENT | \n
| 15 | \nECT_AGENT_LEAD | \n
| 16 | \nECT_CALL_CENTER_MANAGER | \n
| 17 | \nECT_IMPLEMENTATIONS_STAFF | \n
| 18 | \nECT_SALES_ACCOUNT_MANAGEMENT | \n
| 19 | \nCRUISE_PROMO_MGR | \n
| 20 | \nCHARTER_EXTRANET | \n
| 21 | \nDATA_AND_CONTENT_READ_ONLY_USER | \n
| 22 | \nUBER_ROLE_ADMIN | \n
| 23 | \nFRAUD_ROLE_ADMIN | \n
| 24 | \nFRAUD_INVESTIGATOR | \n
| 25 | \nTRANSPORTATION_ROLE_ADMIN | \n
| 26 | \nAGENCY_OPS_ROLE_ADMIN | \n
| 27 | \nCUSTOMER_SERVICE_REP | \n
| 28 | \nEXCEPTION_REFUNDS | \n
| 29 | \nSME | \n
| 30 | \nTS_ACCOUNTING_REP_CARS | \n
| 31 | \nCCS_AGENT | \n
| 32 | \nCCS_LEAD_AGENT | \n
| 33 | \nSITE_RELEASE_NORTHAM | \n
| 34 | \nSITE_RELEASE_ROLE_ADMIN | \n
| 35 | \nCRUISE_CONTENT_ROLE_ADMIN | \n
| 36 | \nTIER_III | \n
| 37 | \nAGENCY_OPS_HIMS | \n
| 38 | \nCLIENT_SERVICES | \n
| 39 | \nCRUISE_GROUP_LEADER | \n
| 40 | \nLOCAL_AIR_BUSINESS_MANAGER | \n
| 41 | \nECT_REPORTING_ADMINISTRATOR | \n
| 42 | \nCOUPON_CREATOR | \n
| 43 | \nSUPER_TIER_III | \n
| 44 | \nREDEMPTION_LEAD | \n
| 45 | \nSENIOR_INTERNAL_USER | \n
| 46 | \nGLOBAL_ADMIN | \n
| 47 | \nREAD_ONLY_ITINERARY_USER | \n
| 48 | \nTRAVEL_PROMOTIONS | \n
| 1 | \nACTIVE | \n
| 2 | \nINACTIVE | \n
| 1 | \nuserName | \nAt 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. | \n
| 2 | \nname[givenName] | \n|
| 3 | \nname[familyName] | \n|
| 4 | \n
| 1 | \nstatus | \nThis 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. | \n
| 2 | \nexactMatch | \n\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
| 1 | \nWORK | \n
| \n Method\n | \n\n PATCH\n | \n
| \n URL\n | \n\n \n {{URL}}/\n \n openconnect-service/scim/v1/admin-users/{username}\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 \"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 \"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 \"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 \"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 \"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 \"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 \"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 \"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 \"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 Name\n | \n\n Type\n | \n
|---|---|
| schemas | \n\n array[String]\n | \n
| Operations | \n\n array[ PatchOperationSchema] \n | \n
| \n Name\n | \n\n Type\n | \n\n Required\n | \n\n Notes\n | \n
|---|---|---|---|
| op | \n\n array[String]\n | \n\n Yes\n | \n\n \n \n \n | \n
| path | \n\n \n | \n \n Yes\n | \n\n \n \n \n | \n
| value | \n\n Object | AdminUserRole | PointOfSaleStatus\n \n | \n\n No\n | \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
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"]}},"/scim/v1/users":{"post":{"operationId":"createUser_2","requestBody":{"content":{"application/scim+json":{"examples":{"Request with all the supported attributes":{"description":"Request with all the supported attributes","value":{"schemas":["urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"],"externalId":"externalSystemIdentifier","userName":"test@example.com","displayName":"Test User","title":"Mr","userType":"NORMAL","name":{"familyName":"User","formatted":"","givenName":"Test","middleName":""},"preferredLanguage":"en","active":true,"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"userAuthenticationMode":"SSO","singleSignOnId":"test@example.com","customDataFields":[{"name":"Primary cost center","value":"Test cost center"}],"dateOfBirth":"1988-01-01","documents":[{"expirationDate":"2030-10-10","issueCountry":"USA","issueDate":"2020-10-10","issueLocation":"city","type":"PAS","value":"ABCDE1234"}],"employeeNumber":"employeeNumberValue","loyaltyPrograms":[{"issuingSupplierCode":"T4","lob":"HOTEL","name":"S-Card","type":"LC","validFrom":"2020-10-10","validTo":"2025-10-10","value":"S12345"}],"organization":"egenciaCompanyId","preferences":[{"lob":"AIR","mealType":"178","preferredDepartureAirport":"","seatType":"Window","specialRequest":"Any special request"},{"lob":"RAIL","seatDirection":"Forward","seatRoom":"Lower","seatSolo":true,"seatType":"Window"},{"lob":"HOTEL","smoking":"Smoking","specialRequest":"Any special request"},{"lob":"CAR","specialRequest":"Any special request"}],"promoMail":true,"serviceLevelIds":["12345"],"approvers":{"level1Approvers":["45678"],"delegateApprovers":["testapprover"]},"arrangers":[{"id":"56789"}],"settings":{"notifications":{"reservationEmail":"validReservationEmailValue"}}},"emails":[{"primary":true,"type":"work","value":"test@example.com"}],"phoneNumbers":[{"primary":true,"type":"work","value":"+44-1234512345"}],"addresses":[{"country":"GB","formatted":"address line 1, cityname, state, GB, XXXXXX","locality":"city name","postalCode":"XXXXX","region":"region or state","streetAddress":"address line 1","type":"work"}],"groups":[{"display":"displayName","value":"travelerGroup"}],"roles":[{"display":"displayName","primary":true,"value":"userRole"}]}},"Request with basic attributes":{"description":"Request with basic attributes","value":{"schemas":["urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"],"userName":"api.sample@egencia.com","title":"1","userType":"NORMAL","name":{"familyName":"Test","givenName":"Sample","middleName":"Api"},"active":true,"emails":[{"primary":true,"type":"work","value":"api.sample@egencia.com"}],"groups":[{"value":"General"}],"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"organization":"12345","dateOfBirth":"1988-01-01","userAuthenticationMode":"SSO","singleSignOnId":"api.sample@egencia.com","customDataFields":[{"name":"Department code","value":"Legal entity value"},{"name":"Reporting field 2","value":"custom value"}]}}},"Request with email settings":{"description":"Request with email settings","value":{"schemas":["urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"],"userName":"api.sample@egencia.com","title":"1","userType":"NORMAL","name":{"familyName":"Test","givenName":"Sample","middleName":"Api"},"active":true,"emails":[{"primary":true,"type":"work","value":"api.sample@egencia.com"}],"groups":[{"value":"General"}],"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"organization":"12345","dateOfBirth":"1988-01-01","userAuthenticationMode":"SSO","singleSignOnId":"api.sample@egencia.com","customDataFields":[{"name":"Department code","value":"Legal entity value"},{"name":"Reporting field 2","value":"custom value"}],"settings":{"notifications":{"reservationEmail":"validReservationEmailValue"}}}}},"Request with phone number":{"description":"Request with phone number","value":{"schemas":["urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"],"userName":"api.sample@egencia.com","title":"1","userType":"NORMAL","name":{"familyName":"Test","givenName":"Sample","middleName":"Api"},"active":true,"emails":[{"primary":true,"type":"work","value":"api.sample@egencia.com"}],"phoneNumbers":[{"primary":true,"type":"MOBILE","value":"+441234512345"},{"type":"WORK","value":"+441234512346"}],"groups":[{"value":"General"}],"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"organization":"12345","dateOfBirth":"1988-01-01","userAuthenticationMode":"SSO","singleSignOnId":"api.sample@egencia.com","customDataFields":[{"name":"Department code","value":"Legal entity value"},{"name":"Reporting field 2","value":"custom value"}]}}},"Request with preferences":{"description":"Request with preferences","value":{"schemas":["urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"],"userName":"api.sample@egencia.com","title":"1","userType":"NORMAL","name":{"familyName":"Test","givenName":"Sample","middleName":"Api"},"active":true,"emails":[{"primary":true,"type":"work","value":"api.sample@egencia.com"}],"groups":[{"value":"General"}],"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"organization":"12345","dateOfBirth":"1988-01-01","userAuthenticationMode":"SSO","singleSignOnId":"api.sample@egencia.com","customDataFields":[{"name":"Department code","value":"Legal entity value"},{"name":"Reporting field 2","value":"custom value"}],"preferences":[{"lob":"AIR","mealType":"178","preferredDepartureAirport":"","seatType":"1","specialRequest":"Any special request"},{"lob":"RAIL","seatDirection":"Forward","seatRoom":"Lower","seatSolo":true,"seatType":"1"},{"lob":"HOTEL","smoking":"Smoking","specialRequest":"Any special request"},{"lob":"CAR","specialRequest":"Any special request"}]}}},"Request with preferences and documents":{"description":"Request with preferences and documents","value":{"schemas":["urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"],"userName":"api.sample@egencia.com","title":"1","userType":"NORMAL","name":{"familyName":"Test","givenName":"Sample","middleName":"Api"},"active":true,"emails":[{"primary":true,"type":"work","value":"api.sample@egencia.com"}],"groups":[{"value":"General"}],"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"organization":"12345","dateOfBirth":"1988-01-01","userAuthenticationMode":"SSO","singleSignOnId":"api.sample@egencia.com","customDataFields":[{"name":"Department code","value":"Legal entity value"},{"name":"Reporting field 2","value":"custom value"}],"preferences":[{"lob":"AIR","mealType":"178","preferredDepartureAirport":"","seatType":"Window","specialRequest":"Any special request"},{"lob":"RAIL","seatDirection":"Forward","seatRoom":"Lower","seatSolo":true,"seatType":"Window"},{"lob":"HOTEL","smoking":"Smoking","specialRequest":"Any special request"},{"lob":"CAR","specialRequest":"Any special request"}],"documents":[{"expirationDate":"2030-10-10","issueCountry":"USA","issueDate":"2020-10-10","issueLocation":"city","type":"PAS","value":"ABCDE1234"}]}}},"Request with preferences and loyalty program":{"description":"Request with preferences and loyalty program","value":{"schemas":["urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"],"userName":"api.sample@egencia.com","title":"1","userType":"NORMAL","name":{"familyName":"Test","givenName":"Sample","middleName":"Api"},"active":true,"emails":[{"primary":true,"type":"work","value":"api.sample@egencia.com"}],"groups":[{"value":"General"}],"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"organization":"12345","dateOfBirth":"1988-01-01","userAuthenticationMode":"SSO","singleSignOnId":"api.sample@egencia.com","customDataFields":[{"name":"Department code","value":"Legal entity value"},{"name":"Reporting field 2","value":"custom value"}],"preferences":[{"lob":"AIR","mealType":"178","preferredDepartureAirport":"","seatType":"1","specialRequest":"Any special request"},{"lob":"RAIL","seatDirection":"Forward","seatRoom":"Lower","seatSolo":true,"seatType":"Window"},{"lob":"HOTEL","smoking":"Smoking","specialRequest":"Any special request"},{"lob":"CAR","specialRequest":"Any special request"}],"loyaltyPrograms":[{"issuingSupplierCode":"T4","lob":"HOTEL","name":"S-Card","type":"LC","validFrom":"2020-10-10","validTo":"2025-10-10","value":"S12345"}]}}},"Request with roles and approvers":{"description":"Request with roles and approvers","value":{"schemas":["urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"],"userName":"api.sample@egencia.com","title":"1","userType":"NORMAL","name":{"familyName":"Test","givenName":"Sample","middleName":"Api"},"active":true,"emails":[{"primary":true,"type":"work","value":"api.sample@egencia.com"}],"groups":[{"value":"General"}],"roles":[{"display":"Self Booker","value":"SELF_BOOKER"},{"display":"Arranger","value":"ARRANGER"}],"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"organization":"12345","dateOfBirth":"1988-01-01","userAuthenticationMode":"SSO","singleSignOnId":"api.sample@egencia.com","customDataFields":[{"name":"Department code","value":"Legal entity value"},{"name":"Reporting field 2","value":"custom value"}],"approvers":{"level1Approvers":["approverone@egencia.com"],"level2Approvers":["approvertwo@egencia.com"]}}}}},"schema":{"$ref":"#/components/schemas/UserSchema"}}},"description":"User Schema to be created","required":true},"responses":{"200":{"content":{"application/scim+json":{"example":{"schemas":["urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"],"id":"egenciaUniqueIdentifier","externalId":"externalSystemIdentifier","userName":"test@example.com","displayName":"Test User","title":"Mr","userType":"NORMAL","name":{"familyName":"User","givenName":"Test","middleName":"","formatted":""},"preferredLanguage":"en","active":true,"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"organization":"egenciaCompanyId","employeeNumber":"employeeNumberValue","dateOfBirth":"1988-01-01","customDataFields":[{"name":"Primary cost center","value":"Test cost center"}],"documents":[{"expirationDate":"2030-10-10","issueCountry":"USA","issueDate":"2020-10-10","issueLocation":"city","type":"PAS","value":"ABCDE1234"}],"loyaltyPrograms":[{"issuingSupplierCode":"T4","lob":"HOTEL","name":"S-Card","type":"LC","validFrom":"2020-10-10","validTo":"2025-10-10","value":"S12345"}],"preferences":[{"lob":"AIR","mealType":"178","preferredDepartureAirport":"","seatType":"Window","specialRequest":"Any special request"},{"lob":"RAIL","seatDirection":"Forward","seatRoom":"Lower","seatSolo":true,"seatType":"Window"},{"lob":"HOTEL","smoking":"Smoking","specialRequest":"Any special request"},{"lob":"CAR","specialRequest":"Any special request"}],"settings":{"notifications":{"reservationEmail":"validReservationEmailValue"}},"serviceLevelIds":["12345"],"approvers":{"level1Approvers":["45678"],"delegateApprovers":["testapprover"]},"arrangers":[{"id":"56789"}],"promoMail":true},"emails":[{"type":"work","value":"test@example.com","primary":true}],"phoneNumbers":[{"type":"work","value":"+44-1234512345","primary":true}],"addresses":[{"type":"work","streetAddress":"address line 1","locality":"city name","region":"region or state","country":"GB","postalCode":"XXXXX","formatted":"address line 1, cityname, state, GB, XXXXXX"}],"groups":[{"value":"travelerGroup","display":"displayName"}],"roles":[{"value":"userRole","display":"displayName","primary":true}],"meta":{"created":"2017-10-10T00:00:00.000Z","last_modified":"2017-10-10T00:00:00.000Z","location":"/scim/v1/users/123"}}}},"description":"Created."},"400":{"content":{"application/scim+json":{"example":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"detail":"Invalid parameters","status":"400"}}},"description":"Bad Request : Invalid input or request"},"401":{"content":{"application/scim+json":{"example":{"error":{"code":"EGE-ER-4001","message":"Unauthorised access, you do not have sufficient permissions to perform this action."}}}},"description":"Unauthorized : Authentication token empty, invalid or expired."},"403":{"content":{"application/scim+json":{"example":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"detail":"Unauthorised access, you do not have sufficient permissions to perform this action. Contact your admin.","status":"403"}}},"description":"Forbidden : User not Validated for operation."},"422":{"content":{"application/scim+json":{"example":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"detail":"Invalid or missing parameters encountered, we are unable to process your request.","status":"422","data":[{"attribute":"userName","message":"userName needs to be specified and cannot be empty or null"}]}}},"description":"Invalid input : Invalid or missing required input."},"500":{"content":{"application/scim+json":{"example":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"detail":"Your request could not be completed due to some error. Please try again later.","status":"500","data":[{"attribute":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User.loyaltyPrograms","message":"Error occurred while processing loyalty program associations."}]}}},"description":"Internal Server Error : Unable to process request."},"503":{"content":{"application/scim+json":{"example":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"detail":"We are unable to process your request right now. Please try again later.","status":"503","data":[]}}},"description":"Service unavailable : Unable to process request at the moment."}},"security":[{"OAuth2":[]}],"summary":"Create a new user in the system with the requested information.","tags":["SCIM User Sync V1"]}},"/scim/v1/users/search":{"post":{"operationId":"getUserByCondition","requestBody":{"content":{"application/scim+json":{"examples":{"Search Users By Email":{"description":"Replace {email} with valid email value and {organizationId} with valid organization Id.","value":{"filter":"emails[value eq \"{email}\"] and urn:ietf:params:scim:schemas:extension:enterprise:2.0:User[organization eq {organizationId}]"}},"Search Users By Name":{"description":"Replace {givenName} with valid given name value, {familyName} with valid family name value and {organizationId} with valid organization Id.","value":{"filter":"name[givenName eq \"{givenName}\" and familyName eq \"{familyName}\"] and urn:ietf:params:scim:schemas:extension:enterprise:2.0:User[organization eq {organizationId}]"}},"Search Users By SSO":{"description":"Replace {singleSignOnId} with valid singleSignOnId value and {organizationId} with valid organization Id.","value":{"filter":"singleSignOnId eq \"{singleSignOnId}\" and urn:ietf:params:scim:schemas:extension:enterprise:2.0:User[organization eq {organizationId}]"}},"Search Users By Username":{"description":"Replace {userName} with valid userName value and {organizationId} with valid organization Id.","value":{"filter":"userName eq \"{userName}\" and urn:ietf:params:scim:schemas:extension:enterprise:2.0:User[organization eq {organizationId}]"}}},"schema":{"$ref":"#/components/schemas/SearchRequest"}}},"description":"User Schema to be updated","required":true},"responses":{"200":{"content":{"application/scim+json":{"example":{"schemas":["urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"],"externalId":"externalSystemIdentifier","userName":"test@example.com","displayName":"Test User","title":"Mr","userType":"NORMAL","name":{"familyName":"User","formatted":"","givenName":"Test","middleName":""},"preferredLanguage":"en","active":true,"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"userAuthenticationMode":"SSO","customDataFields":[{"name":"Primary cost center","value":"Test cost center"}],"dateOfBirth":"1988-01-01","documents":[{"expirationDate":"2030-10-10","issueCountry":"USA","issueDate":"2020-10-10","issueLocation":"city","type":"PAS","value":"ABCDE1234"}],"employeeNumber":"employeeNumberValue","loyaltyPrograms":[{"issuingSupplierCode":"T4","lob":"HOTEL","name":"S-Card","type":"LC","validFrom":"2020-10-10","validTo":"2025-10-10","value":"S12345"}],"organization":"egenciaCompanyId","preferences":[{"lob":"AIR","mealType":"178","preferredDepartureAirport":"","seatType":"1","specialRequest":"Any special request"},{"lob":"RAIL","seatDirection":"Forward","seatRoom":"Lower","seatSolo":true,"seatType":"1"},{"lob":"HOTEL","smoking":"Smoking","specialRequest":"Any special request"},{"lob":"CAR","specialRequest":"Any special request"}],"settings":{"notifications":{"reservationEmail":"validReservationEmailValue"}},"promoMail":true,"serviceLevelIds":["12345"],"approvers":{"level1Approvers":["45678"],"delegateApprovers":["testapprover"]},"arrangers":[{"id":"56789"}]},"emails":[{"primary":true,"type":"WORK","value":"test@example.com"}],"phoneNumbers":[{"primary":true,"type":"WORK","value":"+44-1234512345"}],"addresses":[{"country":"GB","formatted":"address line 1, cityname, state, GB, XXXXXX","locality":"city name","postalCode":"XXXXX","region":"region or state","streetAddress":"address line 1","type":"WORK"}],"groups":[{"display":"displayName","value":"travelerGroup"}],"roles":[{"display":"Self Booker","primary":true,"value":"Self Booker"}]}}},"description":"Search api success."},"400":{"content":{"application/scim+json":{"example":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"detail":"Invalid parameters","status":"400"}}},"description":"Bad Request : Invalid input or request"},"401":{"content":{"application/scim+json":{"example":{"error":{"code":"EGE-ER-4001","message":"Unauthorised access, you do not have sufficient permissions to perform this action."}}}},"description":"Unauthorized : Authentication token empty, invalid or expired."},"403":{"content":{"application/scim+json":{"example":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"detail":"Unauthorised access, you do not have sufficient permissions to perform this action. Contact your admin.","status":"403"}}},"description":"Forbidden : User not Validated for operation."},"422":{"content":{"application/scim+json":{"example":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"detail":"Invalid or missing parameters encountered, we are unable to process your request.","status":"422","data":[{"attribute":"userName","message":"userName needs to be specified and cannot be empty or null"}]}}},"description":"Invalid input : Invalid or missing required input."},"500":{"content":{"application/scim+json":{"example":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"detail":"Your request could not be completed due to some error. Please try again later.","status":"500","data":[{"attribute":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User.loyaltyPrograms","message":"Error occurred while processing loyalty program associations."}]}}},"description":"Internal Server Error : Unable to process request."},"503":{"content":{"application/scim+json":{"example":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"detail":"We are unable to process your request right now. Please try again later.","status":"503","data":[]}}},"description":"Service unavailable : Unable to process request at the moment."}},"security":[{"OAuth2":[]}],"summary":"Return list of users based on the filter condition.","tags":["SCIM User Sync V1"]}},"/scim/v1/users/{userId}":{"delete":{"description":"Delete the user with the given user Id in the path
\nExamples:
\nReplace {baseUrl} with the actual value of Egencia APIs host. Please refer Base Urls section under API Overview page of Egencia Developer Center.
\nDeleting a user with user Id : test_user_id
\n\n \n DELETE {baseUrl}/openconnect/api/scim/v1/users/test_user_id\n Response:\n -> 204 No Content\n \n","operationId":"deleteUserUser_2","parameters":[{"description":"User Id of the user who is to be deleted","in":"path","name":"userId","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content."},"401":{"content":{"*/*":{"example":{"error":{"code":"EGE-ER-4001","message":"Unauthorised access, you do not have sufficient permissions to perform this action."}}}},"description":"Unauthorized : Authentication token empty, invalid or expired."},"403":{"content":{"*/*":{"example":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"detail":"Unauthorised access, you do not have sufficient permissions to perform this action. Contact your admin.","status":"403"}}},"description":"Forbidden : User not Validated for operation."},"404":{"content":{"*/*":{"example":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"detail":"User not found, you are trying to access an invalid or non existent user.","status":"404","data":[{"attribute":"id","message":"Requested user identifier is invalid."}]}}},"description":"Not Found : Resource Not Found."},"422":{"content":{"*/*":{"example":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"detail":"Invalid or missing parameters encountered, we are unable to process your request.","status":"422","data":[{"attribute":"userName","message":"userName needs to be specified and cannot be empty or null"}]}}},"description":"Invalid input : Invalid or missing required input."},"500":{"content":{"*/*":{"example":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"detail":"Your request could not be completed due to some error. Please try again later.","status":"500","data":[{"attribute":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User.loyaltyPrograms","message":"Error occurred while processing loyalty program associations."}]}}},"description":"Internal Server Error : Unable to process request."},"503":{"content":{"*/*":{"example":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"detail":"We are unable to process your request right now. Please try again later.","status":"503","data":[]}}},"description":"Service unavailable : Unable to process request at the moment."}},"security":[{"OAuth2":[]}],"summary":"Delete the user in the system with the given user Id.","tags":["SCIM User Sync V1"]},"get":{"operationId":"getUser_2","parameters":[{"in":"path","name":"userId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/scim+json":{"example":{"schemas":["urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"],"externalId":"externalSystemIdentifier","userName":"test@example.com","displayName":"Test User","title":"Mr","userType":"NORMAL","name":{"familyName":"User","formatted":"","givenName":"Test","middleName":""},"preferredLanguage":"en","active":true,"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"userAuthenticationMode":"SSO","customDataFields":[{"name":"Primary cost center","value":"Test cost center"}],"dateOfBirth":"1988-01-01","documents":[{"expirationDate":"2030-10-10","issueCountry":"USA","issueDate":"2020-10-10","issueLocation":"city","type":"PAS","value":"ABCDE1234"}],"employeeNumber":"employeeNumberValue","loyaltyPrograms":[{"issuingSupplierCode":"T4","lob":"HOTEL","name":"S-Card","type":"LC","validFrom":"2020-10-10","validTo":"2025-10-10","value":"S12345"}],"organization":"egenciaCompanyId","preferences":[{"lob":"AIR","mealType":"178","preferredDepartureAirport":"","seatType":"1","specialRequest":"Any special request"},{"lob":"RAIL","seatDirection":"Forward","seatRoom":"Lower","seatSolo":true,"seatType":"1"},{"lob":"HOTEL","smoking":"Smoking","specialRequest":"Any special request"},{"lob":"CAR","specialRequest":"Any special request"}],"settings":{"notifications":{"reservationEmail":"validReservationEmailValue"}},"promoMail":true,"serviceLevelIds":["12345"],"approvers":{"level1Approvers":["45678"],"delegateApprovers":["testapprover"]},"arrangers":[{"id":"56789"}]},"emails":[{"primary":true,"type":"WORK","value":"test@example.com"}],"phoneNumbers":[{"primary":true,"type":"WORK","value":"+44-1234512345"}],"addresses":[{"country":"GB","formatted":"address line 1, cityname, state, GB, XXXXXX","locality":"city name","postalCode":"XXXXX","region":"region or state","streetAddress":"address line 1","type":"WORK"}],"groups":[{"display":"displayName","value":"travelerGroup"}],"roles":[{"display":"Self Booker","primary":true,"value":"Self Booker"}]}}},"description":"Found."},"400":{"content":{"application/scim+json":{"example":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"detail":"Invalid parameters","status":"400"}}},"description":"Bad Request : Invalid input or request"},"401":{"content":{"application/scim+json":{"example":{"error":{"code":"EGE-ER-4001","message":"Unauthorised access, you do not have sufficient permissions to perform this action."}}}},"description":"Unauthorized : Authentication token empty, invalid or expired."},"403":{"content":{"application/scim+json":{"example":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"detail":"Unauthorised access, you do not have sufficient permissions to perform this action. Contact your admin.","status":"403"}}},"description":"Forbidden : User not Validated for operation."},"404":{"content":{"application/scim+json":{"example":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"detail":"User not found, you are trying to access an invalid or non existent user.","status":"404","data":[{"attribute":"id","message":"Requested user identifier is invalid."}]}}},"description":"Not Found : Resource Not Found."},"422":{"content":{"application/scim+json":{"example":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"detail":"Invalid or missing parameters encountered, we are unable to process your request.","status":"422","data":[{"attribute":"userName","message":"userName needs to be specified and cannot be empty or null"}]}}},"description":"Invalid input : Invalid or missing required input."},"500":{"content":{"application/scim+json":{"example":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"detail":"Your request could not be completed due to some error. Please try again later.","status":"500","data":[{"attribute":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User.loyaltyPrograms","message":"Error occurred while processing loyalty program associations."}]}}},"description":"Internal Server Error : Unable to process request."},"503":{"content":{"application/scim+json":{"example":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"detail":"We are unable to process your request right now. Please try again later.","status":"503","data":[]}}},"description":"Service unavailable : Unable to process request at the moment."}},"security":[{"OAuth2":[]}],"summary":"Retrieves the user details for a requested user identifier.","tags":["SCIM User Sync V1"]},"patch":{"operationId":"patchUser_2","parameters":[{"in":"path","name":"userId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/scim+json":{"examples":{"Request to add a new arranger to the existing arrangers":{"description":"Request to add a new arranger to the existing arrangers","value":{"schemas":["urn:ietf:params:scim:api:messages:2.0:PatchOp"],"Operations":[{"op":"add","path":"urn:ietf:params:scim:schemas:extension:egencia:2.0:User:arrangers","value":[{"id":"id","userName":"api.sample@egencia.com"}]}]}},"Request to add a new custom data field to the existing custom data field list:":{"description":"Request to add a new custom data field to the existing custom data field list:","value":{"schemas":["urn:ietf:params:scim:api:messages:2.0:PatchOp"],"Operations":[{"op":"add","path":"urn:ietf:params:scim:schemas:extension:egencia:2.0:User:customDataFields","value":[{"name":"CDF label","value":"CDF value"}]}]}},"Request to add a new level 1 approver to the existing level1Approvers list":{"description":"Request to add a new level 1 approver to the existing level1Approvers list","value":{"schemas":["urn:ietf:params:scim:api:messages:2.0:PatchOp"],"Operations":[{"op":"add","path":"urn:ietf:params:scim:schemas:extension:egencia:2.0:User:approvers.level1Approvers","value":[{"userName":"api.sample@egencia.com"}]}]}},"Request to add a new level 1 as well as level 2 approver to the existing level1Approvers and level2Approvers list":{"description":"Request to add a new level 1 as well as level 2 approver to the existing level1Approvers and level2Approvers list","value":{"schemas":["urn:ietf:params:scim:api:messages:2.0:PatchOp"],"Operations":[{"op":"add","value":{"urn:ietf:params:scim:schemas:extension:egencia:2.0:User":{"approvers":{"level1Approvers":[{"id":"id"}],"level2Approvers":[{"userName":"api.sample@egencia.com"}]}}}}]}},"Request to add a new role to the existing roles":{"description":"Request to add a new role to the existing roles","value":{"schemas":["urn:ietf:params:scim:api:messages:2.0:PatchOp"],"Operations":[{"op":"add","path":"roles","value":["ARRANGER"]}]}},"Request to add/update first name, last name and date of birth":{"description":"Request to add/update first name, last name and date of birth","value":{"schemas":["urn:ietf:params:scim:api:messages:2.0:PatchOp"],"Operations":[{"op":"add","value":{"name":{"givenName":"First Name","familyName":"Last Name"},"urn:ietf:params:scim:schemas:extension:egencia:2.0:User":{"dateOfBirth":"1988-01-26"}}}]}},"Request to add/update status of user":{"description":"Request to add/update status of user","value":{"schemas":["urn:ietf:params:scim:api:messages:2.0:PatchOp"],"Operations":[{"op":"replace","value":{"active":false}}]}},"Request to replace traveler group with a new one.":{"description":"Request to replace traveler group with a new one.","value":{"schemas":["urn:ietf:params:scim:api:messages:2.0:PatchOp"],"Operations":[{"op":"replace","path":"groups","value":[{"value":"General"}]}]}},"Request to update WORK type email, username, ssoId, authentication mode":{"description":"Request to update WORK type email, username, ssoId, authentication mode","value":{"schemas":["urn:ietf:params:scim:api:messages:2.0:PatchOp"],"Operations":[{"op":"replace","path":"emails[type eq \"WORK\"].value","value":"api.sample@egencia.com"},{"op":"add","value":{"userName":"api.sample@egencia.com","urn:ietf:params:scim:schemas:extension:egencia:2.0:User":{"singleSignOnId":"api.sample@egencia.com","userAuthenticationMode":"SSO"}}}]}},"Request with multiple patch operations":{"description":"Request with multiple patch operations","value":{"schemas":["urn:ietf:params:scim:api:messages:2.0:PatchOp"],"Operations":[{"op":"add","path":"urn:ietf:params:scim:schemas:extension:egencia:2.0:User:customDataFields","value":[{"name":"ff test","value":"ff test value"},{"name":"Test CDF","value":"Test CDF"}]},{"op":"add","path":"urn:ietf:params:scim:schemas:extension:egencia:2.0:User:companyId","value":"23"},{"op":"add","value":{"userName":"abcd","name":{"givenName":"Abcd"},"urn:ietf:params:scim:schemas:extension:egencia:2.0:User":{"companyId":"23"}}},{"op":"replace","path":"addresses[type eq \"HOME\"].streetAddress","value":"1010 Broadway Ave"},{"op":"replace","path":"addresses[type eq \"HOME\"]","value":{"streetAddress":"911 Universal City Plaza","locality":"Hollywood","region":"CA","postalCode":"91608","country":"USA","formatted":"911 Universal City Plaza\nHollywood, CA 91608 US"}},{"op":"replace","value":{"emails":[{"value":"test@example.com","type":"WORK","primary":true}]}},{"op":"replace","value":{"phoneNumbers":[{"value":"+91-9999999999","type":"HOME","primary":true}]}},{"op":"add","path":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber","value":"11111"}]}}},"schema":{"$ref":"#/components/schemas/ScimPatchSchema"}}},"description":"SCIM compliant patch operation schema","required":true},"responses":{"200":{"content":{"application/scim+json":{"example":{"schemas":["urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"],"externalId":"externalSystemIdentifier","userName":"test@example.com","displayName":"Test User","title":"Mr","userType":"NORMAL","name":{"familyName":"User","formatted":"","givenName":"Test","middleName":""},"preferredLanguage":"en","active":true,"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"userAuthenticationMode":"SSO","customDataFields":[{"name":"Primary cost center","value":"Test cost center"}],"dateOfBirth":"1988-01-01","documents":[{"expirationDate":"2030-10-10","issueCountry":"USA","issueDate":"2020-10-10","issueLocation":"city","type":"PAS","value":"ABCDE1234"}],"employeeNumber":"employeeNumberValue","loyaltyPrograms":[{"issuingSupplierCode":"T4","lob":"HOTEL","name":"S-Card","type":"LC","validFrom":"2020-10-10","validTo":"2025-10-10","value":"S12345"}],"organization":"egenciaCompanyId","preferences":[{"lob":"AIR","mealType":"178","preferredDepartureAirport":"","seatType":"1","specialRequest":"Any special request"},{"lob":"RAIL","seatDirection":"Forward","seatRoom":"Lower","seatSolo":true,"seatType":"1"},{"lob":"HOTEL","smoking":"Smoking","specialRequest":"Any special request"},{"lob":"CAR","specialRequest":"Any special request"}],"settings":{"notifications":{"reservationEmail":"validReservationEmailValue"}},"promoMail":true,"serviceLevelIds":["12345"],"approvers":{"level1Approvers":["45678"],"delegateApprovers":["testapprover"]},"arrangers":[{"id":"56789"}]},"emails":[{"primary":true,"type":"WORK","value":"test@example.com"}],"phoneNumbers":[{"primary":true,"type":"WORK","value":"+44-1234512345"}],"addresses":[{"country":"GB","formatted":"address line 1, cityname, state, GB, XXXXXX","locality":"city name","postalCode":"XXXXX","region":"region or state","streetAddress":"address line 1","type":"WORK"}],"groups":[{"display":"displayName","value":"travelerGroup"}],"roles":[{"display":"Self Booker","primary":true,"value":"Self Booker"}]}}},"description":"Patch api success"},"401":{"content":{"application/scim+json":{"example":{"error":{"code":"EGE-ER-4001","message":"Unauthorised access, you do not have sufficient permissions to perform this action."}}}},"description":"Unauthorized : Authentication token empty, invalid or expired."},"403":{"content":{"application/scim+json":{"example":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"detail":"Unauthorised access, you do not have sufficient permissions to perform this action. Contact your admin.","status":"403"}}},"description":"Forbidden : User not Validated for operation."},"404":{"content":{"application/scim+json":{"example":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"detail":"User not found, you are trying to access an invalid or non existent user.","status":"404","data":[{"attribute":"id","message":"Requested user identifier is invalid."}]}}},"description":"Not Found : Resource Not Found."},"422":{"content":{"application/scim+json":{"example":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"detail":"Invalid or missing parameters encountered, we are unable to process your request.","status":"422","data":[{"attribute":"userName","message":"userName needs to be specified and cannot be empty or null"}]}}},"description":"Invalid input : Invalid or missing required input."},"500":{"content":{"application/scim+json":{"example":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"detail":"Your request could not be completed due to some error. Please try again later.","status":"500","data":[{"attribute":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User.loyaltyPrograms","message":"Error occurred while processing loyalty program associations."}]}}},"description":"Internal Server Error : Unable to process request."},"503":{"content":{"application/scim+json":{"example":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"detail":"We are unable to process your request right now. Please try again later.","status":"503","data":[]}}},"description":"Service unavailable : Unable to process request at the moment."}},"security":[{"OAuth2":[]}],"summary":"Perform patch operation on the user with the given user Id.","tags":["SCIM User Sync V1"]},"put":{"operationId":"updateUser_2","parameters":[{"in":"path","name":"userId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/scim+json":{"examples":{"Request with all the supported attributes":{"description":"Request with all the supported attributes","value":{"schemas":["urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"],"externalId":"externalSystemIdentifier","userName":"test@example.com","displayName":"Test User","title":"Mr","userType":"NORMAL","name":{"familyName":"User","formatted":"","givenName":"Test","middleName":""},"preferredLanguage":"en","active":true,"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"userAuthenticationMode":"SSO","singleSignOnId":"test@example.com","customDataFields":[{"name":"Primary cost center","value":"Test cost center"}],"dateOfBirth":"1988-01-01","documents":[{"expirationDate":"2030-10-10","issueCountry":"USA","issueDate":"2020-10-10","issueLocation":"city","type":"PAS","value":"ABCDE1234"}],"employeeNumber":"employeeNumberValue","loyaltyPrograms":[{"issuingSupplierCode":"T4","lob":"HOTEL","name":"S-Card","type":"LC","validFrom":"2020-10-10","validTo":"2025-10-10","value":"S12345"}],"organization":"egenciaCompanyId","preferences":[{"lob":"AIR","mealType":"178","preferredDepartureAirport":"","seatType":"Window","specialRequest":"Any special request"},{"lob":"RAIL","seatDirection":"Forward","seatRoom":"Lower","seatSolo":true,"seatType":"Window"},{"lob":"HOTEL","smoking":"Smoking","specialRequest":"Any special request"},{"lob":"CAR","specialRequest":"Any special request"}],"promoMail":true,"serviceLevelIds":["12345"],"approvers":{"level1Approvers":["45678"],"delegateApprovers":["testapprover"]},"arrangers":[{"id":"56789"}],"settings":{"notifications":{"reservationEmail":"validReservationEmailValue"}}},"emails":[{"primary":true,"type":"work","value":"test@example.com"}],"phoneNumbers":[{"primary":true,"type":"work","value":"+44-1234512345"}],"addresses":[{"country":"GB","formatted":"address line 1, cityname, state, GB, XXXXXX","locality":"city name","postalCode":"XXXXX","region":"region or state","streetAddress":"address line 1","type":"work"}],"groups":[{"display":"displayName","value":"travelerGroup"}],"roles":[{"display":"displayName","primary":true,"value":"userRole"}]}},"Request with basic attributes":{"description":"Request with basic attributes","value":{"schemas":["urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"],"userName":"api.sample@egencia.com","title":"1","userType":"NORMAL","name":{"familyName":"Test","givenName":"Sample","middleName":"Api"},"active":true,"emails":[{"primary":true,"type":"work","value":"api.sample@egencia.com"}],"groups":[{"value":"General"}],"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"organization":"12345","dateOfBirth":"1988-01-01","userAuthenticationMode":"SSO","singleSignOnId":"api.sample@egencia.com","customDataFields":[{"name":"Department code","value":"Legal entity value"},{"name":"Reporting field 2","value":"custom value"}]}}},"Request with email settings":{"description":"Request with email settings","value":{"schemas":["urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"],"userName":"api.sample@egencia.com","title":"1","userType":"NORMAL","name":{"familyName":"Test","givenName":"Sample","middleName":"Api"},"active":true,"emails":[{"primary":true,"type":"work","value":"api.sample@egencia.com"}],"groups":[{"value":"General"}],"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"organization":"12345","dateOfBirth":"1988-01-01","userAuthenticationMode":"SSO","singleSignOnId":"api.sample@egencia.com","customDataFields":[{"name":"Department code","value":"Legal entity value"},{"name":"Reporting field 2","value":"custom value"}],"settings":{"notifications":{"reservationEmail":"validReservationEmailValue"}}}}},"Request with phone number":{"description":"Request with phone number","value":{"schemas":["urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"],"userName":"api.sample@egencia.com","title":"1","userType":"NORMAL","name":{"familyName":"Test","givenName":"Sample","middleName":"Api"},"active":true,"emails":[{"primary":true,"type":"work","value":"api.sample@egencia.com"}],"phoneNumbers":[{"primary":true,"type":"MOBILE","value":"+441234512345"},{"type":"WORK","value":"+441234512346"}],"groups":[{"value":"General"}],"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"organization":"12345","dateOfBirth":"1988-01-01","userAuthenticationMode":"SSO","singleSignOnId":"api.sample@egencia.com","customDataFields":[{"name":"Department code","value":"Legal entity value"},{"name":"Reporting field 2","value":"custom value"}]}}},"Request with preferences":{"description":"Request with preferences","value":{"schemas":["urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"],"userName":"api.sample@egencia.com","title":"1","userType":"NORMAL","name":{"familyName":"Test","givenName":"Sample","middleName":"Api"},"active":true,"emails":[{"primary":true,"type":"work","value":"api.sample@egencia.com"}],"groups":[{"value":"General"}],"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"organization":"12345","dateOfBirth":"1988-01-01","userAuthenticationMode":"SSO","singleSignOnId":"api.sample@egencia.com","customDataFields":[{"name":"Department code","value":"Legal entity value"},{"name":"Reporting field 2","value":"custom value"}],"preferences":[{"lob":"AIR","mealType":"178","preferredDepartureAirport":"","seatType":"1","specialRequest":"Any special request"},{"lob":"RAIL","seatDirection":"Forward","seatRoom":"Lower","seatSolo":true,"seatType":"1"},{"lob":"HOTEL","smoking":"Smoking","specialRequest":"Any special request"},{"lob":"CAR","specialRequest":"Any special request"}]}}},"Request with preferences and documents":{"description":"Request with preferences and documents","value":{"schemas":["urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"],"userName":"api.sample@egencia.com","title":"1","userType":"NORMAL","name":{"familyName":"Test","givenName":"Sample","middleName":"Api"},"active":true,"emails":[{"primary":true,"type":"work","value":"api.sample@egencia.com"}],"groups":[{"value":"General"}],"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"organization":"12345","dateOfBirth":"1988-01-01","userAuthenticationMode":"SSO","singleSignOnId":"api.sample@egencia.com","customDataFields":[{"name":"Department code","value":"Legal entity value"},{"name":"Reporting field 2","value":"custom value"}],"preferences":[{"lob":"AIR","mealType":"178","preferredDepartureAirport":"","seatType":"Window","specialRequest":"Any special request"},{"lob":"RAIL","seatDirection":"Forward","seatRoom":"Lower","seatSolo":true,"seatType":"Window"},{"lob":"HOTEL","smoking":"Smoking","specialRequest":"Any special request"},{"lob":"CAR","specialRequest":"Any special request"}],"documents":[{"expirationDate":"2030-10-10","issueCountry":"USA","issueDate":"2020-10-10","issueLocation":"city","type":"PAS","value":"ABCDE1234"}]}}},"Request with preferences and loyalty program":{"description":"Request with preferences and loyalty program","value":{"schemas":["urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"],"userName":"api.sample@egencia.com","title":"1","userType":"NORMAL","name":{"familyName":"Test","givenName":"Sample","middleName":"Api"},"active":true,"emails":[{"primary":true,"type":"work","value":"api.sample@egencia.com"}],"groups":[{"value":"General"}],"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"organization":"12345","dateOfBirth":"1988-01-01","userAuthenticationMode":"SSO","singleSignOnId":"api.sample@egencia.com","customDataFields":[{"name":"Department code","value":"Legal entity value"},{"name":"Reporting field 2","value":"custom value"}],"preferences":[{"lob":"AIR","mealType":"178","preferredDepartureAirport":"","seatType":"1","specialRequest":"Any special request"},{"lob":"RAIL","seatDirection":"Forward","seatRoom":"Lower","seatSolo":true,"seatType":"Window"},{"lob":"HOTEL","smoking":"Smoking","specialRequest":"Any special request"},{"lob":"CAR","specialRequest":"Any special request"}],"loyaltyPrograms":[{"issuingSupplierCode":"T4","lob":"HOTEL","name":"S-Card","type":"LC","validFrom":"2020-10-10","validTo":"2025-10-10","value":"S12345"}]}}},"Request with roles and approvers":{"description":"Request with roles and approvers","value":{"schemas":["urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"],"userName":"api.sample@egencia.com","title":"1","userType":"NORMAL","name":{"familyName":"Test","givenName":"Sample","middleName":"Api"},"active":true,"emails":[{"primary":true,"type":"work","value":"api.sample@egencia.com"}],"groups":[{"value":"General"}],"roles":[{"display":"Self Booker","value":"SELF_BOOKER"},{"display":"Arranger","value":"ARRANGER"}],"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"organization":"12345","dateOfBirth":"1988-01-01","userAuthenticationMode":"SSO","singleSignOnId":"api.sample@egencia.com","customDataFields":[{"name":"Department code","value":"Legal entity value"},{"name":"Reporting field 2","value":"custom value"}],"approvers":{"level1Approvers":["approverone@egencia.com"],"level2Approvers":["approvertwo@egencia.com"]}}}}},"schema":{"$ref":"#/components/schemas/UserSchema"}}},"description":"User Schema to be updated","required":true},"responses":{"200":{"content":{"application/scim+json":{"example":{"schemas":["urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"],"externalId":"externalSystemIdentifier","userName":"test@example.com","displayName":"Test User","title":"Mr","userType":"NORMAL","name":{"familyName":"User","formatted":"","givenName":"Test","middleName":""},"preferredLanguage":"en","active":true,"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"userAuthenticationMode":"SSO","customDataFields":[{"name":"Primary cost center","value":"Test cost center"}],"dateOfBirth":"1988-01-01","documents":[{"expirationDate":"2030-10-10","issueCountry":"USA","issueDate":"2020-10-10","issueLocation":"city","type":"PAS","value":"ABCDE1234"}],"employeeNumber":"employeeNumberValue","loyaltyPrograms":[{"issuingSupplierCode":"T4","lob":"HOTEL","name":"S-Card","type":"LC","validFrom":"2020-10-10","validTo":"2025-10-10","value":"S12345"}],"organization":"egenciaCompanyId","preferences":[{"lob":"AIR","mealType":"178","preferredDepartureAirport":"","seatType":"1","specialRequest":"Any special request"},{"lob":"RAIL","seatDirection":"Forward","seatRoom":"Lower","seatSolo":true,"seatType":"1"},{"lob":"HOTEL","smoking":"Smoking","specialRequest":"Any special request"},{"lob":"CAR","specialRequest":"Any special request"}],"settings":{"notifications":{"reservationEmail":"validReservationEmailValue"}},"promoMail":true,"serviceLevelIds":["12345"],"approvers":{"level1Approvers":["45678"],"delegateApprovers":["testapprover"]},"arrangers":[{"id":"56789"}]},"emails":[{"primary":true,"type":"WORK","value":"test@example.com"}],"phoneNumbers":[{"primary":true,"type":"WORK","value":"+44-1234512345"}],"addresses":[{"country":"GB","formatted":"address line 1, cityname, state, GB, XXXXXX","locality":"city name","postalCode":"XXXXX","region":"region or state","streetAddress":"address line 1","type":"WORK"}],"groups":[{"display":"displayName","value":"travelerGroup"}],"roles":[{"display":"Self Booker","primary":true,"value":"Self Booker"}]}}},"description":"Updated."},"400":{"content":{"application/scim+json":{"example":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"detail":"Invalid parameters","status":"400"}}},"description":"Bad Request : Invalid input or request"},"401":{"content":{"application/scim+json":{"example":{"error":{"code":"EGE-ER-4001","message":"Unauthorised access, you do not have sufficient permissions to perform this action."}}}},"description":"Unauthorized : Authentication token empty, invalid or expired."},"403":{"content":{"application/scim+json":{"example":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"detail":"Unauthorised access, you do not have sufficient permissions to perform this action. Contact your admin.","status":"403"}}},"description":"Forbidden : User not Validated for operation."},"422":{"content":{"application/scim+json":{"example":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"detail":"Invalid or missing parameters encountered, we are unable to process your request.","status":"422","data":[{"attribute":"userName","message":"userName needs to be specified and cannot be empty or null"}]}}},"description":"Invalid input : Invalid or missing required input."},"500":{"content":{"application/scim+json":{"example":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"detail":"Your request could not be completed due to some error. Please try again later.","status":"500","data":[{"attribute":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User.loyaltyPrograms","message":"Error occurred while processing loyalty program associations."}]}}},"description":"Internal Server Error : Unable to process request."},"503":{"content":{"application/scim+json":{"example":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"detail":"We are unable to process your request right now. Please try again later.","status":"503","data":[]}}},"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 User Sync V1"]}},"/scim/v2/Users":{"get":{"description":"Search/retrieve users based on the filter string parameter. Please be cautious if you are using organization token, search API will only return users of parent company if company is not provided in the filter criteria.
\nResults are returned in ascending order of userIds.
\nNote: We only support search by email, name, userName and singleSignOnId. Since filter attribute contains special characters like square brackets, clients need to encode the filter attribute value.
\n\n \n For search by email with value as test@egencia.com, you need to pass encoded value in filter which will be :\n filter = emails%5Bvalue%20eq%20%22test%40egencia.com%22%5D\n which is the encoded value for filter = emails[value eq \"test@egencia.com\"]\n \n\n","operationId":"getUsers_1","parameters":[{"description":"SCIM compliant filter attribute to take query string. If you are using any external tool to make the API call, please make sure to encode the filter value.","examples":{"Search Users By Company":{"description":"Replace {companyId} by the egencia company Id you want to search.","value":"urn:ietf:params:scim:schemas:extension:egencia:2.0:User[companyId eq \"{companyId}\"]"},"Search Users By Email":{"description":"Replace {email} by the email you want to search.","value":"emails[value eq \"{email}\"]"},"Search Users By Email and Company":{"description":"Replace {email} by the email and {companyId} by the egencia company Id you want to search.","value":"emails[value eq \"{email}\"] and urn:ietf:params:scim:schemas:extension:egencia:2.0:User[companyId eq \"{companyId}\"]"},"Search Users By Name":{"description":"Replace {givenName} by the first name of the user and {familyName} by the last name of the user you want to search.","value":"name[givenName eq \"{givenName}\" and familyName eq \"{familyName}\"]"},"Search Users By Name and Company":{"description":"Replace {givenName} by the first name of the user, {familyName} by the last name of the user and {companyId} by the egencia company Id you want to search.","value":"name[givenName eq \"{givenName}\" and familyName eq \"{familyName}\"] and urn:ietf:params:scim:schemas:extension:egencia:2.0:User[companyId eq \"{companyId}\"]"},"Search Users By No Filter":{"description":"No need to pass anything in filter."},"Search Users By Single Sign On Id":{"description":"Replace {singleSignOnId} by the single sing on Id you want to search.","value":"urn:ietf:params:scim:schemas:extension:egencia:2.0:User:singleSignOnId eq \"{singleSignOnId}\""},"Search Users By Single Sign On Id and Company":{"description":"Replace {singleSignOnId} by the single sign on Id and {companyId} by the egencia company Id you want to search.","value":"urn:ietf:params:scim:schemas:extension:egencia:2.0:User:singleSignOnId eq \"{singleSignOnId}\" and urn:ietf:params:scim:schemas:extension:egencia:2.0:User:companyId eq \"{companyId}\""},"Search Users By Username":{"description":"Replace {userName} by the username you want to search.","value":"userName eq \"{userName}\""},"Search Users By Username and Company":{"description":"Replace {userName} by the username and {companyId} by the egencia company Id you want to search.","value":"userName eq \"{userName}\" and urn:ietf:params:scim:schemas:extension:egencia:2.0:User[companyId eq \"{companyId}\"]"}},"in":"query","name":"filter","required":false,"schema":{"type":"string"}},{"description":"1-based start index","in":"query","name":"startIndex","required":false,"schema":{"type":"integer","format":"int32","default":1,"exclusiveMinimum":0}},{"description":"Number of resources to be returned. Maximum supported value is 100","in":"query","name":"count","required":false,"schema":{"type":"integer","format":"int32","default":20,"exclusiveMinimum":0,"maximum":100}}],"responses":{"200":{"content":{"application/scim+json":{"example":{"schemas":["urn:ietf:params:scim:api:messages:2.0:ListResponse"],"itemsPerPage":1,"startIndex":1,"totalResults":1,"Resources":[{"schemas":["urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:extension:egencia:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"],"meta":{"created":"2024-07-17T00:00:00.000Z","lastModified":"2024-07-17T00:00:00.000Z","location":"{baseUrl}/openconnect/api/scim/v2/Users/12345"},"id":"egenciaUniqueIdentifier","externalId":"externalSystemIdentifier","userName":"test@example.com","name":{"familyName":"User","formatted":"","givenName":"Test","middleName":"","honorificPrefix":"Mr."},"userType":"NORMAL","preferredLanguage":"en","active":true,"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"employeeNumber":"testEmployeeNumberValue"},"urn:ietf:params:scim:schemas:extension:egencia:2.0:User":{"approvers":{"level1Approvers":[{"id":"4567"}],"level2Approvers":[{"id":"4567"}],"delegateApprovers":[{"id":"123"}]},"arrangerGroups":["arrangerGroup1"],"arrangers":[{"id":"5678"},{"userName":"testarranger1"}],"companyId":"egenciaCompanyId","customDataFields":[{"name":"Primary cost center","value":"Test cost center"}],"dateOfBirth":"1989-01-01","documents":[{"expirationDate":"2031-10-10","issueCountry":"US","issueDate":"2020-10-10","issueLocation":"city","type":"PAS","value":"ABCDE1234"}],"loyaltyPrograms":[{"issuingSupplierCode":"T4","lob":"HOTEL","name":"S-Card","type":"LC","validFrom":"2021-10-10","validTo":"2025-10-10","value":"S12345"}],"preferences":[{"lob":"AIR","mealType":"178","preferredDepartureAirport":"","seatType":"1","specialRequest":"Any special requests"},{"lob":"RAIL","seatDirection":"Forward","seatRoom":"Lower","seatSolo":true,"seatType":"1"},{"lob":"HOTEL","smoking":"Smoking","specialRequest":"Any special requests"},{"lob":"CAR","specialRequest":"Any special requests"}],"serviceLevelIds":["12345"],"settings":{"notifications":{"reservationEmail":"validReservationEmailValue"}},"singleSignOnId":"singleSignOnIdValue","userAuthenticationMode":"SSO"},"emails":[{"primary":true,"type":"WORK","value":"test@abc.com"}],"phoneNumbers":[{"primary":true,"type":"WORK","value":"+44-1234512345"}],"addresses":[{"country":"GB","formatted":"address line 1, cityname, state, GB, 123212","locality":"city name","postalCode":"123212","region":"region or state","streetAddress":"address line 1","type":"WORK"}],"groups":[{"display":"displayName","value":"travelerGroup"}],"roles":["SELF_BOOKER"]}]}}},"description":"Search api success."},"400":{"content":{"application/scim+json":{"example":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"detail":"Invalid parameters","status":"400"}}},"description":"Bad Request : Invalid input or request"},"401":{"content":{"application/scim+json":{"example":{"error":{"code":"EGE-ER-4001","message":"Unauthorised access, you do not have sufficient permissions to perform this action."}}}},"description":"Unauthorized : Authentication token empty, invalid or expired."},"403":{"content":{"application/scim+json":{"example":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"detail":"Unauthorised access, you do not have sufficient permissions to perform this action. Contact your admin.","status":"403"}}},"description":"Forbidden : User not Validated for operation."},"422":{"content":{"application/scim+json":{"example":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"detail":"Invalid or missing parameters encountered, we are unable to process your request.","status":"422","data":[{"attribute":"userName","message":"userName needs to be specified and cannot be empty or null"}]}}},"description":"Invalid input : Invalid or missing required input."},"500":{"content":{"application/scim+json":{"example":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"detail":"Your request could not be completed due to some error. Please try again later.","status":"500","data":[{"attribute":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User.loyaltyPrograms","message":"Error occurred while processing loyalty program associations."}]}}},"description":"Internal Server Error : Unable to process request."},"503":{"content":{"application/scim+json":{"example":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"detail":"We are unable to process your request right now. Please try again later.","status":"503","data":[]}}},"description":"Service unavailable : Unable to process request at the moment."}},"security":[{"OAuth2":[]}],"summary":"Return list of users based on the filter condition.","tags":["SCIM User Sync V2"]},"post":{"operationId":"createUser_1","requestBody":{"content":{"application/json":{"examples":{"Create user with basic and extension attributes":{"description":"Create user with basic and extension attributes","value":{"schemas":["urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:extension:egencia:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"],"userName":"test@egencia.com","name":{"familyName":"User","givenName":"Test","middleName":"I","formatted":"Test I User","honorificPrefix":"Mr."},"userType":"NORMAL","preferredLanguage":"en","active":true,"emails":[{"type":"WORK","value":"test@egencia.com","primary":true}],"phoneNumbers":[{"type":"MOBILE","value":"+14254204087"}],"addresses":[{"type":"HOME","streetAddress":"1415 140TH AVE NE APT 15","locality":"Bellevue","region":"WA","postalCode":"98005","country":"US","formatted":"1415 140TH AVE NE APT 15"}],"groups":[{"value":"General"}],"roles":["SELF_BOOKER"],"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"employeeNumber":"testEmployeeNumberValue"}}},"Create user with basic attributes":{"description":"Create user with basic attributes","value":{"schemas":["urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:extension:egencia:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"],"userName":"test@egencia.com","name":{"familyName":"User","givenName":"Test","middleName":"I","formatted":"Test I User","honorificPrefix":"Mr."},"userType":"NORMAL","preferredLanguage":"en","active":true,"emails":[{"type":"WORK","value":"test@egencia.com","primary":true}],"phoneNumbers":[{"type":"MOBILE","value":"+14254204087"}],"addresses":[{"type":"HOME","streetAddress":"1415 140TH AVE NE APT 15","locality":"Bellevue","region":"WA","postalCode":"98005","country":"US","formatted":"1415 140TH AVE NE APT 15"}],"groups":[{"value":"General"}],"roles":["SELF_BOOKER"]}},"Create user with basic, extension and egencia extension attributes":{"description":"Create user with basic, extension and egencia extension attributes","value":{"schemas":["urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:extension:egencia:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"],"userName":"test@egencia.com","name":{"familyName":"User","givenName":"Test","middleName":"I","formatted":"Test I User","honorificPrefix":"Mr."},"userType":"NORMAL","preferredLanguage":"en","active":true,"emails":[{"type":"WORK","value":"test@egencia.com","primary":true}],"phoneNumbers":[{"type":"MOBILE","value":"+14254204087"}],"addresses":[{"type":"HOME","streetAddress":"1415 140TH AVE NE APT 15","locality":"Bellevue","region":"WA","postalCode":"98005","country":"US","formatted":"1415 140TH AVE NE APT 15"}],"groups":[{"value":"General"}],"roles":["SELF_BOOKER"],"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"employeeNumber":"testEmployeeNumberValue"},"urn:ietf:params:scim:schemas:extension:egencia:2.0:User":{"approvers":{"level1Approvers":[{"userName":"approverone@egencia.com"}],"level2Approvers":[{"userName":"approvertwo@egencia.com"}],"delegateApprovers":[{"userName":"approver@egencia.com"}]},"arrangerGroups":["arrangerGroup1"],"arrangers":[{"id":"56789"}],"companyId":"egenciaCompanyId","customDataFields":[{"name":"Cdf Name","value":"Cdf Value"}],"dateOfBirth":"1988-01-01","documents":[{"expirationDate":"2030-10-10","issueCountry":"US","issueDate":"2020-10-10","issueLocation":"city","type":"PAS","value":"ABCDE1234"}],"loyaltyPrograms":[{"issuingSupplierCode":"T4","lob":"HOTEL","name":"S-Card","type":"LC","validFrom":"2020-10-10","validTo":"2025-10-10","value":"S12345"}],"preferences":[{"lob":"AIR","mealType":"178","preferredDepartureAirport":"","seatType":"1","specialRequest":"Any special request"},{"lob":"RAIL","seatDirection":"Forward","seatRoom":"Lower","seatSolo":true,"seatType":"1"},{"lob":"HOTEL","smoking":"Smoking","specialRequest":"Any special request"},{"lob":"CAR","specialRequest":"Any special request"}],"serviceLevelIds":["123"],"settings":{"notifications":{"reservationEmail":"validReservationEmailValue"}},"singleSignOnId":"api.sample@egencia.com","userAuthenticationMode":"SSO"}}},"Create user with minimal attributes":{"description":"Create user with minimal attributes","value":{"schemas":["urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:extension:egencia:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"],"userName":"test@egencia.com","name":{"familyName":"User","givenName":"Test","middleName":""},"userType":"NORMAL","active":true,"emails":[{"type":"WORK","value":"test@egencia.com","primary":true}],"addresses":[{"type":"HOME","streetAddress":"1415 140TH AVE NE APT 15","locality":"Bellevue","region":"WA","postalCode":"98005","country":"US","formatted":"1415 140TH AVE NE APT 15"}]}}},"schema":{"$ref":"#/components/schemas/UserSchemaV2"}},"application/scim+json":{"examples":{"Create user with basic and extension attributes":{"description":"Create user with basic and extension attributes","value":{"schemas":["urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:extension:egencia:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"],"userName":"test@egencia.com","name":{"familyName":"User","givenName":"Test","middleName":"I","formatted":"Test I User","honorificPrefix":"Mr."},"userType":"NORMAL","preferredLanguage":"en","active":true,"emails":[{"type":"WORK","value":"test@egencia.com","primary":true}],"phoneNumbers":[{"type":"MOBILE","value":"+14254204087"}],"addresses":[{"type":"HOME","streetAddress":"1415 140TH AVE NE APT 15","locality":"Bellevue","region":"WA","postalCode":"98005","country":"US","formatted":"1415 140TH AVE NE APT 15"}],"groups":[{"value":"General"}],"roles":["SELF_BOOKER"],"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"employeeNumber":"testEmployeeNumberValue"}}},"Create user with basic attributes":{"description":"Create user with basic attributes","value":{"schemas":["urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:extension:egencia:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"],"userName":"test@egencia.com","name":{"familyName":"User","givenName":"Test","middleName":"I","formatted":"Test I User","honorificPrefix":"Mr."},"userType":"NORMAL","preferredLanguage":"en","active":true,"emails":[{"type":"WORK","value":"test@egencia.com","primary":true}],"phoneNumbers":[{"type":"MOBILE","value":"+14254204087"}],"addresses":[{"type":"HOME","streetAddress":"1415 140TH AVE NE APT 15","locality":"Bellevue","region":"WA","postalCode":"98005","country":"US","formatted":"1415 140TH AVE NE APT 15"}],"groups":[{"value":"General"}],"roles":["SELF_BOOKER"]}},"Create user with basic, extension and egencia extension attributes":{"description":"Create user with basic, extension and egencia extension attributes","value":{"schemas":["urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:extension:egencia:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"],"userName":"test@egencia.com","name":{"familyName":"User","givenName":"Test","middleName":"I","formatted":"Test I User","honorificPrefix":"Mr."},"userType":"NORMAL","preferredLanguage":"en","active":true,"emails":[{"type":"WORK","value":"test@egencia.com","primary":true}],"phoneNumbers":[{"type":"MOBILE","value":"+14254204087"}],"addresses":[{"type":"HOME","streetAddress":"1415 140TH AVE NE APT 15","locality":"Bellevue","region":"WA","postalCode":"98005","country":"US","formatted":"1415 140TH AVE NE APT 15"}],"groups":[{"value":"General"}],"roles":["SELF_BOOKER"],"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"employeeNumber":"testEmployeeNumberValue"},"urn:ietf:params:scim:schemas:extension:egencia:2.0:User":{"approvers":{"level1Approvers":[{"userName":"approverone@egencia.com"}],"level2Approvers":[{"userName":"approvertwo@egencia.com"}],"delegateApprovers":[{"userName":"approver@egencia.com"}]},"arrangerGroups":["arrangerGroup1"],"arrangers":[{"id":"56789"}],"companyId":"egenciaCompanyId","customDataFields":[{"name":"Cdf Name","value":"Cdf Value"}],"dateOfBirth":"1988-01-01","documents":[{"expirationDate":"2030-10-10","issueCountry":"US","issueDate":"2020-10-10","issueLocation":"city","type":"PAS","value":"ABCDE1234"}],"loyaltyPrograms":[{"issuingSupplierCode":"T4","lob":"HOTEL","name":"S-Card","type":"LC","validFrom":"2020-10-10","validTo":"2025-10-10","value":"S12345"}],"preferences":[{"lob":"AIR","mealType":"178","preferredDepartureAirport":"","seatType":"1","specialRequest":"Any special request"},{"lob":"RAIL","seatDirection":"Forward","seatRoom":"Lower","seatSolo":true,"seatType":"1"},{"lob":"HOTEL","smoking":"Smoking","specialRequest":"Any special request"},{"lob":"CAR","specialRequest":"Any special request"}],"serviceLevelIds":["123"],"settings":{"notifications":{"reservationEmail":"validReservationEmailValue"}},"singleSignOnId":"api.sample@egencia.com","userAuthenticationMode":"SSO"}}},"Create user with minimal attributes":{"description":"Create user with minimal attributes","value":{"schemas":["urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:extension:egencia:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"],"userName":"test@egencia.com","name":{"familyName":"User","givenName":"Test","middleName":""},"userType":"NORMAL","active":true,"emails":[{"type":"WORK","value":"test@egencia.com","primary":true}],"addresses":[{"type":"HOME","streetAddress":"1415 140TH AVE NE APT 15","locality":"Bellevue","region":"WA","postalCode":"98005","country":"US","formatted":"1415 140TH AVE NE APT 15"}]}}},"schema":{"$ref":"#/components/schemas/UserSchemaV2"}}},"description":"User Schema to be created","required":true},"responses":{"201":{"content":{"application/scim+json":{"example":{"schemas":["urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:extension:egencia:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"],"meta":{"created":"2024-07-17T00:00:00.000Z","lastModified":"2024-07-17T00:00:00.000Z","location":"{baseUrl}/openconnect/api/scim/v2/Users/egenciaUniqueIdentifier"},"id":"egenciaUniqueIdentifier","userName":"test@egencia.com","name":{"familyName":"User","givenName":"Test","middleName":"I","formatted":"Test I User","honorificPrefix":"Mr."},"userType":"NORMAL","preferredLanguage":"en","active":true,"emails":[{"type":"WORK","value":"test@egencia.com","primary":true}],"phoneNumbers":[{"type":"MOBILE","value":"+14254204087"}],"addresses":[{"type":"HOME","streetAddress":"1415 140TH AVE NE APT 15","locality":"Bellevue","region":"WA","postalCode":"98005","country":"US","formatted":"1415 140TH AVE NE APT 15"}],"groups":[{"value":"General"}],"roles":["SELF_BOOKER"],"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"employeeNumber":"testEmployeeNumberValue"},"urn:ietf:params:scim:schemas:extension:egencia:2.0:User":{"approvers":{"level1Approvers":[{"userName":"approverone@egencia.com"}],"level2Approvers":[{"userName":"approvertwo@egencia.com"}],"delegateApprovers":[{"userName":"approver@egencia.com"}]},"arrangerGroups":["arrangerGroup1"],"arrangers":[{"id":"56789"}],"companyId":"egenciaCompanyId","customDataFields":[{"name":"Cdf Name","value":"Cdf Value"}],"dateOfBirth":"1988-01-01","documents":[{"expirationDate":"2030-10-10","issueCountry":"US","issueDate":"2020-10-10","issueLocation":"city","type":"PAS","value":"ABCDE1234"}],"loyaltyPrograms":[{"issuingSupplierCode":"T4","lob":"HOTEL","name":"S-Card","type":"LC","validFrom":"2020-10-10","validTo":"2025-10-10","value":"S12345"}],"preferences":[{"lob":"AIR","mealType":"178","preferredDepartureAirport":"","seatType":"1","specialRequest":"Any special request"},{"lob":"RAIL","seatDirection":"Forward","seatRoom":"Lower","seatSolo":true,"seatType":"1"},{"lob":"HOTEL","smoking":"Smoking","specialRequest":"Any special request"},{"lob":"CAR","specialRequest":"Any special request"}],"serviceLevelIds":["123"],"settings":{"notifications":{"reservationEmail":"validReservationEmailValue"}},"singleSignOnId":"api.sample@egencia.com","userAuthenticationMode":"SSO"}}}},"description":"Created."},"400":{"content":{"application/scim+json":{"example":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"detail":"Invalid parameters","status":"400"}}},"description":"Bad Request : Invalid input or request"},"401":{"content":{"application/scim+json":{"example":{"error":{"code":"EGE-ER-4001","message":"Unauthorised access, you do not have sufficient permissions to perform this action."}}}},"description":"Unauthorized : Authentication token empty, invalid or expired."},"403":{"content":{"application/scim+json":{"example":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"detail":"Unauthorised access, you do not have sufficient permissions to perform this action. Contact your admin.","status":"403"}}},"description":"Forbidden : User not Validated for operation."},"409":{"content":{"application/scim+json":{"example":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"detail":"Invalid or missing parameters encountered, we are unable to process your request.","status":"409","data":[{"attribute":"userName","message":"Username already exists."}]}}},"description":"Conflict : User already exists."},"422":{"content":{"application/scim+json":{"example":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"detail":"Invalid or missing parameters encountered, we are unable to process your request.","status":"422","data":[{"attribute":"userName","message":"userName needs to be specified and cannot be empty or null"}]}}},"description":"Invalid input : Invalid or missing required input."},"500":{"content":{"application/scim+json":{"example":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"detail":"Your request could not be completed due to some error. Please try again later.","status":"500","data":[{"attribute":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User.loyaltyPrograms","message":"Error occurred while processing loyalty program associations."}]}}},"description":"Internal Server Error : Unable to process request."},"503":{"content":{"application/scim+json":{"example":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"detail":"We are unable to process your request right now. Please try again later.","status":"503","data":[]}}},"description":"Service unavailable : Unable to process request at the moment."}},"security":[{"OAuth2":[]}],"summary":"Create a new user in the system with the requested information.","tags":["SCIM User Sync V2"]}},"/scim/v2/Users/{userId}":{"delete":{"description":"Delete the user with the given user Id in the path
\nRequest Parameters
\n| \n Attribute\n | \n\n Type\n | \n\n Description\n | \n
|---|---|---|
| userId | \nString | \nUser Id of the user to be deleted | \n
Examples:
\nReplace {baseUrl} with the actual value of Egencia APIs host. Please refer Base Urls section under API Overview page of Egencia Developer Center.
\nDeleting a user with user Id : test_user_id
\n\n \n DELETE {baseUrl}/openconnect/api/scim/v2/Users/test_user_id\n Response:\n -> 204 No Content\n \n\n","operationId":"deleteUserUser_1","parameters":[{"description":"User Id of the user to be deleted","in":"path","name":"userId","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content."},"401":{"content":{"application/scim+json":{"example":{"error":{"code":"EGE-ER-4001","message":"Unauthorised access, you do not have sufficient permissions to perform this action."}}}},"description":"Unauthorized : Authentication token empty, invalid or expired."},"403":{"content":{"application/scim+json":{"example":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"detail":"Unauthorised access, you do not have sufficient permissions to perform this action. Contact your admin.","status":"403"}}},"description":"Forbidden : User not Validated for operation."},"404":{"content":{"application/scim+json":{"example":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"detail":"User not found, you are trying to access an invalid or non existent user.","status":"404","data":[{"attribute":"id","message":"Requested user identifier is invalid."}]}}},"description":"Not Found : Resource Not Found."},"422":{"content":{"application/scim+json":{"example":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"detail":"We are unable to process the request due to missing mandatory or invalid parameters.","status":"422","data":[{"attribute":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User.documents","message":"One or more invalid user documents are supplied."},{"attribute":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User.preferences","message":"One or more invalid user preferences are supplied."}]}}},"description":"Invalid input : Invalid or missing required input."},"500":{"content":{"application/scim+json":{"example":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"detail":"Your request could not be completed due to some error. Please try again later.","status":"500","data":[{"attribute":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User.loyaltyPrograms","message":"Error occurred while processing loyalty program associations."}]}}},"description":"Internal Server Error : Unable to process request."},"503":{"content":{"application/scim+json":{"example":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"detail":"We are unable to process your request right now. Please try again later.","status":"503","data":[]}}},"description":"Service unavailable : Unable to process request at the moment."}},"security":[{"OAuth2":[]}],"summary":"Delete the user in the system with the given user Id.","tags":["SCIM User Sync V2"]},"get":{"operationId":"getUser_1","parameters":[{"description":"Id of the user to be retrieved","in":"path","name":"userId","required":true,"schema":{"type":"string"}},{"in":"query","name":"attributes","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"content":{"application/scim+json":{"example":{"schemas":["urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:extension:egencia:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"],"meta":{"created":"2024-07-17T00:00:00.000Z","lastModified":"2024-07-17T00:00:00.000Z","location":"{baseUrl}/openconnect/api/scim/v2/Users/12345"},"id":"egenciaUniqueIdentifier","externalId":"externalSystemIdentifier","userName":"test@example.com","name":{"familyName":"User","formatted":"","givenName":"Test","middleName":"","honorificPrefix":"Mr."},"userType":"NORMAL","preferredLanguage":"en","active":true,"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"employeeNumber":"employeeNumberValue"},"urn:ietf:params:scim:schemas:extension:egencia:2.0:User":{"approvers":{"level1Approvers":[{"id":"45678"}],"level2Approvers":[{"id":"45678"}],"delegateApprovers":[{"id":"123"}]},"arrangerGroups":["arrangerGroup1"],"arrangers":[{"id":"56789"},{"userName":"testarranger"}],"companyId":"egenciaCompanyId","customDataFields":[{"name":"Primary cost center","value":"Test cost center"}],"dateOfBirth":"1988-01-01","documents":[{"expirationDate":"2030-10-10","issueCountry":"US","issueDate":"2020-10-10","issueLocation":"city","type":"PAS","value":"ABCDE1234"}],"loyaltyPrograms":[{"issuingSupplierCode":"T4","lob":"HOTEL","name":"S-Card","type":"LC","validFrom":"2020-10-10","validTo":"2025-10-10","value":"S12345"}],"preferences":[{"lob":"AIR","mealType":"178","preferredDepartureAirport":"","seatType":"1","specialRequest":"Any special request"},{"lob":"RAIL","seatDirection":"Forward","seatRoom":"Lower","seatSolo":true,"seatType":"1"},{"lob":"HOTEL","smoking":"Smoking","specialRequest":"Any special request"},{"lob":"CAR","specialRequest":"Any special request"}],"serviceLevelIds":["12345"],"settings":{"notifications":{"reservationEmail":"validReservationEmailValue"}},"singleSignOnId":"singleSignOnIdValue","userAuthenticationMode":"SSO"},"emails":[{"primary":true,"type":"WORK","value":"test@example.com"}],"phoneNumbers":[{"primary":true,"type":"WORK","value":"+44-1234512345"}],"addresses":[{"country":"GB","formatted":"address line 1, cityname, state, GB, 123212","locality":"city name","postalCode":"123212","region":"region or state","streetAddress":"address line 1","type":"WORK"}],"groups":[{"display":"displayName","value":"travelerGroup"}],"roles":["SELF_BOOKER"]}}},"description":"Found."},"400":{"content":{"application/scim+json":{"example":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"detail":"Invalid parameters","status":"400"}}},"description":"Bad Request : Invalid input or request"},"401":{"content":{"application/scim+json":{"example":{"error":{"code":"EGE-ER-4001","message":"Unauthorised access, you do not have sufficient permissions to perform this action."}}}},"description":"Unauthorized : Authentication token empty, invalid or expired."},"403":{"content":{"application/scim+json":{"example":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"detail":"Unauthorised access, you do not have sufficient permissions to perform this action. Contact your admin.","status":"403"}}},"description":"Forbidden : User not Validated for operation."},"404":{"content":{"application/scim+json":{"example":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"detail":"User not found, you are trying to access an invalid or non existent user.","status":"404","data":[{"attribute":"id","message":"Requested user identifier is invalid."}]}}},"description":"Not Found : Resource Not Found."},"422":{"content":{"application/scim+json":{"example":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"detail":"Invalid or missing parameters encountered, we are unable to process your request.","status":"422","data":[{"attribute":"userName","message":"userName needs to be specified and cannot be empty or null"}]}}},"description":"Invalid input : Invalid or missing required input."},"500":{"content":{"application/scim+json":{"example":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"detail":"Your request could not be completed due to some error. Please try again later.","status":"500","data":[{"attribute":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User.loyaltyPrograms","message":"Error occurred while processing loyalty program associations."}]}}},"description":"Internal Server Error : Unable to process request."},"503":{"content":{"application/scim+json":{"example":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"detail":"We are unable to process your request right now. Please try again later.","status":"503","data":[]}}},"description":"Service unavailable : Unable to process request at the moment."}},"security":[{"OAuth2":[]}],"summary":"Retrieves the user details for a requested user identifier.","tags":["SCIM User Sync V2"]},"patch":{"operationId":"patchUser_1","parameters":[{"description":"Id of the user to be updated","in":"path","name":"userId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"Request to add a new arranger to the existing arrangers":{"description":"Request to add a new arranger to the existing arrangers","value":{"schemas":["urn:ietf:params:scim:api:messages:2.0:PatchOp"],"Operations":[{"op":"add","path":"urn:ietf:params:scim:schemas:extension:egencia:2.0:User:arrangers","value":[{"id":"id","userName":"api.sample@egencia.com"}]}]}},"Request to add a new custom data field to the existing custom data field list:":{"description":"Request to add a new custom data field to the existing custom data field list:","value":{"schemas":["urn:ietf:params:scim:api:messages:2.0:PatchOp"],"Operations":[{"op":"add","path":"urn:ietf:params:scim:schemas:extension:egencia:2.0:User:customDataFields","value":[{"name":"CDF label","value":"CDF value"}]}]}},"Request to add a new level 1 approver to the existing level1Approvers list":{"description":"Request to add a new level 1 approver to the existing level1Approvers list","value":{"schemas":["urn:ietf:params:scim:api:messages:2.0:PatchOp"],"Operations":[{"op":"add","path":"urn:ietf:params:scim:schemas:extension:egencia:2.0:User:approvers.level1Approvers","value":[{"userName":"api.sample@egencia.com"}]}]}},"Request to add a new level 1 as well as level 2 approver to the existing level1Approvers and level2Approvers list":{"description":"Request to add a new level 1 as well as level 2 approver to the existing level1Approvers and level2Approvers list","value":{"schemas":["urn:ietf:params:scim:api:messages:2.0:PatchOp"],"Operations":[{"op":"add","value":{"urn:ietf:params:scim:schemas:extension:egencia:2.0:User":{"approvers":{"level1Approvers":[{"id":"id"}],"level2Approvers":[{"userName":"api.sample@egencia.com"}]}}}}]}},"Request to add a new role to the existing roles":{"description":"Request to add a new role to the existing roles","value":{"schemas":["urn:ietf:params:scim:api:messages:2.0:PatchOp"],"Operations":[{"op":"add","path":"roles","value":["ARRANGER"]}]}},"Request to add/update first name, last name and date of birth":{"description":"Request to add/update first name, last name and date of birth","value":{"schemas":["urn:ietf:params:scim:api:messages:2.0:PatchOp"],"Operations":[{"op":"add","value":{"name":{"givenName":"First Name","familyName":"Last Name"},"urn:ietf:params:scim:schemas:extension:egencia:2.0:User":{"dateOfBirth":"1988-01-26"}}}]}},"Request to add/update status of user":{"description":"Request to add/update status of user","value":{"schemas":["urn:ietf:params:scim:api:messages:2.0:PatchOp"],"Operations":[{"op":"replace","value":{"active":false}}]}},"Request to replace traveler group with a new one.":{"description":"Request to replace traveler group with a new one.","value":{"schemas":["urn:ietf:params:scim:api:messages:2.0:PatchOp"],"Operations":[{"op":"replace","path":"groups","value":[{"value":"General"}]}]}},"Request to update WORK type email, username, ssoId, authentication mode":{"description":"Request to update WORK type email, username, ssoId, authentication mode","value":{"schemas":["urn:ietf:params:scim:api:messages:2.0:PatchOp"],"Operations":[{"op":"replace","path":"emails[type eq \"WORK\"].value","value":"api.sample@egencia.com"},{"op":"add","value":{"userName":"api.sample@egencia.com","urn:ietf:params:scim:schemas:extension:egencia:2.0:User":{"singleSignOnId":"api.sample@egencia.com","userAuthenticationMode":"SSO"}}}]}},"Request with multiple patch operations":{"description":"Request with multiple patch operations","value":{"schemas":["urn:ietf:params:scim:api:messages:2.0:PatchOp"],"Operations":[{"op":"add","path":"urn:ietf:params:scim:schemas:extension:egencia:2.0:User:customDataFields","value":[{"name":"ff test","value":"ff test value"},{"name":"Test CDF","value":"Test CDF"}]},{"op":"add","path":"urn:ietf:params:scim:schemas:extension:egencia:2.0:User:companyId","value":"23"},{"op":"add","value":{"userName":"abcd","name":{"givenName":"Abcd"},"urn:ietf:params:scim:schemas:extension:egencia:2.0:User":{"companyId":"23"}}},{"op":"replace","path":"addresses[type eq \"HOME\"].streetAddress","value":"1010 Broadway Ave"},{"op":"replace","path":"addresses[type eq \"HOME\"]","value":{"streetAddress":"911 Universal City Plaza","locality":"Hollywood","region":"CA","postalCode":"91608","country":"USA","formatted":"911 Universal City Plaza\nHollywood, CA 91608 US"}},{"op":"replace","value":{"emails":[{"value":"test@example.com","type":"WORK","primary":true}]}},{"op":"replace","value":{"phoneNumbers":[{"value":"+91-9999999999","type":"HOME","primary":true}]}},{"op":"add","path":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber","value":"11111"}]}}},"schema":{"$ref":"#/components/schemas/ScimPatchSchema"}},"application/scim+json":{"examples":{"Request to add a new arranger to the existing arrangers":{"description":"Request to add a new arranger to the existing arrangers","value":{"schemas":["urn:ietf:params:scim:api:messages:2.0:PatchOp"],"Operations":[{"op":"add","path":"urn:ietf:params:scim:schemas:extension:egencia:2.0:User:arrangers","value":[{"id":"id","userName":"api.sample@egencia.com"}]}]}},"Request to add a new custom data field to the existing custom data field list:":{"description":"Request to add a new custom data field to the existing custom data field list:","value":{"schemas":["urn:ietf:params:scim:api:messages:2.0:PatchOp"],"Operations":[{"op":"add","path":"urn:ietf:params:scim:schemas:extension:egencia:2.0:User:customDataFields","value":[{"name":"CDF label","value":"CDF value"}]}]}},"Request to add a new level 1 approver to the existing level1Approvers list":{"description":"Request to add a new level 1 approver to the existing level1Approvers list","value":{"schemas":["urn:ietf:params:scim:api:messages:2.0:PatchOp"],"Operations":[{"op":"add","path":"urn:ietf:params:scim:schemas:extension:egencia:2.0:User:approvers.level1Approvers","value":[{"userName":"api.sample@egencia.com"}]}]}},"Request to add a new level 1 as well as level 2 approver to the existing level1Approvers and level2Approvers list":{"description":"Request to add a new level 1 as well as level 2 approver to the existing level1Approvers and level2Approvers list","value":{"schemas":["urn:ietf:params:scim:api:messages:2.0:PatchOp"],"Operations":[{"op":"add","value":{"urn:ietf:params:scim:schemas:extension:egencia:2.0:User":{"approvers":{"level1Approvers":[{"id":"id"}],"level2Approvers":[{"userName":"api.sample@egencia.com"}]}}}}]}},"Request to add a new role to the existing roles":{"description":"Request to add a new role to the existing roles","value":{"schemas":["urn:ietf:params:scim:api:messages:2.0:PatchOp"],"Operations":[{"op":"add","path":"roles","value":["ARRANGER"]}]}},"Request to add/update first name, last name and date of birth":{"description":"Request to add/update first name, last name and date of birth","value":{"schemas":["urn:ietf:params:scim:api:messages:2.0:PatchOp"],"Operations":[{"op":"add","value":{"name":{"givenName":"First Name","familyName":"Last Name"},"urn:ietf:params:scim:schemas:extension:egencia:2.0:User":{"dateOfBirth":"1988-01-26"}}}]}},"Request to add/update status of user":{"description":"Request to add/update status of user","value":{"schemas":["urn:ietf:params:scim:api:messages:2.0:PatchOp"],"Operations":[{"op":"replace","value":{"active":false}}]}},"Request to replace traveler group with a new one.":{"description":"Request to replace traveler group with a new one.","value":{"schemas":["urn:ietf:params:scim:api:messages:2.0:PatchOp"],"Operations":[{"op":"replace","path":"groups","value":[{"value":"General"}]}]}},"Request to update WORK type email, username, ssoId, authentication mode":{"description":"Request to update WORK type email, username, ssoId, authentication mode","value":{"schemas":["urn:ietf:params:scim:api:messages:2.0:PatchOp"],"Operations":[{"op":"replace","path":"emails[type eq \"WORK\"].value","value":"api.sample@egencia.com"},{"op":"add","value":{"userName":"api.sample@egencia.com","urn:ietf:params:scim:schemas:extension:egencia:2.0:User":{"singleSignOnId":"api.sample@egencia.com","userAuthenticationMode":"SSO"}}}]}},"Request with multiple patch operations":{"description":"Request with multiple patch operations","value":{"schemas":["urn:ietf:params:scim:api:messages:2.0:PatchOp"],"Operations":[{"op":"add","path":"urn:ietf:params:scim:schemas:extension:egencia:2.0:User:customDataFields","value":[{"name":"ff test","value":"ff test value"},{"name":"Test CDF","value":"Test CDF"}]},{"op":"add","path":"urn:ietf:params:scim:schemas:extension:egencia:2.0:User:companyId","value":"23"},{"op":"add","value":{"userName":"abcd","name":{"givenName":"Abcd"},"urn:ietf:params:scim:schemas:extension:egencia:2.0:User":{"companyId":"23"}}},{"op":"replace","path":"addresses[type eq \"HOME\"].streetAddress","value":"1010 Broadway Ave"},{"op":"replace","path":"addresses[type eq \"HOME\"]","value":{"streetAddress":"911 Universal City Plaza","locality":"Hollywood","region":"CA","postalCode":"91608","country":"USA","formatted":"911 Universal City Plaza\nHollywood, CA 91608 US"}},{"op":"replace","value":{"emails":[{"value":"test@example.com","type":"WORK","primary":true}]}},{"op":"replace","value":{"phoneNumbers":[{"value":"+91-9999999999","type":"HOME","primary":true}]}},{"op":"add","path":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber","value":"11111"}]}}},"schema":{"$ref":"#/components/schemas/ScimPatchSchema"}}},"description":"SCIM compliant patch operation schema","required":true},"responses":{"200":{"content":{"application/scim+json":{"example":{"schemas":["urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:extension:egencia:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"],"meta":{"created":"2024-07-17T00:00:00.000Z","lastModified":"2024-07-17T00:00:00.000Z","location":"{baseUrl}/openconnect/api/scim/v2/Users/12345"},"id":"egenciaUniqueIdentifier","externalId":"externalSystemIdentifier","userName":"test@example.com","name":{"familyName":"User","formatted":"","givenName":"Test","middleName":"","honorificPrefix":"Mr."},"userType":"NORMAL","preferredLanguage":"en","active":true,"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"employeeNumber":"employeeNumberValue"},"urn:ietf:params:scim:schemas:extension:egencia:2.0:User":{"approvers":{"level1Approvers":[{"id":"45678"}],"level2Approvers":[{"id":"45678"}],"delegateApprovers":[{"id":"123"}]},"arrangerGroups":["arrangerGroup1"],"arrangers":[{"id":"56789"},{"userName":"testarranger"}],"companyId":"egenciaCompanyId","customDataFields":[{"name":"Primary cost center","value":"Test cost center"}],"dateOfBirth":"1988-01-01","documents":[{"expirationDate":"2030-10-10","issueCountry":"US","issueDate":"2020-10-10","issueLocation":"city","type":"PAS","value":"ABCDE1234"}],"loyaltyPrograms":[{"issuingSupplierCode":"T4","lob":"HOTEL","name":"S-Card","type":"LC","validFrom":"2020-10-10","validTo":"2025-10-10","value":"S12345"}],"preferences":[{"lob":"AIR","mealType":"178","preferredDepartureAirport":"","seatType":"1","specialRequest":"Any special request"},{"lob":"RAIL","seatDirection":"Forward","seatRoom":"Lower","seatSolo":true,"seatType":"1"},{"lob":"HOTEL","smoking":"Smoking","specialRequest":"Any special request"},{"lob":"CAR","specialRequest":"Any special request"}],"serviceLevelIds":["12345"],"settings":{"notifications":{"reservationEmail":"validReservationEmailValue"}},"singleSignOnId":"singleSignOnIdValue","userAuthenticationMode":"SSO"},"emails":[{"primary":true,"type":"WORK","value":"test@example.com"}],"phoneNumbers":[{"primary":true,"type":"WORK","value":"+44-1234512345"}],"addresses":[{"country":"GB","formatted":"address line 1, cityname, state, GB, 123212","locality":"city name","postalCode":"123212","region":"region or state","streetAddress":"address line 1","type":"WORK"}],"groups":[{"display":"displayName","value":"travelerGroup"}],"roles":["SELF_BOOKER"]}}},"description":"Patch api success"},"400":{"content":{"application/scim+json":{"example":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"detail":"Invalid parameters","status":"400"}}},"description":"Bad Request : Invalid input or request"},"401":{"content":{"application/scim+json":{"example":{"error":{"code":"EGE-ER-4001","message":"Unauthorised access, you do not have sufficient permissions to perform this action."}}}},"description":"Unauthorized : Authentication token empty, invalid or expired."},"403":{"content":{"application/scim+json":{"example":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"detail":"Unauthorised access, you do not have sufficient permissions to perform this action. Contact your admin.","status":"403"}}},"description":"Forbidden : User not Validated for operation."},"404":{"content":{"application/scim+json":{"example":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"detail":"User not found, you are trying to access an invalid or non existent user.","status":"404","data":[{"attribute":"id","message":"Requested user identifier is invalid."}]}}},"description":"Not Found : Resource Not Found."},"422":{"content":{"application/scim+json":{"example":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"detail":"Invalid or missing parameters encountered, we are unable to process your request.","status":"422","data":[{"attribute":"userName","message":"userName needs to be specified and cannot be empty or null"}]}}},"description":"Invalid input : Invalid or missing required input."},"500":{"content":{"application/scim+json":{"example":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"detail":"Your request could not be completed due to some error. Please try again later.","status":"500","data":[{"attribute":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User.loyaltyPrograms","message":"Error occurred while processing loyalty program associations."}]}}},"description":"Internal Server Error : Unable to process request."},"503":{"content":{"application/scim+json":{"example":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"detail":"We are unable to process your request right now. Please try again later.","status":"503","data":[]}}},"description":"Service unavailable : Unable to process request at the moment."}},"security":[{"OAuth2":[]}],"summary":"Perform patch operation on the user with the given user Id.","tags":["SCIM User Sync V2"]},"put":{"operationId":"updateUser_1","parameters":[{"description":"Id of the user to be updated","in":"path","name":"userId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"Update user with basic and extension attributes":{"description":"Update user with basic and extension attributes","value":{"schemas":["urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:extension:egencia:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"],"id":"egenciaUniqueIdentifier","userName":"test@egencia.com","name":{"familyName":"User","givenName":"Test","middleName":"I","formatted":"Test I User","honorificPrefix":"Mr."},"userType":"NORMAL","preferredLanguage":"en","active":true,"emails":[{"type":"WORK","value":"test@egencia.com","primary":true}],"phoneNumbers":[{"type":"MOBILE","value":"+14254204087"}],"addresses":[{"type":"HOME","streetAddress":"1415 140TH AVE NE APT 15","locality":"Bellevue","region":"WA","postalCode":"98005","country":"US","formatted":"1415 140TH AVE NE APT 15"}],"groups":[{"value":"General"}],"roles":["SELF_BOOKER"],"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"employeeNumber":"testEmployeeNumberValue"}}},"Update user with basic attributes":{"description":"Update user with basic attributes","value":{"schemas":["urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:extension:egencia:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"],"id":"egenciaUniqueIdentifier","userName":"test@egencia.com","name":{"familyName":"User","givenName":"Test","middleName":"I","formatted":"Test I User","honorificPrefix":"Mr."},"userType":"NORMAL","preferredLanguage":"en","active":true,"emails":[{"type":"WORK","value":"test@egencia.com","primary":true}],"phoneNumbers":[{"type":"MOBILE","value":"+14254204087"}],"addresses":[{"type":"HOME","streetAddress":"1415 140TH AVE NE APT 15","locality":"Bellevue","region":"WA","postalCode":"98005","country":"US","formatted":"1415 140TH AVE NE APT 15"}],"groups":[{"value":"General"}],"roles":["SELF_BOOKER"]}},"Update user with basic, extension and egencia extension attributes":{"description":"Update user with basic, extension and egencia extension attributes","value":{"schemas":["urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:extension:egencia:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"],"id":"egenciaUniqueIdentifier","userName":"test@egencia.com","name":{"familyName":"User","givenName":"Test","middleName":"I","formatted":"Test I User","honorificPrefix":"Mr."},"userType":"NORMAL","preferredLanguage":"en","active":true,"emails":[{"type":"WORK","value":"test@egencia.com","primary":true}],"phoneNumbers":[{"type":"MOBILE","value":"+14254204087"}],"addresses":[{"type":"HOME","streetAddress":"1415 140TH AVE NE APT 15","locality":"Bellevue","region":"WA","postalCode":"98005","country":"US","formatted":"1415 140TH AVE NE APT 15"}],"groups":[{"value":"General"}],"roles":["SELF_BOOKER"],"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"employeeNumber":"testEmployeeNumberValue"},"urn:ietf:params:scim:schemas:extension:egencia:2.0:User":{"approvers":{"level1Approvers":[{"userName":"approverone@egencia.com"}],"level2Approvers":[{"userName":"approvertwo@egencia.com"}],"delegateApprovers":[{"userName":"approver@egencia.com"}]},"arrangerGroups":["arrangerGroup1"],"arrangers":[{"id":"56789"}],"companyId":"egenciaCompanyId","customDataFields":[{"name":"Cdf Name","value":"Cdf Value"}],"dateOfBirth":"1988-01-01","documents":[{"expirationDate":"2030-10-10","issueCountry":"US","issueDate":"2020-10-10","issueLocation":"city","type":"PAS","value":"ABCDE1234"}],"loyaltyPrograms":[{"issuingSupplierCode":"T4","lob":"HOTEL","name":"S-Card","type":"LC","validFrom":"2020-10-10","validTo":"2025-10-10","value":"S12345"}],"preferences":[{"lob":"AIR","mealType":"178","preferredDepartureAirport":"","seatType":"1","specialRequest":"Any special request"},{"lob":"RAIL","seatDirection":"Forward","seatRoom":"Lower","seatSolo":true,"seatType":"1"},{"lob":"HOTEL","smoking":"Smoking","specialRequest":"Any special request"},{"lob":"CAR","specialRequest":"Any special request"}],"serviceLevelIds":["123"],"settings":{"notifications":{"reservationEmail":"validReservationEmailValue"}},"singleSignOnId":"api.sample@egencia.com","userAuthenticationMode":"SSO"}}},"Update user with minimal attributes":{"description":"Update user with minimal attributes","value":{"schemas":["urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:extension:egencia:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"],"id":"egenciaUniqueIdentifier","userName":"test@egencia.com","name":{"familyName":"User","givenName":"Test","middleName":""},"userType":"NORMAL","active":true,"emails":[{"type":"WORK","value":"test@egencia.com","primary":true}],"addresses":[{"type":"HOME","streetAddress":"1415 140TH AVE NE APT 15","locality":"Bellevue","region":"WA","postalCode":"98005","country":"US","formatted":"1415 140TH AVE NE APT 15"}]}}},"schema":{"$ref":"#/components/schemas/UserSchemaV2"}},"application/scim+json":{"examples":{"Update user with basic and extension attributes":{"description":"Update user with basic and extension attributes","value":{"schemas":["urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:extension:egencia:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"],"id":"egenciaUniqueIdentifier","userName":"test@egencia.com","name":{"familyName":"User","givenName":"Test","middleName":"I","formatted":"Test I User","honorificPrefix":"Mr."},"userType":"NORMAL","preferredLanguage":"en","active":true,"emails":[{"type":"WORK","value":"test@egencia.com","primary":true}],"phoneNumbers":[{"type":"MOBILE","value":"+14254204087"}],"addresses":[{"type":"HOME","streetAddress":"1415 140TH AVE NE APT 15","locality":"Bellevue","region":"WA","postalCode":"98005","country":"US","formatted":"1415 140TH AVE NE APT 15"}],"groups":[{"value":"General"}],"roles":["SELF_BOOKER"],"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"employeeNumber":"testEmployeeNumberValue"}}},"Update user with basic attributes":{"description":"Update user with basic attributes","value":{"schemas":["urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:extension:egencia:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"],"id":"egenciaUniqueIdentifier","userName":"test@egencia.com","name":{"familyName":"User","givenName":"Test","middleName":"I","formatted":"Test I User","honorificPrefix":"Mr."},"userType":"NORMAL","preferredLanguage":"en","active":true,"emails":[{"type":"WORK","value":"test@egencia.com","primary":true}],"phoneNumbers":[{"type":"MOBILE","value":"+14254204087"}],"addresses":[{"type":"HOME","streetAddress":"1415 140TH AVE NE APT 15","locality":"Bellevue","region":"WA","postalCode":"98005","country":"US","formatted":"1415 140TH AVE NE APT 15"}],"groups":[{"value":"General"}],"roles":["SELF_BOOKER"]}},"Update user with basic, extension and egencia extension attributes":{"description":"Update user with basic, extension and egencia extension attributes","value":{"schemas":["urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:extension:egencia:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"],"id":"egenciaUniqueIdentifier","userName":"test@egencia.com","name":{"familyName":"User","givenName":"Test","middleName":"I","formatted":"Test I User","honorificPrefix":"Mr."},"userType":"NORMAL","preferredLanguage":"en","active":true,"emails":[{"type":"WORK","value":"test@egencia.com","primary":true}],"phoneNumbers":[{"type":"MOBILE","value":"+14254204087"}],"addresses":[{"type":"HOME","streetAddress":"1415 140TH AVE NE APT 15","locality":"Bellevue","region":"WA","postalCode":"98005","country":"US","formatted":"1415 140TH AVE NE APT 15"}],"groups":[{"value":"General"}],"roles":["SELF_BOOKER"],"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"employeeNumber":"testEmployeeNumberValue"},"urn:ietf:params:scim:schemas:extension:egencia:2.0:User":{"approvers":{"level1Approvers":[{"userName":"approverone@egencia.com"}],"level2Approvers":[{"userName":"approvertwo@egencia.com"}],"delegateApprovers":[{"userName":"approver@egencia.com"}]},"arrangerGroups":["arrangerGroup1"],"arrangers":[{"id":"56789"}],"companyId":"egenciaCompanyId","customDataFields":[{"name":"Cdf Name","value":"Cdf Value"}],"dateOfBirth":"1988-01-01","documents":[{"expirationDate":"2030-10-10","issueCountry":"US","issueDate":"2020-10-10","issueLocation":"city","type":"PAS","value":"ABCDE1234"}],"loyaltyPrograms":[{"issuingSupplierCode":"T4","lob":"HOTEL","name":"S-Card","type":"LC","validFrom":"2020-10-10","validTo":"2025-10-10","value":"S12345"}],"preferences":[{"lob":"AIR","mealType":"178","preferredDepartureAirport":"","seatType":"1","specialRequest":"Any special request"},{"lob":"RAIL","seatDirection":"Forward","seatRoom":"Lower","seatSolo":true,"seatType":"1"},{"lob":"HOTEL","smoking":"Smoking","specialRequest":"Any special request"},{"lob":"CAR","specialRequest":"Any special request"}],"serviceLevelIds":["123"],"settings":{"notifications":{"reservationEmail":"validReservationEmailValue"}},"singleSignOnId":"api.sample@egencia.com","userAuthenticationMode":"SSO"}}},"Update user with minimal attributes":{"description":"Update user with minimal attributes","value":{"schemas":["urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:extension:egencia:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"],"id":"egenciaUniqueIdentifier","userName":"test@egencia.com","name":{"familyName":"User","givenName":"Test","middleName":""},"userType":"NORMAL","active":true,"emails":[{"type":"WORK","value":"test@egencia.com","primary":true}],"addresses":[{"type":"HOME","streetAddress":"1415 140TH AVE NE APT 15","locality":"Bellevue","region":"WA","postalCode":"98005","country":"US","formatted":"1415 140TH AVE NE APT 15"}]}}},"schema":{"$ref":"#/components/schemas/UserSchemaV2"}}},"description":"User Schema to be updated","required":true},"responses":{"200":{"content":{"application/scim+json":{"example":{"schemas":["urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:extension:egencia:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"],"meta":{"created":"2024-07-17T00:00:00.000Z","lastModified":"2024-07-17T00:00:00.000Z","location":"{baseUrl}/openconnect/api/scim/v2/Users/12345"},"id":"egenciaUniqueIdentifier","externalId":"externalSystemIdentifier","userName":"test@example.com","name":{"familyName":"User","formatted":"","givenName":"Test","middleName":"","honorificPrefix":"Mr."},"userType":"NORMAL","preferredLanguage":"en","active":true,"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"employeeNumber":"employeeNumberValue"},"urn:ietf:params:scim:schemas:extension:egencia:2.0:User":{"approvers":{"level1Approvers":[{"id":"45678"}],"level2Approvers":[{"id":"45678"}],"delegateApprovers":[{"id":"123"}]},"arrangerGroups":["arrangerGroup1"],"arrangers":[{"id":"56789"},{"userName":"testarranger"}],"companyId":"egenciaCompanyId","customDataFields":[{"name":"Primary cost center","value":"Test cost center"}],"dateOfBirth":"1988-01-01","documents":[{"expirationDate":"2030-10-10","issueCountry":"US","issueDate":"2020-10-10","issueLocation":"city","type":"PAS","value":"ABCDE1234"}],"loyaltyPrograms":[{"issuingSupplierCode":"T4","lob":"HOTEL","name":"S-Card","type":"LC","validFrom":"2020-10-10","validTo":"2025-10-10","value":"S12345"}],"preferences":[{"lob":"AIR","mealType":"178","preferredDepartureAirport":"","seatType":"1","specialRequest":"Any special request"},{"lob":"RAIL","seatDirection":"Forward","seatRoom":"Lower","seatSolo":true,"seatType":"1"},{"lob":"HOTEL","smoking":"Smoking","specialRequest":"Any special request"},{"lob":"CAR","specialRequest":"Any special request"}],"serviceLevelIds":["12345"],"settings":{"notifications":{"reservationEmail":"validReservationEmailValue"}},"singleSignOnId":"singleSignOnIdValue","userAuthenticationMode":"SSO"},"emails":[{"primary":true,"type":"WORK","value":"test@example.com"}],"phoneNumbers":[{"primary":true,"type":"WORK","value":"+44-1234512345"}],"addresses":[{"country":"GB","formatted":"address line 1, cityname, state, GB, 123212","locality":"city name","postalCode":"123212","region":"region or state","streetAddress":"address line 1","type":"WORK"}],"groups":[{"display":"displayName","value":"travelerGroup"}],"roles":["SELF_BOOKER"]}}},"description":"Updated."},"400":{"content":{"application/scim+json":{"example":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"detail":"Invalid parameters","status":"400"}}},"description":"Bad Request : Invalid input or request"},"401":{"content":{"application/scim+json":{"example":{"error":{"code":"EGE-ER-4001","message":"Unauthorised access, you do not have sufficient permissions to perform this action."}}}},"description":"Unauthorized : Authentication token empty, invalid or expired."},"403":{"content":{"application/scim+json":{"example":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"detail":"Unauthorised access, you do not have sufficient permissions to perform this action. Contact your admin.","status":"403"}}},"description":"Forbidden : User not Validated for operation."},"422":{"content":{"application/scim+json":{"example":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"detail":"Invalid or missing parameters encountered, we are unable to process your request.","status":"422","data":[{"attribute":"userName","message":"userName needs to be specified and cannot be empty or null"}]}}},"description":"Invalid input : Invalid or missing required input."},"500":{"content":{"application/scim+json":{"example":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"detail":"Your request could not be completed due to some error. Please try again later.","status":"500","data":[{"attribute":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User.loyaltyPrograms","message":"Error occurred while processing loyalty program associations."}]}}},"description":"Internal Server Error : Unable to process request."},"503":{"content":{"application/scim+json":{"example":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"detail":"We are unable to process your request right now. Please try again later.","status":"503","data":[]}}},"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 User Sync V2"]}},"/scim/v3/Users":{"get":{"description":"Search/retrieve users based on the filter string parameter. Please be cautious if you are using organization token, search API will return users of all associated companies of parent company's org id if company is not provided in the filter criteria.
\nResults are returned in ascending order of userIds.
\nNote: We only support search by email, name, userName and singleSignOnId. Since filter attribute contains special characters like square brackets, clients need to encode the filter attribute value.
\n\n \n For search by email with value as test@egencia.com, you need to pass encoded value in filter which will be :\n filter = emails%5Bvalue%20eq%20%22test%40egencia.com%22%5D\n which is the encoded value for filter = emails[value eq \"test@egencia.com\"]\n \n\n","operationId":"getUsers","parameters":[{"description":"SCIM compliant filter attribute to take query string. If you are using any external tool to make the API call, please make sure to encode the filter value.","examples":{"Search Users By Company":{"description":"Replace {companyId} by the egencia company Id you want to search.","value":"urn:ietf:params:scim:schemas:extension:egencia:2.0:User[companyId eq \"{companyId}\"]"},"Search Users By Email":{"description":"Replace {email} by the email you want to search.","value":"emails[value eq \"{email}\"]"},"Search Users By Email and Company":{"description":"Replace {email} by the email and {companyId} by the egencia company Id you want to search.","value":"emails[value eq \"{email}\"] and urn:ietf:params:scim:schemas:extension:egencia:2.0:User[companyId eq \"{companyId}\"]"},"Search Users By Name":{"description":"Replace {givenName} by the first name of the user and {familyName} by the last name of the user you want to search.","value":"name[givenName eq \"{givenName}\" and familyName eq \"{familyName}\"]"},"Search Users By Name and Company":{"description":"Replace {givenName} by the first name of the user, {familyName} by the last name of the user and {companyId} by the egencia company Id you want to search.","value":"name[givenName eq \"{givenName}\" and familyName eq \"{familyName}\"] and urn:ietf:params:scim:schemas:extension:egencia:2.0:User[companyId eq \"{companyId}\"]"},"Search Users By No Filter":{"description":"No need to pass anything in filter."},"Search Users By Single Sign On Id":{"description":"Replace {singleSignOnId} by the single sing on Id you want to search.","value":"urn:ietf:params:scim:schemas:extension:egencia:2.0:User:singleSignOnId eq \"{singleSignOnId}\""},"Search Users By Single Sign On Id and Company":{"description":"Replace {singleSignOnId} by the single sign on Id and {companyId} by the egencia company Id you want to search.","value":"urn:ietf:params:scim:schemas:extension:egencia:2.0:User:singleSignOnId eq \"{singleSignOnId}\" and urn:ietf:params:scim:schemas:extension:egencia:2.0:User:companyId eq \"{companyId}\""},"Search Users By Username":{"description":"Replace {userName} by the username you want to search.","value":"userName eq \"{userName}\""},"Search Users By Username and Company":{"description":"Replace {userName} by the username and {companyId} by the egencia company Id you want to search.","value":"userName eq \"{userName}\" and urn:ietf:params:scim:schemas:extension:egencia:2.0:User[companyId eq \"{companyId}\"]"}},"in":"query","name":"filter","required":false,"schema":{"type":"string"}},{"description":"1-based start index","in":"query","name":"startIndex","required":false,"schema":{"type":"integer","format":"int32","default":1,"exclusiveMinimum":0}},{"description":"Number of resources to be returned. Maximum supported value is 100","in":"query","name":"count","required":false,"schema":{"type":"integer","format":"int32","default":20,"exclusiveMinimum":0,"maximum":100}}],"responses":{"200":{"content":{"application/scim+json":{"example":{"schemas":["urn:ietf:params:scim:api:messages:2.0:ListResponse"],"itemsPerPage":1,"startIndex":1,"totalResults":1,"Resources":[{"schemas":["urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:extension:egencia:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"],"meta":{"created":"2024-07-17T00:00:00.000Z","lastModified":"2024-07-17T00:00:00.000Z","location":"{baseUrl}/openconnect/api/scim/v3/Users/12345"},"id":"egenciaUniqueIdentifier","externalId":"externalSystemIdentifier","userName":"test@example.com","name":{"familyName":"User","formatted":"","givenName":"Test","middleName":"","honorificPrefix":"Mr."},"userType":"NORMAL","preferredLanguage":"en","active":true,"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"employeeNumber":"testEmployeeNumberValue"},"urn:ietf:params:scim:schemas:extension:egencia:2.0:User":{"approvers":{"level1Approvers":[{"id":"4567"}],"level2Approvers":[{"id":"4567"}],"delegateApprovers":[{"id":"123"}]},"arrangerGroups":["arrangerGroup1"],"arrangers":[{"id":"5678"},{"userName":"testarranger1"}],"companyId":"egenciaCompanyId","customDataFields":[{"name":"Primary cost center","value":"Test cost center"}],"dateOfBirth":"1989-01-01","documents":[{"expirationDate":"2031-10-10","issueCountry":"US","issueDate":"2020-10-10","issueLocation":"city","type":"PAS","value":"ABCDE1234"}],"loyaltyPrograms":[{"issuingSupplierCode":"T4","lob":"HOTEL","name":"S-Card","type":"LC","validFrom":"2021-10-10","validTo":"2025-10-10","value":"S12345"}],"preferences":[{"lob":"AIR","mealType":"178","preferredDepartureAirport":"","seatType":"1","specialRequest":"Any special requests"},{"lob":"RAIL","seatDirection":"Forward","seatRoom":"Lower","seatSolo":true,"seatType":"1"},{"lob":"HOTEL","smoking":"Smoking","specialRequest":"Any special requests"},{"lob":"CAR","specialRequest":"Any special requests"}],"serviceLevelIds":["12345"],"settings":{"notifications":{"reservationEmail":"validReservationEmailValue"}},"singleSignOnId":"singleSignOnIdValue","userAuthenticationMode":"SSO"},"emails":[{"primary":true,"type":"WORK","value":"test@abc.com"}],"phoneNumbers":[{"primary":true,"type":"WORK","value":"+44-1234512345"}],"addresses":[{"country":"GB","formatted":"address line 1, cityname, state, GB, 123212","locality":"city name","postalCode":"123212","region":"region or state","streetAddress":"address line 1","type":"WORK"}],"groups":[{"display":"displayName","value":"travelerGroup"}],"roles":["SELF_BOOKER"]}]}}},"description":"Search api success."},"400":{"content":{"application/scim+json":{"example":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"detail":"Invalid parameters","status":"400"}}},"description":"Bad Request : Invalid input or request"},"401":{"content":{"application/scim+json":{"example":{"error":{"code":"EGE-ER-4001","message":"Unauthorised access, you do not have sufficient permissions to perform this action."}}}},"description":"Unauthorized : Authentication token empty, invalid or expired."},"403":{"content":{"application/scim+json":{"example":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"detail":"Unauthorised access, you do not have sufficient permissions to perform this action. Contact your admin.","status":"403"}}},"description":"Forbidden : User not Validated for operation."},"422":{"content":{"application/scim+json":{"example":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"detail":"Invalid or missing parameters encountered, we are unable to process your request.","status":"422","data":[{"attribute":"userName","message":"userName needs to be specified and cannot be empty or null"}]}}},"description":"Invalid input : Invalid or missing required input."},"500":{"content":{"application/scim+json":{"example":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"detail":"Your request could not be completed due to some error. Please try again later.","status":"500","data":[{"attribute":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User.loyaltyPrograms","message":"Error occurred while processing loyalty program associations."}]}}},"description":"Internal Server Error : Unable to process request."},"503":{"content":{"application/scim+json":{"example":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"detail":"We are unable to process your request right now. Please try again later.","status":"503","data":[]}}},"description":"Service unavailable : Unable to process request at the moment."}},"security":[{"OAuth2":[]}],"summary":"Return list of users based on the filter condition.","tags":["SCIM User Sync V3"]},"post":{"operationId":"createUser","requestBody":{"content":{"application/json":{"examples":{"Create user with basic and extension attributes":{"description":"Create user with basic and extension attributes","value":{"schemas":["urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:extension:egencia:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"],"userName":"test@egencia.com","name":{"familyName":"User","givenName":"Test","middleName":"I","formatted":"Test I User","honorificPrefix":"Mr."},"userType":"NORMAL","preferredLanguage":"en","active":true,"emails":[{"type":"WORK","value":"test@egencia.com","primary":true}],"phoneNumbers":[{"type":"MOBILE","value":"+14254204087"}],"addresses":[{"type":"HOME","streetAddress":"1415 140TH AVE NE APT 15","locality":"Bellevue","region":"WA","postalCode":"98005","country":"US","formatted":"1415 140TH AVE NE APT 15"}],"groups":[{"value":"General"}],"roles":["SELF_BOOKER"],"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"employeeNumber":"testEmployeeNumberValue"}}},"Create user with basic attributes":{"description":"Create user with basic attributes","value":{"schemas":["urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:extension:egencia:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"],"userName":"test@egencia.com","name":{"familyName":"User","givenName":"Test","middleName":"I","formatted":"Test I User","honorificPrefix":"Mr."},"userType":"NORMAL","preferredLanguage":"en","active":true,"emails":[{"type":"WORK","value":"test@egencia.com","primary":true}],"phoneNumbers":[{"type":"MOBILE","value":"+14254204087"}],"addresses":[{"type":"HOME","streetAddress":"1415 140TH AVE NE APT 15","locality":"Bellevue","region":"WA","postalCode":"98005","country":"US","formatted":"1415 140TH AVE NE APT 15"}],"groups":[{"value":"General"}],"roles":["SELF_BOOKER"]}},"Create user with basic, extension and egencia extension attributes":{"description":"Create user with basic, extension and egencia extension attributes","value":{"schemas":["urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:extension:egencia:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"],"userName":"test@egencia.com","name":{"familyName":"User","givenName":"Test","middleName":"I","formatted":"Test I User","honorificPrefix":"Mr."},"userType":"NORMAL","preferredLanguage":"en","active":true,"emails":[{"type":"WORK","value":"test@egencia.com","primary":true}],"phoneNumbers":[{"type":"MOBILE","value":"+14254204087"}],"addresses":[{"type":"HOME","streetAddress":"1415 140TH AVE NE APT 15","locality":"Bellevue","region":"WA","postalCode":"98005","country":"US","formatted":"1415 140TH AVE NE APT 15"}],"groups":[{"value":"General"}],"roles":["SELF_BOOKER"],"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"employeeNumber":"testEmployeeNumberValue"},"urn:ietf:params:scim:schemas:extension:egencia:2.0:User":{"approvers":{"level1Approvers":[{"userName":"approverone@egencia.com"}],"level2Approvers":[{"userName":"approvertwo@egencia.com"}],"delegateApprovers":[{"userName":"approver@egencia.com"}]},"arrangerGroups":["arrangerGroup1"],"arrangers":[{"id":"56789"}],"companyId":"egenciaCompanyId","customDataFields":[{"name":"Cdf Name","value":"Cdf Value"}],"dateOfBirth":"1988-01-01","documents":[{"expirationDate":"2030-10-10","issueCountry":"US","issueDate":"2020-10-10","issueLocation":"city","type":"PAS","value":"ABCDE1234"}],"loyaltyPrograms":[{"issuingSupplierCode":"T4","lob":"HOTEL","name":"S-Card","type":"LC","validFrom":"2020-10-10","validTo":"2025-10-10","value":"S12345"}],"preferences":[{"lob":"AIR","mealType":"178","preferredDepartureAirport":"","seatType":"1","specialRequest":"Any special request"},{"lob":"RAIL","seatDirection":"Forward","seatRoom":"Lower","seatSolo":true,"seatType":"1"},{"lob":"HOTEL","smoking":"Smoking","specialRequest":"Any special request"},{"lob":"CAR","specialRequest":"Any special request"}],"serviceLevelIds":["123"],"settings":{"notifications":{"reservationEmail":"validReservationEmailValue"}},"singleSignOnId":"api.sample@egencia.com","userAuthenticationMode":"SSO"}}},"Create user with minimal attributes":{"description":"Create user with minimal attributes","value":{"schemas":["urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:extension:egencia:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"],"userName":"test@egencia.com","name":{"familyName":"User","givenName":"Test","middleName":""},"userType":"NORMAL","active":true,"emails":[{"type":"WORK","value":"test@egencia.com","primary":true}],"addresses":[{"type":"HOME","streetAddress":"1415 140TH AVE NE APT 15","locality":"Bellevue","region":"WA","postalCode":"98005","country":"US","formatted":"1415 140TH AVE NE APT 15"}]}}},"schema":{"$ref":"#/components/schemas/UserSchemaV2"}},"application/scim+json":{"examples":{"Create user with basic and extension attributes":{"description":"Create user with basic and extension attributes","value":{"schemas":["urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:extension:egencia:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"],"userName":"test@egencia.com","name":{"familyName":"User","givenName":"Test","middleName":"I","formatted":"Test I User","honorificPrefix":"Mr."},"userType":"NORMAL","preferredLanguage":"en","active":true,"emails":[{"type":"WORK","value":"test@egencia.com","primary":true}],"phoneNumbers":[{"type":"MOBILE","value":"+14254204087"}],"addresses":[{"type":"HOME","streetAddress":"1415 140TH AVE NE APT 15","locality":"Bellevue","region":"WA","postalCode":"98005","country":"US","formatted":"1415 140TH AVE NE APT 15"}],"groups":[{"value":"General"}],"roles":["SELF_BOOKER"],"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"employeeNumber":"testEmployeeNumberValue"}}},"Create user with basic attributes":{"description":"Create user with basic attributes","value":{"schemas":["urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:extension:egencia:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"],"userName":"test@egencia.com","name":{"familyName":"User","givenName":"Test","middleName":"I","formatted":"Test I User","honorificPrefix":"Mr."},"userType":"NORMAL","preferredLanguage":"en","active":true,"emails":[{"type":"WORK","value":"test@egencia.com","primary":true}],"phoneNumbers":[{"type":"MOBILE","value":"+14254204087"}],"addresses":[{"type":"HOME","streetAddress":"1415 140TH AVE NE APT 15","locality":"Bellevue","region":"WA","postalCode":"98005","country":"US","formatted":"1415 140TH AVE NE APT 15"}],"groups":[{"value":"General"}],"roles":["SELF_BOOKER"]}},"Create user with basic, extension and egencia extension attributes":{"description":"Create user with basic, extension and egencia extension attributes","value":{"schemas":["urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:extension:egencia:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"],"userName":"test@egencia.com","name":{"familyName":"User","givenName":"Test","middleName":"I","formatted":"Test I User","honorificPrefix":"Mr."},"userType":"NORMAL","preferredLanguage":"en","active":true,"emails":[{"type":"WORK","value":"test@egencia.com","primary":true}],"phoneNumbers":[{"type":"MOBILE","value":"+14254204087"}],"addresses":[{"type":"HOME","streetAddress":"1415 140TH AVE NE APT 15","locality":"Bellevue","region":"WA","postalCode":"98005","country":"US","formatted":"1415 140TH AVE NE APT 15"}],"groups":[{"value":"General"}],"roles":["SELF_BOOKER"],"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"employeeNumber":"testEmployeeNumberValue"},"urn:ietf:params:scim:schemas:extension:egencia:2.0:User":{"approvers":{"level1Approvers":[{"userName":"approverone@egencia.com"}],"level2Approvers":[{"userName":"approvertwo@egencia.com"}],"delegateApprovers":[{"userName":"approver@egencia.com"}]},"arrangerGroups":["arrangerGroup1"],"arrangers":[{"id":"56789"}],"companyId":"egenciaCompanyId","customDataFields":[{"name":"Cdf Name","value":"Cdf Value"}],"dateOfBirth":"1988-01-01","documents":[{"expirationDate":"2030-10-10","issueCountry":"US","issueDate":"2020-10-10","issueLocation":"city","type":"PAS","value":"ABCDE1234"}],"loyaltyPrograms":[{"issuingSupplierCode":"T4","lob":"HOTEL","name":"S-Card","type":"LC","validFrom":"2020-10-10","validTo":"2025-10-10","value":"S12345"}],"preferences":[{"lob":"AIR","mealType":"178","preferredDepartureAirport":"","seatType":"1","specialRequest":"Any special request"},{"lob":"RAIL","seatDirection":"Forward","seatRoom":"Lower","seatSolo":true,"seatType":"1"},{"lob":"HOTEL","smoking":"Smoking","specialRequest":"Any special request"},{"lob":"CAR","specialRequest":"Any special request"}],"serviceLevelIds":["123"],"settings":{"notifications":{"reservationEmail":"validReservationEmailValue"}},"singleSignOnId":"api.sample@egencia.com","userAuthenticationMode":"SSO"}}},"Create user with minimal attributes":{"description":"Create user with minimal attributes","value":{"schemas":["urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:extension:egencia:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"],"userName":"test@egencia.com","name":{"familyName":"User","givenName":"Test","middleName":""},"userType":"NORMAL","active":true,"emails":[{"type":"WORK","value":"test@egencia.com","primary":true}],"addresses":[{"type":"HOME","streetAddress":"1415 140TH AVE NE APT 15","locality":"Bellevue","region":"WA","postalCode":"98005","country":"US","formatted":"1415 140TH AVE NE APT 15"}]}}},"schema":{"$ref":"#/components/schemas/UserSchemaV2"}}},"description":"User Schema to be created","required":true},"responses":{"201":{"content":{"application/scim+json":{"example":{"schemas":["urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:extension:egencia:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"],"meta":{"created":"2024-07-17T00:00:00.000Z","lastModified":"2024-07-17T00:00:00.000Z","location":"{baseUrl}/openconnect/api/scim/v3/Users/egenciaUniqueIdentifier"},"id":"egenciaUniqueIdentifier","userName":"test@egencia.com","name":{"familyName":"User","givenName":"Test","middleName":"I","formatted":"Test I User","honorificPrefix":"Mr."},"userType":"NORMAL","preferredLanguage":"en","active":true,"emails":[{"type":"WORK","value":"test@egencia.com","primary":true}],"phoneNumbers":[{"type":"MOBILE","value":"+14254204087"}],"addresses":[{"type":"HOME","streetAddress":"1415 140TH AVE NE APT 15","locality":"Bellevue","region":"WA","postalCode":"98005","country":"US","formatted":"1415 140TH AVE NE APT 15"}],"groups":[{"value":"General"}],"roles":["SELF_BOOKER"],"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"employeeNumber":"testEmployeeNumberValue"},"urn:ietf:params:scim:schemas:extension:egencia:2.0:User":{"approvers":{"level1Approvers":[{"userName":"approverone@egencia.com"}],"level2Approvers":[{"userName":"approvertwo@egencia.com"}],"delegateApprovers":[{"userName":"approver@egencia.com"}]},"arrangerGroups":["arrangerGroup1"],"arrangers":[{"id":"56789"}],"companyId":"egenciaCompanyId","customDataFields":[{"name":"Cdf Name","value":"Cdf Value"}],"dateOfBirth":"1988-01-01","documents":[{"expirationDate":"2030-10-10","issueCountry":"US","issueDate":"2020-10-10","issueLocation":"city","type":"PAS","value":"ABCDE1234"}],"loyaltyPrograms":[{"issuingSupplierCode":"T4","lob":"HOTEL","name":"S-Card","type":"LC","validFrom":"2020-10-10","validTo":"2025-10-10","value":"S12345"}],"preferences":[{"lob":"AIR","mealType":"178","preferredDepartureAirport":"","seatType":"1","specialRequest":"Any special request"},{"lob":"RAIL","seatDirection":"Forward","seatRoom":"Lower","seatSolo":true,"seatType":"1"},{"lob":"HOTEL","smoking":"Smoking","specialRequest":"Any special request"},{"lob":"CAR","specialRequest":"Any special request"}],"serviceLevelIds":["123"],"settings":{"notifications":{"reservationEmail":"validReservationEmailValue"}},"singleSignOnId":"api.sample@egencia.com","userAuthenticationMode":"SSO"}}}},"description":"Created."},"400":{"content":{"application/scim+json":{"example":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"detail":"Invalid parameters","status":"400"}}},"description":"Bad Request : Invalid input or request"},"401":{"content":{"application/scim+json":{"example":{"error":{"code":"EGE-ER-4001","message":"Unauthorised access, you do not have sufficient permissions to perform this action."}}}},"description":"Unauthorized : Authentication token empty, invalid or expired."},"403":{"content":{"application/scim+json":{"example":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"detail":"Unauthorised access, you do not have sufficient permissions to perform this action. Contact your admin.","status":"403"}}},"description":"Forbidden : User not Validated for operation."},"409":{"content":{"application/scim+json":{"example":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"detail":"Invalid or missing parameters encountered, we are unable to process your request.","status":"409","data":[{"attribute":"userName","message":"Username already exists."}]}}},"description":"Conflict : User already exists."},"422":{"content":{"application/scim+json":{"example":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"detail":"Invalid or missing parameters encountered, we are unable to process your request.","status":"422","data":[{"attribute":"userName","message":"userName needs to be specified and cannot be empty or null"}]}}},"description":"Invalid input : Invalid or missing required input."},"500":{"content":{"application/scim+json":{"example":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"detail":"Your request could not be completed due to some error. Please try again later.","status":"500","data":[{"attribute":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User.loyaltyPrograms","message":"Error occurred while processing loyalty program associations."}]}}},"description":"Internal Server Error : Unable to process request."},"503":{"content":{"application/scim+json":{"example":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"detail":"We are unable to process your request right now. Please try again later.","status":"503","data":[]}}},"description":"Service unavailable : Unable to process request at the moment."}},"security":[{"OAuth2":[]}],"summary":"Create a new user in the system with the requested information.","tags":["SCIM User Sync V3"]}},"/scim/v3/Users/{userId}":{"delete":{"description":"Delete the user with the given user Id in the path
\nRequest Parameters
\n| \n Attribute\n | \n\n Type\n | \n\n Description\n | \n
|---|---|---|
| userId | \nString | \nUser Id of the user to be deleted | \n
Examples:
\nReplace {baseUrl} with the actual value of Egencia APIs host. Please refer Base Urls section under API Overview page of Egencia Developer Center.
\nDeleting a user with user Id : test_user_id
\n\n \n DELETE {baseUrl}/openconnect/api/scim/v3/Users/test_user_id\n Response:\n -> 204 No Content\n \n\n","operationId":"deleteUserUser","parameters":[{"description":"User Id of the user to be deleted","in":"path","name":"userId","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content."},"401":{"content":{"application/scim+json":{"example":{"error":{"code":"EGE-ER-4001","message":"Unauthorised access, you do not have sufficient permissions to perform this action."}}}},"description":"Unauthorized : Authentication token empty, invalid or expired."},"403":{"content":{"application/scim+json":{"example":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"detail":"Unauthorised access, you do not have sufficient permissions to perform this action. Contact your admin.","status":"403"}}},"description":"Forbidden : User not Validated for operation."},"404":{"content":{"application/scim+json":{"example":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"detail":"User not found, you are trying to access an invalid or non existent user.","status":"404","data":[{"attribute":"id","message":"Requested user identifier is invalid."}]}}},"description":"Not Found : Resource Not Found."},"422":{"content":{"application/scim+json":{"example":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"detail":"We are unable to process the request due to missing mandatory or invalid parameters.","status":"422","data":[{"attribute":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User.documents","message":"One or more invalid user documents are supplied."},{"attribute":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User.preferences","message":"One or more invalid user preferences are supplied."}]}}},"description":"Invalid input : Invalid or missing required input."},"500":{"content":{"application/scim+json":{"example":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"detail":"Your request could not be completed due to some error. Please try again later.","status":"500","data":[{"attribute":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User.loyaltyPrograms","message":"Error occurred while processing loyalty program associations."}]}}},"description":"Internal Server Error : Unable to process request."},"503":{"content":{"application/scim+json":{"example":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"detail":"We are unable to process your request right now. Please try again later.","status":"503","data":[]}}},"description":"Service unavailable : Unable to process request at the moment."}},"security":[{"OAuth2":[]}],"summary":"Delete the user in the system with the given user Id.","tags":["SCIM User Sync V3"]},"get":{"operationId":"getUser","parameters":[{"description":"Id of the user to be retrieved","in":"path","name":"userId","required":true,"schema":{"type":"string"}},{"in":"query","name":"attributes","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"content":{"application/scim+json":{"example":{"schemas":["urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:extension:egencia:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"],"meta":{"created":"2024-07-17T00:00:00.000Z","lastModified":"2024-07-17T00:00:00.000Z","location":"{baseUrl}/openconnect/api/scim/v3/Users/12345"},"id":"egenciaUniqueIdentifier","externalId":"externalSystemIdentifier","userName":"test@example.com","name":{"familyName":"User","formatted":"","givenName":"Test","middleName":"","honorificPrefix":"Mr."},"userType":"NORMAL","preferredLanguage":"en","active":true,"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"employeeNumber":"employeeNumberValue"},"urn:ietf:params:scim:schemas:extension:egencia:2.0:User":{"approvers":{"level1Approvers":[{"id":"45678"}],"level2Approvers":[{"id":"45678"}],"delegateApprovers":[{"id":"123"}]},"arrangerGroups":["arrangerGroup1"],"arrangers":[{"id":"56789"},{"userName":"testarranger"}],"companyId":"egenciaCompanyId","customDataFields":[{"name":"Primary cost center","value":"Test cost center"}],"dateOfBirth":"1988-01-01","documents":[{"expirationDate":"2030-10-10","issueCountry":"US","issueDate":"2020-10-10","issueLocation":"city","type":"PAS","value":"ABCDE1234"}],"loyaltyPrograms":[{"issuingSupplierCode":"T4","lob":"HOTEL","name":"S-Card","type":"LC","validFrom":"2020-10-10","validTo":"2025-10-10","value":"S12345"}],"preferences":[{"lob":"AIR","mealType":"178","preferredDepartureAirport":"","seatType":"1","specialRequest":"Any special request"},{"lob":"RAIL","seatDirection":"Forward","seatRoom":"Lower","seatSolo":true,"seatType":"1"},{"lob":"HOTEL","smoking":"Smoking","specialRequest":"Any special request"},{"lob":"CAR","specialRequest":"Any special request"}],"serviceLevelIds":["12345"],"settings":{"notifications":{"reservationEmail":"validReservationEmailValue"}},"singleSignOnId":"singleSignOnIdValue","userAuthenticationMode":"SSO","subscribedCompanyIds":["63062","62366","63065"]},"emails":[{"primary":true,"type":"WORK","value":"test@example.com"}],"phoneNumbers":[{"primary":true,"type":"WORK","value":"+44-1234512345"}],"addresses":[{"country":"GB","formatted":"address line 1, cityname, state, GB, 123212","locality":"city name","postalCode":"123212","region":"region or state","streetAddress":"address line 1","type":"WORK"}],"groups":[{"display":"displayName","value":"travelerGroup"}],"roles":["SELF_BOOKER"]}}},"description":"Found."},"400":{"content":{"application/scim+json":{"example":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"detail":"Invalid parameters","status":"400"}}},"description":"Bad Request : Invalid input or request"},"401":{"content":{"application/scim+json":{"example":{"error":{"code":"EGE-ER-4001","message":"Unauthorised access, you do not have sufficient permissions to perform this action."}}}},"description":"Unauthorized : Authentication token empty, invalid or expired."},"403":{"content":{"application/scim+json":{"example":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"detail":"Unauthorised access, you do not have sufficient permissions to perform this action. Contact your admin.","status":"403"}}},"description":"Forbidden : User not Validated for operation."},"404":{"content":{"application/scim+json":{"example":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"detail":"User not found, you are trying to access an invalid or non existent user.","status":"404","data":[{"attribute":"id","message":"Requested user identifier is invalid."}]}}},"description":"Not Found : Resource Not Found."},"422":{"content":{"application/scim+json":{"example":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"detail":"Invalid or missing parameters encountered, we are unable to process your request.","status":"422","data":[{"attribute":"userName","message":"userName needs to be specified and cannot be empty or null"}]}}},"description":"Invalid input : Invalid or missing required input."},"500":{"content":{"application/scim+json":{"example":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"detail":"Your request could not be completed due to some error. Please try again later.","status":"500","data":[{"attribute":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User.loyaltyPrograms","message":"Error occurred while processing loyalty program associations."}]}}},"description":"Internal Server Error : Unable to process request."},"503":{"content":{"application/scim+json":{"example":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"detail":"We are unable to process your request right now. Please try again later.","status":"503","data":[]}}},"description":"Service unavailable : Unable to process request at the moment."}},"security":[{"OAuth2":[]}],"summary":"Retrieves the user details for a requested user identifier.","tags":["SCIM User Sync V3"]},"patch":{"operationId":"patchUser","parameters":[{"description":"Id of the user to be updated","in":"path","name":"userId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"Request to add a new arranger to the existing arrangers":{"description":"Request to add a new arranger to the existing arrangers","value":{"schemas":["urn:ietf:params:scim:api:messages:2.0:PatchOp"],"Operations":[{"op":"add","path":"urn:ietf:params:scim:schemas:extension:egencia:2.0:User:arrangers","value":[{"id":"id","userName":"api.sample@egencia.com"}]}]}},"Request to add a new custom data field to the existing custom data field list:":{"description":"Request to add a new custom data field to the existing custom data field list:","value":{"schemas":["urn:ietf:params:scim:api:messages:2.0:PatchOp"],"Operations":[{"op":"add","path":"urn:ietf:params:scim:schemas:extension:egencia:2.0:User:customDataFields","value":[{"name":"CDF label","value":"CDF value"}]}]}},"Request to add a new level 1 approver to the existing level1Approvers list":{"description":"Request to add a new level 1 approver to the existing level1Approvers list","value":{"schemas":["urn:ietf:params:scim:api:messages:2.0:PatchOp"],"Operations":[{"op":"add","path":"urn:ietf:params:scim:schemas:extension:egencia:2.0:User:approvers.level1Approvers","value":[{"userName":"api.sample@egencia.com"}]}]}},"Request to add a new level 1 as well as level 2 approver to the existing level1Approvers and level2Approvers list":{"description":"Request to add a new level 1 as well as level 2 approver to the existing level1Approvers and level2Approvers list","value":{"schemas":["urn:ietf:params:scim:api:messages:2.0:PatchOp"],"Operations":[{"op":"add","value":{"urn:ietf:params:scim:schemas:extension:egencia:2.0:User":{"approvers":{"level1Approvers":[{"id":"id"}],"level2Approvers":[{"userName":"api.sample@egencia.com"}]}}}}]}},"Request to add a new role to the existing roles":{"description":"Request to add a new role to the existing roles","value":{"schemas":["urn:ietf:params:scim:api:messages:2.0:PatchOp"],"Operations":[{"op":"add","path":"roles","value":["ARRANGER"]}]}},"Request to add/update first name, last name and date of birth":{"description":"Request to add/update first name, last name and date of birth","value":{"schemas":["urn:ietf:params:scim:api:messages:2.0:PatchOp"],"Operations":[{"op":"add","value":{"name":{"givenName":"First Name","familyName":"Last Name"},"urn:ietf:params:scim:schemas:extension:egencia:2.0:User":{"dateOfBirth":"1988-01-26"}}}]}},"Request to add/update status of user":{"description":"Request to add/update status of user","value":{"schemas":["urn:ietf:params:scim:api:messages:2.0:PatchOp"],"Operations":[{"op":"replace","value":{"active":false}}]}},"Request to replace traveler group with a new one.":{"description":"Request to replace traveler group with a new one.","value":{"schemas":["urn:ietf:params:scim:api:messages:2.0:PatchOp"],"Operations":[{"op":"replace","path":"groups","value":[{"value":"General"}]}]}},"Request to update WORK type email, username, ssoId, authentication mode":{"description":"Request to update WORK type email, username, ssoId, authentication mode","value":{"schemas":["urn:ietf:params:scim:api:messages:2.0:PatchOp"],"Operations":[{"op":"replace","path":"emails[type eq \"WORK\"].value","value":"api.sample@egencia.com"},{"op":"add","value":{"userName":"api.sample@egencia.com","urn:ietf:params:scim:schemas:extension:egencia:2.0:User":{"singleSignOnId":"api.sample@egencia.com","userAuthenticationMode":"SSO"}}}]}},"Request with multiple patch operations":{"description":"Request with multiple patch operations","value":{"schemas":["urn:ietf:params:scim:api:messages:2.0:PatchOp"],"Operations":[{"op":"add","path":"urn:ietf:params:scim:schemas:extension:egencia:2.0:User:customDataFields","value":[{"name":"ff test","value":"ff test value"},{"name":"Test CDF","value":"Test CDF"}]},{"op":"add","path":"urn:ietf:params:scim:schemas:extension:egencia:2.0:User:companyId","value":"23"},{"op":"add","value":{"userName":"abcd","name":{"givenName":"Abcd"},"urn:ietf:params:scim:schemas:extension:egencia:2.0:User":{"companyId":"23"}}},{"op":"replace","path":"addresses[type eq \"HOME\"].streetAddress","value":"1010 Broadway Ave"},{"op":"replace","path":"addresses[type eq \"HOME\"]","value":{"streetAddress":"911 Universal City Plaza","locality":"Hollywood","region":"CA","postalCode":"91608","country":"USA","formatted":"911 Universal City Plaza\nHollywood, CA 91608 US"}},{"op":"replace","value":{"emails":[{"value":"test@example.com","type":"WORK","primary":true}]}},{"op":"replace","value":{"phoneNumbers":[{"value":"+91-9999999999","type":"HOME","primary":true}]}},{"op":"add","path":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber","value":"11111"}]}}},"schema":{"$ref":"#/components/schemas/ScimPatchSchema"}},"application/scim+json":{"examples":{"Request to add a new arranger to the existing arrangers":{"description":"Request to add a new arranger to the existing arrangers","value":{"schemas":["urn:ietf:params:scim:api:messages:2.0:PatchOp"],"Operations":[{"op":"add","path":"urn:ietf:params:scim:schemas:extension:egencia:2.0:User:arrangers","value":[{"id":"id","userName":"api.sample@egencia.com"}]}]}},"Request to add a new custom data field to the existing custom data field list:":{"description":"Request to add a new custom data field to the existing custom data field list:","value":{"schemas":["urn:ietf:params:scim:api:messages:2.0:PatchOp"],"Operations":[{"op":"add","path":"urn:ietf:params:scim:schemas:extension:egencia:2.0:User:customDataFields","value":[{"name":"CDF label","value":"CDF value"}]}]}},"Request to add a new level 1 approver to the existing level1Approvers list":{"description":"Request to add a new level 1 approver to the existing level1Approvers list","value":{"schemas":["urn:ietf:params:scim:api:messages:2.0:PatchOp"],"Operations":[{"op":"add","path":"urn:ietf:params:scim:schemas:extension:egencia:2.0:User:approvers.level1Approvers","value":[{"userName":"api.sample@egencia.com"}]}]}},"Request to add a new level 1 as well as level 2 approver to the existing level1Approvers and level2Approvers list":{"description":"Request to add a new level 1 as well as level 2 approver to the existing level1Approvers and level2Approvers list","value":{"schemas":["urn:ietf:params:scim:api:messages:2.0:PatchOp"],"Operations":[{"op":"add","value":{"urn:ietf:params:scim:schemas:extension:egencia:2.0:User":{"approvers":{"level1Approvers":[{"id":"id"}],"level2Approvers":[{"userName":"api.sample@egencia.com"}]}}}}]}},"Request to add a new role to the existing roles":{"description":"Request to add a new role to the existing roles","value":{"schemas":["urn:ietf:params:scim:api:messages:2.0:PatchOp"],"Operations":[{"op":"add","path":"roles","value":["ARRANGER"]}]}},"Request to add/update first name, last name and date of birth":{"description":"Request to add/update first name, last name and date of birth","value":{"schemas":["urn:ietf:params:scim:api:messages:2.0:PatchOp"],"Operations":[{"op":"add","value":{"name":{"givenName":"First Name","familyName":"Last Name"},"urn:ietf:params:scim:schemas:extension:egencia:2.0:User":{"dateOfBirth":"1988-01-26"}}}]}},"Request to add/update status of user":{"description":"Request to add/update status of user","value":{"schemas":["urn:ietf:params:scim:api:messages:2.0:PatchOp"],"Operations":[{"op":"replace","value":{"active":false}}]}},"Request to replace traveler group with a new one.":{"description":"Request to replace traveler group with a new one.","value":{"schemas":["urn:ietf:params:scim:api:messages:2.0:PatchOp"],"Operations":[{"op":"replace","path":"groups","value":[{"value":"General"}]}]}},"Request to update WORK type email, username, ssoId, authentication mode":{"description":"Request to update WORK type email, username, ssoId, authentication mode","value":{"schemas":["urn:ietf:params:scim:api:messages:2.0:PatchOp"],"Operations":[{"op":"replace","path":"emails[type eq \"WORK\"].value","value":"api.sample@egencia.com"},{"op":"add","value":{"userName":"api.sample@egencia.com","urn:ietf:params:scim:schemas:extension:egencia:2.0:User":{"singleSignOnId":"api.sample@egencia.com","userAuthenticationMode":"SSO"}}}]}},"Request with multiple patch operations":{"description":"Request with multiple patch operations","value":{"schemas":["urn:ietf:params:scim:api:messages:2.0:PatchOp"],"Operations":[{"op":"add","path":"urn:ietf:params:scim:schemas:extension:egencia:2.0:User:customDataFields","value":[{"name":"ff test","value":"ff test value"},{"name":"Test CDF","value":"Test CDF"}]},{"op":"add","path":"urn:ietf:params:scim:schemas:extension:egencia:2.0:User:companyId","value":"23"},{"op":"add","value":{"userName":"abcd","name":{"givenName":"Abcd"},"urn:ietf:params:scim:schemas:extension:egencia:2.0:User":{"companyId":"23"}}},{"op":"replace","path":"addresses[type eq \"HOME\"].streetAddress","value":"1010 Broadway Ave"},{"op":"replace","path":"addresses[type eq \"HOME\"]","value":{"streetAddress":"911 Universal City Plaza","locality":"Hollywood","region":"CA","postalCode":"91608","country":"USA","formatted":"911 Universal City Plaza\nHollywood, CA 91608 US"}},{"op":"replace","value":{"emails":[{"value":"test@example.com","type":"WORK","primary":true}]}},{"op":"replace","value":{"phoneNumbers":[{"value":"+91-9999999999","type":"HOME","primary":true}]}},{"op":"add","path":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber","value":"11111"}]}}},"schema":{"$ref":"#/components/schemas/ScimPatchSchema"}}},"description":"SCIM compliant patch operation schema","required":true},"responses":{"200":{"content":{"application/scim+json":{"example":{"schemas":["urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:extension:egencia:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"],"meta":{"created":"2024-07-17T00:00:00.000Z","lastModified":"2024-07-17T00:00:00.000Z","location":"{baseUrl}/openconnect/api/scim/v3/Users/12345"},"id":"egenciaUniqueIdentifier","externalId":"externalSystemIdentifier","userName":"test@example.com","name":{"familyName":"User","formatted":"","givenName":"Test","middleName":"","honorificPrefix":"Mr."},"userType":"NORMAL","preferredLanguage":"en","active":true,"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"employeeNumber":"employeeNumberValue"},"urn:ietf:params:scim:schemas:extension:egencia:2.0:User":{"approvers":{"level1Approvers":[{"id":"45678"}],"level2Approvers":[{"id":"45678"}],"delegateApprovers":[{"id":"123"}]},"arrangerGroups":["arrangerGroup1"],"arrangers":[{"id":"56789"},{"userName":"testarranger"}],"companyId":"egenciaCompanyId","customDataFields":[{"name":"Primary cost center","value":"Test cost center"}],"dateOfBirth":"1988-01-01","documents":[{"expirationDate":"2030-10-10","issueCountry":"US","issueDate":"2020-10-10","issueLocation":"city","type":"PAS","value":"ABCDE1234"}],"loyaltyPrograms":[{"issuingSupplierCode":"T4","lob":"HOTEL","name":"S-Card","type":"LC","validFrom":"2020-10-10","validTo":"2025-10-10","value":"S12345"}],"preferences":[{"lob":"AIR","mealType":"178","preferredDepartureAirport":"","seatType":"1","specialRequest":"Any special request"},{"lob":"RAIL","seatDirection":"Forward","seatRoom":"Lower","seatSolo":true,"seatType":"1"},{"lob":"HOTEL","smoking":"Smoking","specialRequest":"Any special request"},{"lob":"CAR","specialRequest":"Any special request"}],"serviceLevelIds":["12345"],"settings":{"notifications":{"reservationEmail":"validReservationEmailValue"}},"singleSignOnId":"singleSignOnIdValue","userAuthenticationMode":"SSO","subscribedCompanyIds":["63062","62366","63065"]},"emails":[{"primary":true,"type":"WORK","value":"test@example.com"}],"phoneNumbers":[{"primary":true,"type":"WORK","value":"+44-1234512345"}],"addresses":[{"country":"GB","formatted":"address line 1, cityname, state, GB, 123212","locality":"city name","postalCode":"123212","region":"region or state","streetAddress":"address line 1","type":"WORK"}],"groups":[{"display":"displayName","value":"travelerGroup"}],"roles":["SELF_BOOKER"]}}},"description":"Patch api success"},"400":{"content":{"application/scim+json":{"example":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"detail":"Invalid parameters","status":"400"}}},"description":"Bad Request : Invalid input or request"},"401":{"content":{"application/scim+json":{"example":{"error":{"code":"EGE-ER-4001","message":"Unauthorised access, you do not have sufficient permissions to perform this action."}}}},"description":"Unauthorized : Authentication token empty, invalid or expired."},"403":{"content":{"application/scim+json":{"example":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"detail":"Unauthorised access, you do not have sufficient permissions to perform this action. Contact your admin.","status":"403"}}},"description":"Forbidden : User not Validated for operation."},"404":{"content":{"application/scim+json":{"example":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"detail":"User not found, you are trying to access an invalid or non existent user.","status":"404","data":[{"attribute":"id","message":"Requested user identifier is invalid."}]}}},"description":"Not Found : Resource Not Found."},"422":{"content":{"application/scim+json":{"example":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"detail":"Invalid or missing parameters encountered, we are unable to process your request.","status":"422","data":[{"attribute":"userName","message":"userName needs to be specified and cannot be empty or null"}]}}},"description":"Invalid input : Invalid or missing required input."},"500":{"content":{"application/scim+json":{"example":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"detail":"Your request could not be completed due to some error. Please try again later.","status":"500","data":[{"attribute":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User.loyaltyPrograms","message":"Error occurred while processing loyalty program associations."}]}}},"description":"Internal Server Error : Unable to process request."},"503":{"content":{"application/scim+json":{"example":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"detail":"We are unable to process your request right now. Please try again later.","status":"503","data":[]}}},"description":"Service unavailable : Unable to process request at the moment."}},"security":[{"OAuth2":[]}],"summary":"Perform patch operation on the user with the given user Id.","tags":["SCIM User Sync V3"]},"put":{"operationId":"updateUser","parameters":[{"description":"Id of the user to be updated","in":"path","name":"userId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"Update user with basic and extension attributes":{"description":"Update user with basic and extension attributes","value":{"schemas":["urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:extension:egencia:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"],"id":"egenciaUniqueIdentifier","userName":"test@egencia.com","name":{"familyName":"User","givenName":"Test","middleName":"I","formatted":"Test I User","honorificPrefix":"Mr."},"userType":"NORMAL","preferredLanguage":"en","active":true,"emails":[{"type":"WORK","value":"test@egencia.com","primary":true}],"phoneNumbers":[{"type":"MOBILE","value":"+14254204087"}],"addresses":[{"type":"HOME","streetAddress":"1415 140TH AVE NE APT 15","locality":"Bellevue","region":"WA","postalCode":"98005","country":"US","formatted":"1415 140TH AVE NE APT 15"}],"groups":[{"value":"General"}],"roles":["SELF_BOOKER"],"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"employeeNumber":"testEmployeeNumberValue"}}},"Update user with basic attributes":{"description":"Update user with basic attributes","value":{"schemas":["urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:extension:egencia:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"],"id":"egenciaUniqueIdentifier","userName":"test@egencia.com","name":{"familyName":"User","givenName":"Test","middleName":"I","formatted":"Test I User","honorificPrefix":"Mr."},"userType":"NORMAL","preferredLanguage":"en","active":true,"emails":[{"type":"WORK","value":"test@egencia.com","primary":true}],"phoneNumbers":[{"type":"MOBILE","value":"+14254204087"}],"addresses":[{"type":"HOME","streetAddress":"1415 140TH AVE NE APT 15","locality":"Bellevue","region":"WA","postalCode":"98005","country":"US","formatted":"1415 140TH AVE NE APT 15"}],"groups":[{"value":"General"}],"roles":["SELF_BOOKER"]}},"Update user with basic, extension and egencia extension attributes":{"description":"Update user with basic, extension and egencia extension attributes","value":{"schemas":["urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:extension:egencia:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"],"id":"egenciaUniqueIdentifier","userName":"test@egencia.com","name":{"familyName":"User","givenName":"Test","middleName":"I","formatted":"Test I User","honorificPrefix":"Mr."},"userType":"NORMAL","preferredLanguage":"en","active":true,"emails":[{"type":"WORK","value":"test@egencia.com","primary":true}],"phoneNumbers":[{"type":"MOBILE","value":"+14254204087"}],"addresses":[{"type":"HOME","streetAddress":"1415 140TH AVE NE APT 15","locality":"Bellevue","region":"WA","postalCode":"98005","country":"US","formatted":"1415 140TH AVE NE APT 15"}],"groups":[{"value":"General"}],"roles":["SELF_BOOKER"],"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"employeeNumber":"testEmployeeNumberValue"},"urn:ietf:params:scim:schemas:extension:egencia:2.0:User":{"approvers":{"level1Approvers":[{"userName":"approverone@egencia.com"}],"level2Approvers":[{"userName":"approvertwo@egencia.com"}],"delegateApprovers":[{"userName":"approver@egencia.com"}]},"arrangerGroups":["arrangerGroup1"],"arrangers":[{"id":"56789"}],"companyId":"egenciaCompanyId","customDataFields":[{"name":"Cdf Name","value":"Cdf Value"}],"dateOfBirth":"1988-01-01","documents":[{"expirationDate":"2030-10-10","issueCountry":"US","issueDate":"2020-10-10","issueLocation":"city","type":"PAS","value":"ABCDE1234"}],"loyaltyPrograms":[{"issuingSupplierCode":"T4","lob":"HOTEL","name":"S-Card","type":"LC","validFrom":"2020-10-10","validTo":"2025-10-10","value":"S12345"}],"preferences":[{"lob":"AIR","mealType":"178","preferredDepartureAirport":"","seatType":"1","specialRequest":"Any special request"},{"lob":"RAIL","seatDirection":"Forward","seatRoom":"Lower","seatSolo":true,"seatType":"1"},{"lob":"HOTEL","smoking":"Smoking","specialRequest":"Any special request"},{"lob":"CAR","specialRequest":"Any special request"}],"serviceLevelIds":["123"],"settings":{"notifications":{"reservationEmail":"validReservationEmailValue"}},"singleSignOnId":"api.sample@egencia.com","userAuthenticationMode":"SSO"}}},"Update user with minimal attributes":{"description":"Update user with minimal attributes","value":{"schemas":["urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:extension:egencia:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"],"id":"egenciaUniqueIdentifier","userName":"test@egencia.com","name":{"familyName":"User","givenName":"Test","middleName":""},"userType":"NORMAL","active":true,"emails":[{"type":"WORK","value":"test@egencia.com","primary":true}],"addresses":[{"type":"HOME","streetAddress":"1415 140TH AVE NE APT 15","locality":"Bellevue","region":"WA","postalCode":"98005","country":"US","formatted":"1415 140TH AVE NE APT 15"}]}}},"schema":{"$ref":"#/components/schemas/UserSchemaV2"}},"application/scim+json":{"examples":{"Update user with basic and extension attributes":{"description":"Update user with basic and extension attributes","value":{"schemas":["urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:extension:egencia:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"],"id":"egenciaUniqueIdentifier","userName":"test@egencia.com","name":{"familyName":"User","givenName":"Test","middleName":"I","formatted":"Test I User","honorificPrefix":"Mr."},"userType":"NORMAL","preferredLanguage":"en","active":true,"emails":[{"type":"WORK","value":"test@egencia.com","primary":true}],"phoneNumbers":[{"type":"MOBILE","value":"+14254204087"}],"addresses":[{"type":"HOME","streetAddress":"1415 140TH AVE NE APT 15","locality":"Bellevue","region":"WA","postalCode":"98005","country":"US","formatted":"1415 140TH AVE NE APT 15"}],"groups":[{"value":"General"}],"roles":["SELF_BOOKER"],"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"employeeNumber":"testEmployeeNumberValue"}}},"Update user with basic attributes":{"description":"Update user with basic attributes","value":{"schemas":["urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:extension:egencia:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"],"id":"egenciaUniqueIdentifier","userName":"test@egencia.com","name":{"familyName":"User","givenName":"Test","middleName":"I","formatted":"Test I User","honorificPrefix":"Mr."},"userType":"NORMAL","preferredLanguage":"en","active":true,"emails":[{"type":"WORK","value":"test@egencia.com","primary":true}],"phoneNumbers":[{"type":"MOBILE","value":"+14254204087"}],"addresses":[{"type":"HOME","streetAddress":"1415 140TH AVE NE APT 15","locality":"Bellevue","region":"WA","postalCode":"98005","country":"US","formatted":"1415 140TH AVE NE APT 15"}],"groups":[{"value":"General"}],"roles":["SELF_BOOKER"]}},"Update user with basic, extension and egencia extension attributes":{"description":"Update user with basic, extension and egencia extension attributes","value":{"schemas":["urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:extension:egencia:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"],"id":"egenciaUniqueIdentifier","userName":"test@egencia.com","name":{"familyName":"User","givenName":"Test","middleName":"I","formatted":"Test I User","honorificPrefix":"Mr."},"userType":"NORMAL","preferredLanguage":"en","active":true,"emails":[{"type":"WORK","value":"test@egencia.com","primary":true}],"phoneNumbers":[{"type":"MOBILE","value":"+14254204087"}],"addresses":[{"type":"HOME","streetAddress":"1415 140TH AVE NE APT 15","locality":"Bellevue","region":"WA","postalCode":"98005","country":"US","formatted":"1415 140TH AVE NE APT 15"}],"groups":[{"value":"General"}],"roles":["SELF_BOOKER"],"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"employeeNumber":"testEmployeeNumberValue"},"urn:ietf:params:scim:schemas:extension:egencia:2.0:User":{"approvers":{"level1Approvers":[{"userName":"approverone@egencia.com"}],"level2Approvers":[{"userName":"approvertwo@egencia.com"}],"delegateApprovers":[{"userName":"approver@egencia.com"}]},"arrangerGroups":["arrangerGroup1"],"arrangers":[{"id":"56789"}],"companyId":"egenciaCompanyId","customDataFields":[{"name":"Cdf Name","value":"Cdf Value"}],"dateOfBirth":"1988-01-01","documents":[{"expirationDate":"2030-10-10","issueCountry":"US","issueDate":"2020-10-10","issueLocation":"city","type":"PAS","value":"ABCDE1234"}],"loyaltyPrograms":[{"issuingSupplierCode":"T4","lob":"HOTEL","name":"S-Card","type":"LC","validFrom":"2020-10-10","validTo":"2025-10-10","value":"S12345"}],"preferences":[{"lob":"AIR","mealType":"178","preferredDepartureAirport":"","seatType":"1","specialRequest":"Any special request"},{"lob":"RAIL","seatDirection":"Forward","seatRoom":"Lower","seatSolo":true,"seatType":"1"},{"lob":"HOTEL","smoking":"Smoking","specialRequest":"Any special request"},{"lob":"CAR","specialRequest":"Any special request"}],"serviceLevelIds":["123"],"settings":{"notifications":{"reservationEmail":"validReservationEmailValue"}},"singleSignOnId":"api.sample@egencia.com","userAuthenticationMode":"SSO"}}},"Update user with minimal attributes":{"description":"Update user with minimal attributes","value":{"schemas":["urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:extension:egencia:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"],"id":"egenciaUniqueIdentifier","userName":"test@egencia.com","name":{"familyName":"User","givenName":"Test","middleName":""},"userType":"NORMAL","active":true,"emails":[{"type":"WORK","value":"test@egencia.com","primary":true}],"addresses":[{"type":"HOME","streetAddress":"1415 140TH AVE NE APT 15","locality":"Bellevue","region":"WA","postalCode":"98005","country":"US","formatted":"1415 140TH AVE NE APT 15"}]}}},"schema":{"$ref":"#/components/schemas/UserSchemaV2"}}},"description":"User Schema to be updated","required":true},"responses":{"200":{"content":{"application/scim+json":{"example":{"schemas":["urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:extension:egencia:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"],"meta":{"created":"2024-07-17T00:00:00.000Z","lastModified":"2024-07-17T00:00:00.000Z","location":"{baseUrl}/openconnect/api/scim/v3/Users/12345"},"id":"egenciaUniqueIdentifier","externalId":"externalSystemIdentifier","userName":"test@example.com","name":{"familyName":"User","formatted":"","givenName":"Test","middleName":"","honorificPrefix":"Mr."},"userType":"NORMAL","preferredLanguage":"en","active":true,"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"employeeNumber":"employeeNumberValue"},"urn:ietf:params:scim:schemas:extension:egencia:2.0:User":{"approvers":{"level1Approvers":[{"id":"45678"}],"level2Approvers":[{"id":"45678"}],"delegateApprovers":[{"id":"123"}]},"arrangerGroups":["arrangerGroup1"],"arrangers":[{"id":"56789"},{"userName":"testarranger"}],"companyId":"egenciaCompanyId","customDataFields":[{"name":"Primary cost center","value":"Test cost center"}],"dateOfBirth":"1988-01-01","documents":[{"expirationDate":"2030-10-10","issueCountry":"US","issueDate":"2020-10-10","issueLocation":"city","type":"PAS","value":"ABCDE1234"}],"loyaltyPrograms":[{"issuingSupplierCode":"T4","lob":"HOTEL","name":"S-Card","type":"LC","validFrom":"2020-10-10","validTo":"2025-10-10","value":"S12345"}],"preferences":[{"lob":"AIR","mealType":"178","preferredDepartureAirport":"","seatType":"1","specialRequest":"Any special request"},{"lob":"RAIL","seatDirection":"Forward","seatRoom":"Lower","seatSolo":true,"seatType":"1"},{"lob":"HOTEL","smoking":"Smoking","specialRequest":"Any special request"},{"lob":"CAR","specialRequest":"Any special request"}],"serviceLevelIds":["12345"],"settings":{"notifications":{"reservationEmail":"validReservationEmailValue"}},"singleSignOnId":"singleSignOnIdValue","userAuthenticationMode":"SSO","subscribedCompanyIds":["63062","62366","63065"]},"emails":[{"primary":true,"type":"WORK","value":"test@example.com"}],"phoneNumbers":[{"primary":true,"type":"WORK","value":"+44-1234512345"}],"addresses":[{"country":"GB","formatted":"address line 1, cityname, state, GB, 123212","locality":"city name","postalCode":"123212","region":"region or state","streetAddress":"address line 1","type":"WORK"}],"groups":[{"display":"displayName","value":"travelerGroup"}],"roles":["SELF_BOOKER"]}}},"description":"Updated."},"400":{"content":{"application/scim+json":{"example":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"detail":"Invalid parameters","status":"400"}}},"description":"Bad Request : Invalid input or request"},"401":{"content":{"application/scim+json":{"example":{"error":{"code":"EGE-ER-4001","message":"Unauthorised access, you do not have sufficient permissions to perform this action."}}}},"description":"Unauthorized : Authentication token empty, invalid or expired."},"403":{"content":{"application/scim+json":{"example":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"detail":"Unauthorised access, you do not have sufficient permissions to perform this action. Contact your admin.","status":"403"}}},"description":"Forbidden : User not Validated for operation."},"422":{"content":{"application/scim+json":{"example":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"detail":"Invalid or missing parameters encountered, we are unable to process your request.","status":"422","data":[{"attribute":"userName","message":"userName needs to be specified and cannot be empty or null"}]}}},"description":"Invalid input : Invalid or missing required input."},"500":{"content":{"application/scim+json":{"example":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"detail":"Your request could not be completed due to some error. Please try again later.","status":"500","data":[{"attribute":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User.loyaltyPrograms","message":"Error occurred while processing loyalty program associations."}]}}},"description":"Internal Server Error : Unable to process request."},"503":{"content":{"application/scim+json":{"example":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"detail":"We are unable to process your request right now. Please try again later.","status":"503","data":[]}}},"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 User Sync V3"]}},"/v1/bookings":{"get":{"description":"Search booking details request based on specific criteria like metadossierid etc
\nRequest Parameters
\n| \n Attribute\n | \n\n Type\n | \n\n Description\n | \n
|---|---|---|
| metadata | ||
| metadossier_id | \nString | \nMetadossier id corresponding to the booking which has to be retrieved | \n
Examples:
\n\nRetrieving booking details for metadossierid : 169357529
\n\n \n GET https://apis.egencia.com/openconnect/api/v1/bookings?metadossier_id=169357529\n -> 200 OK\n {\n \"count\": 1,\n \"bookings\": [\n {\n \"booking_id\": \"2000-2635-761\",\n \"company_id\": \"10944\",\n \"items\": [\n {\n \"id\": \"6088fcf616ffd40001932e90\",\n \"traveler_id\": \"6619886\",\n \"product_type\": \"FLIGHT\",\n \"status\": \"CANCELLED\",\n \"booking_date_time\": \"2021-04-28T06:13:10\",\n \"is_agent_assisted\": false\n }\n ],\n \"_links\": {\n \"booking\": {\n \"href\": \"https://apis.egencia.com/openconnect/api/v1/bookings/2000-2635-761\"\n }\n }\n }\n ],\n \"_links\": {\n \"self\": {\n \"href\": \"https://apis.egencia.com/openconnect/api/v1/bookings?metadossier_id=169357529\"\n }\n }\n }\n \n","operationId":"search","parameters":[{"description":"Metadossier id","in":"query","name":"metadossier_id","required":false,"schema":{"type":"string"}},{"description":"Company id","in":"query","name":"company_id","required":false,"schema":{"type":"integer","format":"int32"}},{"description":"Date on or after which the booking starts, Format : YYYY-mm-dd","in":"query","name":"booking_start_after","required":false,"schema":{"type":"string"}},{"description":"Start count of the booking","in":"query","name":"start","required":false,"schema":{"type":"integer","format":"int32","default":0}},{"description":"Number of bookings to be retrieved","in":"query","name":"count","required":false,"schema":{"type":"integer","format":"int32","default":50}},{"description":"Fact id","in":"query","name":"fact_id","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/BookingSearchResponse"}}},"description":"OK."},"400":{"description":"Bad Request : Invalid input or request"},"401":{"description":"Unauthorized : authentication token empty, invalid or expired."},"403":{"description":"Forbidden : User is not authorized for the operation."},"422":{"description":"Invalid input : invalid or missing required input."},"500":{"description":"Internal Server Error : unable to process request"}},"security":[{"OAuth2":[]}],"summary":"search trip details","tags":["bookings v1"]},"post":{"operationId":"createBooking","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BookingProduct"}}},"required":true},"responses":{"200":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/BookingProduct"}}},"description":"OK"}},"security":[{"OAuth2":[]}],"tags":["bookings v1"]}},"/v1/bookings/{bookingId}":{"get":{"description":"Creates a Retrieve Booking details request for a specific Booking Id
\nThe response contains booking level as well as item level action links to approve/deny the booking request. The approve/deny action links will be coming in the response when approval status is PENDING and booking status is BOOKED.
\nRequest Parameters
\n| \n Attribute\n | \n\n Type\n | \n\n Description\n | \n
|---|---|---|
| metadata | ||
| bookingId | \nString | \nTrip id corresponding to the booking which is to be retrieved | \n
Creates an Approval request (Action: Approve) for a specific booking Id
\nRequest Parameters
\n| \n Attribute\n | \n\n Type\n | \n\n Description\n | \n
|---|---|---|
| metadata | ||
| bookingId | \nString | \nTrip id corresponding to each booked product | \n
| approve | \nString | \nApproval action: Approve | \n
Response Parameters
\n| \n Attribute\n | \n\n Type\n | \n\n Description\n | \n
|---|---|---|
| metadata | ||
| booking_id | \nString | \nTrip id corresponding to the booking which is to be approved | \n
| status | \nString | \nApproval action: Approved | \n
| items | \nList | \nList of items to be approved | \n
| item_id | \nString | \nTrip item id which is to be approved | \n
Success Response
\nIf the request is successful, you will receive the following output:
\n\n \n {\n \"booking_id\": \"123\",\n \"status\": \"APPROVED\",\n \"items\": [\n {\n \"item_id\": \"1\",\n \"status\": \"APPROVED\"\n },\n {\n \"item_id\": \"2\",\n \"status\": \"APPROVED\"\n }\n ]\n }\n \n\n500 Error Response
\n\n \n {\n \"error\": {\n \"code\": \"EGE-ER-OS-5004\",\n \"message\": \"There was an error in approving/denying the following items [5fb4d1d3ef80270001a1d1fd, 5fb4d1a7ef80270001a1d1f9]. Please try again.\"\n }\n }\n \n\n","operationId":"approveBooking","parameters":[{"in":"path","name":"bookingId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/ApprovalResponse"}}},"description":"OK."},"400":{"description":"Bad Request : Invalid input or request"},"401":{"description":"Unauthorized : authentication token empty, invalid or expired."},"403":{"description":"Forbidden : User is not authorized for the operation."},"422":{"description":"Invalid input : invalid or missing required input."},"500":{"description":"Internal Server Error : unable to process request"},"501":{"description":"Not Implemented : Not Implemented."}},"security":[{"OAuth2":[]}],"summary":"Approve the complete booking based on booking ID","tags":["bookings v1"]}},"/v1/bookings/{bookingId}/cancel":{"post":{"description":"Creates a cancel request for a specific booking Id
\nRequest Parameters
\n| \n Attribute\n | \n\n Type\n | \n\n Description\n | \n
|---|---|---|
| metadata | ||
| bookingId | \nString | \nTrip id corresponding to each booked product | \n
Response Parameters in case of successful response
\n| \n Attribute\n | \n\n Type\n | \n\n Description\n | \n
|---|---|---|
| metadata | ||
| booking_id | \nString | \nTrip id corresponding to the booking which is to be cancelled | \n
| status | \nString | \nCANCELLED | \n
| items | \nList | \nList of items to be cancelled | \n
| id | \nString | \nTrip item id which is to be cancelled | \n
| status | \nString | \nStatus of the particular item. The status will always be “CANCELLED” in case of success response. | \n
Below response with 200 OK HttpStatus
\n\n \n {\n \"booking_id\": \"123\",\n \"status\": \"CANCELLED\",\n \"items\": [\n {\n \"id\": \"1\",\n \"status\": \"CANCELLED\"\n },\n {\n \"id\": \"2\",\n \"status\": \"CANCELLED\"\n }\n ]\n }\n \n\nResponse Parameters in case of failure response
\n| \n Attribute\n | \n\n Type\n | \n\n Description\n | \n
|---|---|---|
| metadata | ||
| booking_id | \nString | \nTrip id corresponding to the booking which is to be cancelled | \n
| status | \nString | \nFAILURE | \n
| error_code | \nString | \nError code in case of failure | \n
| error_message | \nString | \nError message in case of failure | \n
| items | \nList | \nList of items to be cancelled | \n
| id | \nString | \nTrip item id which is to be cancelled | \n
| status | \nString | \nStatus of the particular item. The status can be “CANCELLED” or “FAILURE”. | \n
Below response with 500 Internal Server Error HttpStatus
\n\n \n {\n \"booking_id\": \"123\",\n \"status\": \"FAILURE\",\n \"error_code\": \"EGE-ER-OS-5011\",\n \"error_message\": \"There was an error in cancelling the [1234, 9876] items. Please try again.\",\n \"items\": [\n {\n \"id\": \"1\",\n \"status\": \"CANCELLED\"\n },\n {\n \"id\": \"1234\",\n \"status\": \"FAILURE\"\n },\n {\n \"id\": \"9876\",\n \"status\": \"FAILURE\"\n }\n ]\n }\n \n\nCreates a delete request for a specific booking Id
\nRequest Parameters
\n| \n Attribute\n | \n\n Type\n | \n\n Description\n | \n
|---|---|---|
| metadata | ||
| bookingId | \nString | \nTrip id corresponding to each booked product | \n
Response Parameters in case of successful response
\n| \n Attribute\n | \n\n Type\n | \n\n Description\n | \n
|---|---|---|
| metadata | ||
| booking_id | \nString | \nTrip id corresponding to the booking which is to be deleted | \n
| status | \nString | \nSUCCESS | \n
| items | \nList | \nList of items to be deleted | \n
| id | \nString | \nTrip item id which is to be deleted | \n
| status | \nString | \nStatus of the particular item. The status will be booking status of the trip item. | \n
Below response with 200 OK HttpStatus
\n\n \n {\n \"booking_id\": \"123\",\n \"status\": \"SUCCESS\",\n \"items\": [\n {\n \"id\": \"1\",\n \"status\": \"DELETED\"\n },\n {\n \"id\": \"2\",\n \"status\": \"DELETED\"\n }\n ]\n }\n \n\nResponse Parameters in case of failure response
\n| \n Attribute\n | \n\n Type\n | \n\n Description\n | \n
|---|---|---|
| metadata | ||
| booking_id | \nString | \nTrip id corresponding to the booking which is to be deleted | \n
| status | \nString | \nFAILURE | \n
| error_code | \nString | \nError code in case of deletion | \n
| error_message | \nString | \nError message in case of deletion | \n
| items | \nList | \nList of items to be deleted | \n
| id | \nString | \nTrip item id which is to be deleted | \n
| status | \nString | \nStatus of the particular item. The status will be the booking status of the trip item | \n
Below response with 500 Internal Server Error HttpStatus
\n\n \n {\n \"booking_id\": \"123\",\n \"status\": \"FAILURE\",\n \"error_code\": \"EGE-ER-OS-5012\",\n \"error_message\": \"There was an error in deleting the [1234, 9876] items. Please try again.\",\n \"items\": [\n {\n \"id\": \"1\",\n \"status\": \"CANCELLED\"\n },\n {\n \"id\": \"1234\",\n \"status\": \"FAILURE\"\n },\n {\n \"id\": \"9876\",\n \"status\": \"FAILURE\"\n }\n ]\n }\n \n\nCreates a Deny request (Action: Deny) for a booking
\nRequest Parameters
\n| \n Attribute\n | \n\n Type\n | \n\n Description\n | \n
|---|---|---|
| metadata | ||
| bookingId | \nString | \nTrip id corresponding to the booking which is to be denied | \n
| deny | \nString | \nApproval action: Denied | \n
Response Parameters
\n| \n Attribute\n | \n\n Type\n | \n\n Description\n | \n
|---|---|---|
| metadata | ||
| booking_id | \nString | \nTrip id corresponding to the booking which is to be denied | \n
| status | \nString | \nApproval action: Denied | \n
| item_id | \nString | \nTrip item id which is to be denied | \n
Success Response
\nIf the request is successful, you will receive the following output:
\n\n \n {\n \"booking_id\": \"123\",\n \"status\": \"DENIED\",\n \"items\": [\n {\n \"item_id\": \"1\",\n \"status\": \"DENIED\"\n },\n {\n \"item_id\": \"2\",\n \"status\": \"DENIED\"\n }\n ]\n }\n \n\n500 Error Response
\n\n \n {\n \"error\": {\n \"code\": \"EGE-ER-OS-5004\",\n \"message\": \"There was an error in approving/denying the following items [5fb4d1d3ef80270001a1d1fd, 5fb4d1a7ef80270001a1d1f9]. Please try again.\"\n }\n }\n \n\n","operationId":"denyBooking","parameters":[{"in":"path","name":"bookingId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/ApprovalResponse"}}},"description":"OK."},"400":{"description":"Bad Request : Invalid input or request"},"401":{"description":"Unauthorized : authentication token empty, invalid or expired."},"403":{"description":"Forbidden : User is not authorized for the operation."},"422":{"description":"Invalid input : invalid or missing required input."},"500":{"description":"Internal Server Error : unable to process request"},"501":{"description":"Not Implemented : Not Implemented."}},"security":[{"OAuth2":[]}],"summary":"Deny the complete booking based on booking ID","tags":["bookings v1"]}},"/v1/bookings/{bookingId}/items/{itemId}":{"get":{"description":"Creates a Retrieve Booking Item details request for specific Booking Item Id
\nThe response contains item level action links to approve/deny the booking item. The approve/deny action links will be coming in the response when approval status is PENDING and booking status is BOOKED. The cancel action link will come when booking status is not CANCELLED.
\nRequest Parameters
\n| \n Attribute\n | \n\n Type\n | \n\n Description\n | \n
|---|---|---|
| metadata | ||
| bookingId | \nString | \nTrip id corresponding to the booking which is to be retrieved | \n
| itemId | \nString | \nTrip item id corresponding to the booking which is to be retrieved | \n
Creates an Approval request (Action: Approve) for specific item Id.
\nRequest Parameters
\n| \n Attribute\n | \n\n Type\n | \n\n Description\n | \n
|---|---|---|
| metadata | ||
| bookingId | \nString | \nTrip id corresponding to the booking which is to be approved | \n
| approve | \nString | \nApproval action: approve | \n
| item_id | \nString | \nTrip item id which is to be approved | \n
| level | \nString (optional) | \nTargets a specific approver level. Allowed values: ONE, TWO, SECURITY. If not provided, the first approver is used. | \n
Response Parameters
\n| \n Attribute\n | \n\n Type\n | \n\n Description\n | \n
|---|---|---|
| metadata | ||
| booking_id | \nString | \nTrip id corresponding to the booking which was approved | \n
| status | \nString | \nApproval action: Approved | \n
| item_id | \nString | \nTrip item id which was approved | \n
Success Response
\nIf the request is successful, you will receive the following output:
\n\n \n {\n \"booking_id\": \"1\",\n \"item_id\": \"2\",\n \"status\": \"APPROVED\"\n }\n \n\n500 Error Response
\n\n \n {\n \"error\": {\n \"code\": \"EGE-ER-OS-5004\",\n \"message\": \"There was an error in approving/denying the following items [5fb4d1d3ef80270001a1d1fd]. Please try again.\"\n }\n }\n \n\n","operationId":"approveBookingItem","parameters":[{"description":"Booking ID of the trip containing the item to approve","example":"2000-2587-907","in":"path","name":"bookingId","required":true,"schema":{"type":"string"}},{"description":"ID of the booking item to approve","example":"5f964c44e7b72600017fc8bb","in":"path","name":"itemId","required":true,"schema":{"type":"string"}},{"description":"Targets a specific hierarchical approver level or security level. If not provided, the first approver is used.","example":"ONE","in":"query","name":"level","required":false,"schema":{"type":"string","enum":["ONE","TWO","SECURITY"]}}],"responses":{"200":{"content":{"application/json;charset=utf-8":{"examples":{"Item approved":{"description":"Item approved","value":{"booking_id":"2000-2587-907","item_id":"5f964c44e7b72600017fc8bb","status":"APPROVED"}},"Pending further level approvals":{"description":"Pending further level approvals","value":{"booking_id":"2000-2587-907","item_id":"5f964c44e7b72600017fc8bb","status":"PENDING"}}},"schema":{"$ref":"#/components/schemas/ApprovalItemResponse"}}},"description":"OK."},"400":{"description":"Bad Request : Invalid input or request"},"401":{"description":"Unauthorized : authentication token empty, invalid or expired."},"403":{"description":"Forbidden : User is not authorized for the operation."},"422":{"description":"Invalid input : invalid or missing required input."},"500":{"content":{"application/json;charset=utf-8":{"examples":{"Item could not be approved (e.g. cancelled downstream)":{"description":"Item could not be approved (e.g. cancelled downstream)","value":{"error":{"code":"EGE-ER-OS-5004","message":"There was an error in approving/denying the following items [5f964c44e7b72600017fc8bb]. Please try again."}}}}}},"description":"Internal Server Error : unable to process request"},"501":{"description":"Not Implemented : Not Implemented."}},"security":[{"OAuth2":[]}],"summary":"Approve a particular booking item based on booking ID and item ID","tags":["bookings v1"]}},"/v1/bookings/{bookingId}/items/{itemId}/cancel":{"post":{"description":"Creates a cancel request to cancel a particular booking item present in the booking.
\nRequest Parameters
\n| \n Attribute\n | \n\n Type\n | \n\n Description\n | \n
|---|---|---|
| metadata | ||
| bookingId | \nString | \nBooking id corresponding to each booked product | \n
| itemId | \nString | \nBooking item id corresponding to booking item which we want to cancel | \n
Response Parameters in case of successful response
\n| \n Attribute\n | \n\n Type\n | \n\n Description\n | \n
|---|---|---|
| metadata | ||
| booking_id | \nString | \nBooking id corresponding to the booking which is to be cancelled | \n
| status | \nString | \nSUCCESS | \n
| id | \nString | \nBooking item id which is to be cancelled | \n
Below response with 200 OK HttpStatus
\n\n \n {\n \"booking_id\": \"123\",\n \"status\": \"SUCCESS\",\n \"id\": \"1\",\n }\n \n\nResponse Parameters in case of failure response
\n| \n Attribute\n | \n\n Type\n | \n\n Description\n | \n
|---|---|---|
| metadata | ||
| booking_id | \nString | \nBooking id corresponding to the booking which is to be cancelled | \n
| status | \nString | \nFAILURE | \n
| error_code | \nString | \nError code in case of cancellation | \n
| error_message | \nString | \nError message in case of cancellation | \n
| id | \nString | \nBooking item id which is to be cancelled | \n
Below response with 500 Internal Server Error HttpStatus
\n\n \n {\n \"booking_id\": \"123\",\n \"status\": \"FAILURE\",\n \"id\": \"1234\",\n \"error_code\": \"EGE-ER-OS-5011\",\n \"error_message\": \"There was an error in cancelling the [1234] items. Please try again.\",\n }\n \n\nCreates a delete request to delete a particular trip item present in the booking.
\nRequest Parameters
\n| \n Attribute\n | \n\n Type\n | \n\n Description\n | \n
|---|---|---|
| metadata | ||
| bookingId | \nString | \nTrip id corresponding to each booked product | \n
| itemId | \nString | \nTrip item id corresponding to trip item which we want to delete | \n
Response Parameters in case of successful response
\n| \n Attribute\n | \n\n Type\n | \n\n Description\n | \n
|---|---|---|
| metadata | ||
| booking_id | \nString | \nTrip id corresponding to the booking which is to be deleted | \n
| status | \nString | \nSUCCESS | \n
| id | \nString | \nTrip item id which is to be deleted | \n
Below response with 200 OK HttpStatus
\n\n \n {\n \"booking_id\": \"123\",\n \"status\": \"SUCCESS\",\n \"id\": \"1\",\n }\n \n\nResponse Parameters in case of failure response
\n| \n Attribute\n | \n\n Type\n | \n\n Description\n | \n
|---|---|---|
| metadata | ||
| booking_id | \nString | \nTrip id corresponding to the booking which is to be deleted | \n
| status | \nString | \nFAILURE | \n
| error_code | \nString | \nError code in case of deletion | \n
| error_message | \nString | \nError message in case of deletion | \n
| id | \nString | \nTrip item id which is to be deleted | \n
Below response with 500 Internal Server Error HttpStatus
\n\n \n {\n \"booking_id\": \"123\",\n \"status\": \"FAILURE\",\n \"id\": \"1234\",\n \"error_code\": \"EGE-ER-OS-5012\",\n \"error_message\": \"There was an error in deleting the [1234] items. Please try again.\",\n }\n \n\nCreates a Deny request (Action: Deny) for specific item Id.
\nRequest Parameters
\n| \n Attribute\n | \n\n Type\n | \n\n Description\n | \n
|---|---|---|
| metadata | ||
| bookingId | \nString | \nTrip id corresponding to the booking which is to be denied | \n
| deny | \nString | \nApproval action: deny | \n
| item_id | \nString | \nTrip item id which is to be denied | \n
| level | \nString (optional) | \nTargets a specific approver level. Allowed values: ONE, TWO, SECURITY. If not provided, the first approver is used. | \n
Response Parameters
\n| \n Attribute\n | \n\n Type\n | \n\n Description\n | \n
|---|---|---|
| metadata | ||
| booking_id | \nString | \nTrip id corresponding to the booking which was denied | \n
| status | \nString | \nApproval action: Denied | \n
| item_id | \nString | \nTrip item id which was denied | \n
Success Response
\nIf the request is successful, you will receive the following output:
\n\n \n {\n \"booking_id\": \"1\",\n \"item_id\": \"2\",\n \"status\": \"DENIED\"\n }\n \n\n500 Error Response
\n\n \n {\n \"error\": {\n \"code\": \"EGE-ER-OS-5004\",\n \"message\": \"There was an error in approving/denying the following items [5fb4d1d3ef80270001a1d1fd]. Please try again.\"\n }\n }\n \n\n","operationId":"denyBookingItem","parameters":[{"description":"Booking ID of the trip containing the item to deny","example":"2000-2587-907","in":"path","name":"bookingId","required":true,"schema":{"type":"string"}},{"description":"ID of the booking item to deny","example":"5f964c44e7b72600017fc8bb","in":"path","name":"itemId","required":true,"schema":{"type":"string"}},{"description":"Targets a specific hierarchical approver level or security level. If not provided, the first approver is used.","example":"ONE","in":"query","name":"level","required":false,"schema":{"type":"string","enum":["ONE","TWO","SECURITY"]}}],"responses":{"200":{"content":{"application/json;charset=utf-8":{"examples":{"Item denied":{"description":"Item denied","value":{"booking_id":"2000-2587-907","item_id":"5f964c44e7b72600017fc8bb","status":"DENIED"}}},"schema":{"$ref":"#/components/schemas/ApprovalItemResponse"}}},"description":"OK."},"400":{"description":"Bad Request : Invalid input or request"},"401":{"description":"Unauthorized : authentication token empty, invalid or expired."},"403":{"description":"Forbidden : User is not authorized for the operation."},"422":{"description":"Invalid input : invalid or missing required input."},"500":{"content":{"application/json;charset=utf-8":{"examples":{"Item could not be denied (e.g. cancelled downstream)":{"description":"Item could not be denied (e.g. cancelled downstream)","value":{"error":{"code":"EGE-ER-OS-5004","message":"There was an error in approving/denying the following items [5f964c44e7b72600017fc8bb]. Please try again."}}}}}},"description":"Internal Server Error : unable to process request"},"501":{"description":"Not Implemented : Not Implemented."}},"security":[{"OAuth2":[]}],"summary":"Deny a particular booking item based on booking ID and item ID","tags":["bookings v1"]}},"/v1/bookings/{bookingId}/items/{itemId}/receipts":{"get":{"description":"Fetch receipt for a booking item
\nRequest Parameters
\n| \n Attribute\n | \n\n Type\n | \n\n Description\n | \n
|---|---|---|
| bookingId | \nString | \nId corresponding to the trips summary for which you want to fetch each booking item receipts | \n
| itemId | \nString | \nId corresponding to the booking item for which we want to fetch receipt | \n
Response Parameters in case of successful response
\nIn case of successful response receipt pdf will be send to the partner with 200 OK status
\nResponse Parameters in case of failure response
\n| \n Attribute\n | \n\n Type\n | \n\n Description\n | \n
|---|---|---|
| code | \nString | \nError code in case of receipt failure | \n
| message | \nString | \nError message in case of failure | \n
Below response with 404 Not Found Error HttpStatus
\n\n \n {\n \"error\": {\n \"code\": \"EGE-ER-OS-4010\",\n \"message\": \"Receipt is unavailable for this booking item.\"\n }\n }\n \n\nRequest Parameters
\n| \n Attribute\n | \n\n Type\n | \n\n Description\n | \n
|---|---|---|
| metadata | ||
| companyId | \nInteger | \nId of the company for which CDFs needs to be fetched | \n
| name | \nString | \nName of the CDF if only a particular CDF needs to be fetched | \n
Examples:
\n\nRetrieving CDFs for company_id : 42219
\n\n \n GET https://apis-eu-west-1.lab.egencia.cloud/openconnect/api/v1/companies/42219/cdfs\n -> 200 OK\n {\n \"cdfs\": [\n {\n \"id\": 27,\n \"name\": \"Main cost centre\",\n \"code\": \"COST_CENTER_1\",\n \"status\": \"ACTIVE\",\n \"field_type\": \"LIST\"\n },\n {\n \"id\": 30,\n \"name\": \"Secondary cost centre\",\n \"code\": \"COST_CENTER_2\",\n \"status\": \"ACTIVE\",\n \"field_type\": \"LIST\"\n },\n {\n \"id\": 1884,\n \"name\": \"Employee ID\",\n \"code\": \"COST_CENTER_3\",\n \"status\": \"ACTIVE\",\n \"field_type\": \"FREE_FIELD\"\n },\n {\n \"id\": 31,\n \"name\": \"Free field 1\",\n \"code\": \"BDC\",\n \"status\": \"ACTIVE\",\n \"field_type\": \"FREE_FIELD\"\n }\n ]\n }\n ","operationId":"getCdfDefinitions","parameters":[{"in":"path","name":"companyId","required":true,"schema":{"type":"integer","format":"int64"}},{"in":"query","name":"name","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/CdfDefinitions"}}},"description":"OK."},"400":{"description":"Bad Request : Invalid input or request"},"401":{"description":"Unauthorized : authentication token empty, invalid or expired."},"403":{"description":"Forbidden : User not Validated for operation."},"404":{"description":"Not Found : You are trying to access an invalid or non existent resource."},"422":{"description":"Invalid input : invalid or missing required input."},"500":{"description":"Internal Server Error : unable to process request"}},"security":[{"OAuth2":[]}],"summary":"Fetch all CDF definitions for a company or corresponding to a CDF name","tags":["Custom Data Fields (CDF)"]}},"/v1/companies/{companyId}/cdfs/{definitionId}/values":{"get":{"description":"Request Parameters
\n| \n Attribute\n | \n\n Type\n | \n\n Description\n | \n
|---|---|---|
| metadata | ||
| companyId | \nInteger | \nId of the company | \n
| definitionId | \nInteger | \nId of the CDF definition for which values needs to be fetched | \n
| value | \nString | \nCDF value to search based on display value/label | \n
| count | \nInteger | \nCount of CDF values to be fetched | \n
| start | \nInteger | \nStart to support pagination | \n
Examples:
\n\nSuccessful response while retrieving CDF values for company_id : 42219 and definition_id : 27
\n\n \n GET https://apis-eu-west-1.lab.egencia.cloud/openconnect/api/v1/companies/42219/cdfs/27/values?count=2&start=0\n -> 200 OK\n {\n \"values\": [\n {\n \"id\": 84429607,\n \"value\": \"test A&B\",\n \"description\" : \"test A&B\"\n },\n {\n \"id\": 84740706,\n \"value\": \"test AB\",\n \"description\" : \"test AB\"\n }\n ],\n \"_links\": {\n \"next\": {\n \"href\": \"https://apis-eu-west-1.lab.egencia.cloud/openconnect-service/v1/companies/42219/cdfs/27/values?count=2&start=2\"\n }\n }\n }\n Successful response to search CDF value : test for company_id : 42219 and definition_id : 27
\n\n \n GET https://apis-eu-west-1.lab.egencia.cloud/openconnect/api/v1/companies/42219/cdfs/27/values?value=test\n -> 200 OK\n {\n \"values\": [\n {\n \"id\": 83932305,\n \"value\": \"Testcc1\",\n \"child_count\":0\n },\n {\n \"id\": 84429607,\n \"value\": \"testValue1\",\n \"child_count\":0\n },\n {\n \"id\": 84429608,\n \"value\": \"testingCdf\",\n \"child_count\":0\n }\n ]\n }\n Error response while retrieving CDF values for company_id : 42219 and definition_id : 1884
\n\n \n GET https://apis-eu-west-1.lab.egencia.cloud/openconnect/api/v1/companies/42219/cdfs/1884/values?count=2&start=0\n -> 422 Unprocessable Entity\n {\n \"error\": {\n \"code\": \"EGE-ER-OS-4006\",\n \"message\": \"CDF given in request has field type as free field.\"\n }\n }\n ","operationId":"getCdfValues","parameters":[{"in":"path","name":"companyId","required":true,"schema":{"type":"integer","format":"int64"}},{"in":"path","name":"definitionId","required":true,"schema":{"type":"integer","format":"int64"}},{"in":"query","name":"value","required":false,"schema":{"type":"string"}},{"in":"query","name":"count","required":false,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"start","required":false,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/CdfValuesResponse"}},"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/CdfValuesResponse"}}},"description":"OK."},"400":{"description":"Bad Request : Invalid input or request"},"401":{"description":"Unauthorized : authentication token empty, invalid or expired."},"403":{"description":"Forbidden : User not Validated for operation."},"404":{"description":"Not Found : You are trying to access an invalid or non existent resource."},"422":{"description":"Invalid input : invalid or missing required input."},"500":{"description":"Internal Server Error : unable to process request"}},"security":[{"OAuth2":[]}],"summary":"Fetch all CDF values for a company and a CDF definition or corresponding to a CDF value","tags":["Custom Data Fields (CDF)"]},"post":{"description":"Request Parameters
\n| \n Attribute\n | \n\n Type\n | \n\n Description\n | \n
|---|---|---|
| metadata | ||
| companyId | \nInteger | \nId of the company | \n
| definitionId | \nInteger | \nId of the CDF definition | \n
| value | \nString | \nValue of the CDF | \n
| description | \nString | \nDescription of the CDF Value | \n
Examples:
\n\nCreating CDF value : testws for company_id : 42219 and definition_id : 27
\n\n \n POST https://apis-eu-west-1.lab.egencia.cloud/openconnect/api/v1/companies/42219/cdfs/27/values\n {\n \"value\":\"testws\",\n \"description\":\"testws\"\n }\n
\n Successful Response: \n -> 201 Created\n {\n \"id\": 84736648\n }\n ","operationId":"createCdfValue","parameters":[{"in":"path","name":"companyId","required":true,"schema":{"type":"integer","format":"int64"}},{"in":"path","name":"definitionId","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdfValue"}}},"required":true},"responses":{"201":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/CdfValuesResponse"}}},"description":"Created."},"400":{"description":"Bad Request : Invalid input or request"},"401":{"description":"Unauthorized : authentication token empty, invalid or expired."},"403":{"description":"Forbidden : User not Validated for operation."},"404":{"description":"Not Found : You are trying to access an invalid or non existent resource."},"422":{"description":"Invalid input : invalid or missing required input."},"500":{"description":"Internal Server Error : unable to process request"}},"security":[{"OAuth2":[]}],"summary":"Create a new CDF value for a CDF of field type List","tags":["Custom Data Fields (CDF)"]}},"/v1/companies/{companyId}/cdfs/{definitionId}/values/{valueId}":{"delete":{"description":"Request Parameters
\n| \n Attribute\n | \n\n Type\n | \n\n Description\n | \n
|---|---|---|
| metadata | ||
| companyId | \nInteger | \nId of the company | \n
| definitionId | \nInteger | \nId of the CDF definition | \n
| valueId | \nInteger | \nId of the CDF value for which values needs to be updated | \n
Examples:
\n\nDelete CDF value with id : 676598 for company_id : 42219 and definition_id : 27
\n\n \n DELETE https://apis-eu-west-1.lab.egencia.cloud/openconnect/api/v1/companies/42219/cdfs/27/values/676598\n
\n Successful Response: \n -> 204 No Content\n ","operationId":"deleteCdfValue","parameters":[{"in":"path","name":"companyId","required":true,"schema":{"type":"integer","format":"int64"}},{"in":"path","name":"definitionId","required":true,"schema":{"type":"integer","format":"int64"}},{"in":"path","name":"valueId","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"204":{"description":"No Content."},"401":{"description":"Unauthorized : authentication token empty, invalid or expired."},"403":{"description":"Forbidden : User not Validated for operation."},"404":{"description":"Not Found : You are trying to access an invalid or non existent resource."},"500":{"description":"Internal Server Error : unable to process request"}},"security":[{"OAuth2":[]}],"summary":"Delete a CDF value for a CDF of field type List","tags":["Custom Data Fields (CDF)"]},"get":{"description":"Request Parameters
\n| \n Attribute\n | \n\n Type\n | \n\n Description\n | \n
|---|---|---|
| metadata | ||
| companyId | \nInteger | \nId of the company | \n
| definitionId | \nInteger | \nId of the CDF definition for which values needs to be fetched | \n
| value | \nString | \nCDF value to search based on display value/label | \n
| count | \nInteger | \nCount of CDF values to be fetched | \n
| start | \nInteger | \nStart to support pagination | \n
| include_links | \nBoolean | \nFetch CDF Links Flag | \n
Examples:
\nSuccessful response while retrieving linked CDF values for company_id : 53092, definition_id : 27, value=84428977
\n\n \n GET https://apis-eu-west-1.lab.egencia.cloud/openconnect/api/v1/companies/53092/cdfs/27/values/84428977?start=0&count=100&include_links=false\n -> 200 OK\n {\n {\n \"id\": 84428977,\n \"value\": \"Value 1\",\n \"child_count\": 4\n }\n \n \n Successful response to retrieve linked CDF value : test for company_id : 53092, definition_id : 27, value : 84428977
\n\n \n GET https://apis-eu-west-1.lab.egencia.cloud/openconnect/api//v1/companies/53092/cdfs/27/values/84428977?start=0&count=100&include_links=true\n -> 200 OK\n {\n {\n \"id\": 84428977,\n \"value\": \"Value 1\",\n \"child_count\": 4,\n \"links\": {\n \"child\": [\n {\n \"value\": \"Link with CC1 - 1\",\n \"id\": \"6171129\"\n },\n {\n \"value\": \"Link with CC1 - 2\",\n \"id\": \"6171130\"\n },\n {\n \"value\": \"Link with CC1 - 3\",\n \"id\": \"6171131\"\n },\n {\n \"value\": \"Link with CC1 - 4\",\n \"id\": \"7685276\"\n }\n ]\n }\n }\n \n \n Request Parameters
\n| \n Attribute\n | \n\n Type\n | \n\n Description\n | \n
|---|---|---|
| metadata | ||
| companyId | \nInteger | \nId of the company | \n
| definitionId | \nInteger | \nId of the CDF definition | \n
| valueId | \nInteger | \nId of the CDF value for which values needs to be updated | \n
| value | \nString | \nValue of the CDF | \n
| description | \nString | \nDescription of the CDF Value | \n
Examples:
\n\nUpdating CDF value for company_id : 42219, definition_id : 27 and value_id : 676598
\n\n \n PUT https://apis-eu-west-1.lab.egencia.cloud/openconnect/api/v1/companies/42219/cdfs/27/values/676598\n {\n \"value\":\"testWSNew\",\n \"description\":\"testWSNew\"\n }\n
\n Successful Response: \n -> 204 No Content\n ","operationId":"updateCdfValue","parameters":[{"in":"path","name":"companyId","required":true,"schema":{"type":"integer","format":"int64"}},{"in":"path","name":"definitionId","required":true,"schema":{"type":"integer","format":"int64"}},{"in":"path","name":"valueId","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdfValue"}}},"required":true},"responses":{"204":{"description":"No Content."},"400":{"description":"Bad Request : Invalid input or request"},"401":{"description":"Unauthorized : authentication token empty, invalid or expired."},"403":{"description":"Forbidden : User not Validated for operation."},"404":{"description":"Not Found : You are trying to access an invalid or non existent resource."},"422":{"description":"Invalid input : invalid or missing required input."},"500":{"description":"Internal Server Error : unable to process request"}},"security":[{"OAuth2":[]}],"summary":"Update a CDF value for a CDF of field type List","tags":["Custom Data Fields (CDF)"]}},"/v1/companies/{companyId}/cdfs/{definitionId}/values/{valueId}/link":{"patch":{"description":"Request Parameters
\n| \n Attribute\n | \n\n Type\n | \n\n Description\n | \n
|---|---|---|
| metadata | ||
| companyId | \nInteger | \nId of the company | \n
| definitionId | \nInteger | \nId of the CDF definition | \n
| valueId | \nInteger | \nId of the CDF value for which values needs to be updated | \n
| op | \nString | \nOperation to be perfomed on Cdf Link | \n
| link | \nString | \nCdf link on which operation is to be perfomed | \n
| value | \nList | \nValue of the CDF which should be numeric | \n
Fetch receipt for a booking item
\nRequest Parameters
\n| \n Attribute\n | \n\n Type\n | \n\n Description\n | \n
|---|---|---|
| bookingId | \nString | \nId corresponding to the trips summary for which you want to fetch each booking item receipts | \n
| itemId | \nString | \nId corresponding to the booking item for which we want to fetch receipt | \n
Response Parameters in case of successful response
\nIn case of successful response receipt pdf will be send to the partner with 200 OK status
\nResponse Parameters in case of failure response
\n| \n Attribute\n | \n\n Type\n | \n\n Description\n | \n
|---|---|---|
| code | \nString | \nError code in case of receipt failure | \n
| message | \nString | \nError message in case of failure | \n
Below response with 404 Not Found Error HttpStatus
\n\n \n {\n \"error\": {\n \"code\": \"EGE-ER-OS-4010\",\n \"message\": \"Receipt is unavailable for this booking item.\"\n }\n }\n \n\nFetch all receipts for a booking item as a zip file
\nRequest Parameters
\n| \n Attribute\n | \n\n Type\n | \n\n Description\n | \n
|---|---|---|
| bookingId | \nString | \nId corresponding to the trips summary for which you want to fetch all booking item receipts | \n
| itemId | \nString | \nId corresponding to the booking item for which we want to fetch receipts | \n
Response Parameters in case of successful response
\nIn case of successful response, receipts zip file will be sent to the partner with 200 OK status
\nResponse Parameters in case of failure response
\n| \n Attribute\n | \n\n Type\n | \n\n Description\n | \n
|---|---|---|
| code | \nString | \nError code in case of failure | \n
| message | \nString | \nError message in case of failure | \n
Below response with 404 Not Found Error HttpStatus
\n\n \n {\n \"error\": {\n \"code\": \"EGE-ER-OS-4010\",\n \"message\": \"Receipt is unavailable for this booking item.\"\n }\n }\n \n\nFetch receipt for a booking item by receipt id
\nRequest Parameters
\n| \n Attribute\n | \n\n Type\n | \n\n Description\n | \n
|---|---|---|
| bookingId | \nString | \nId corresponding to the trips summary for which you want to fetch each booking item receipts | \n
| itemId | \nString | \nId corresponding to the booking item for which we want to fetch receipt | \n
| receiptId | \nString | \nId corresponding to the receipt we want to fetch | \n
Response Parameters in case of successful response
\nIn case of successful response, receipt pdf will be sent to the partner with 200 OK status
\nResponse Parameters in case of failure response
\n| \n Attribute\n | \n\n Type\n | \n\n Description\n | \n
|---|---|---|
| code | \nString | \nError code in case of failure | \n
| message | \nString | \nError message in case of failure | \n
Below response with 404 Not Found Error HttpStatus
\n\n \n {\n \"error\": {\n \"code\": \"EGE-ER-OS-4010\",\n \"message\": \"Receipt is unavailable for this booking item.\"\n }\n }\n \n\n