# Create company This endpoint creates a company. This is allowed only by TMC_ADMIN and above roles. Endpoint: POST /v2/companies Version: v2 Security: Bearer ## Request fields (application/json): - `name` (string, required) Company name Example: "Spotnana" - `emailDomains` (array) List of the company email domains Example: ["spotnana.com"] - `billingCurrency` (string, required) Billing currency of the company Example: "INR" - `phoneNumbers` (array) List of company phone numbers - `phoneNumbers.countryCode` (integer) two digit country code Example: 91 - `phoneNumbers.countryCodeSource` (string) Enum: "UNSPECIFIED", "FROM_NUMBER_WITH_PLUS_SIGN", "FROM_NUMBER_WITH_IDD", "FROM_NUMBER_WITHOUT_PLUS_SIGN", "FROM_DEFAULT_COUNTRY" - `phoneNumbers.extension` (string) phone number extension Example: "222" - `phoneNumbers.isoCountryCode` (string) ISO alpha-2 code Example: "IN" - `phoneNumbers.italianLeadingZero` (boolean) Example: true - `phoneNumbers.nationalNumber` (integer) Example: 8150 - `phoneNumbers.numberOfLeadingZeros` (integer) Example: 1 - `phoneNumbers.preferredDomesticCarrierCode` (string) Example: "7" - `phoneNumbers.rawInput` (string) Example: "77777" - `phoneNumbers.type` (string) Enum: "UNKNOWN_TYPE", "MOBILE", "LANDLINE" - `emergencyContactInfos` (array) List of company emergency contacts - `emergencyContactInfos.address` (object) Postal Address Details - `emergencyContactInfos.address.addressLines` (array, required) Address lines Example: ["Golden Gate Bridge"] - `emergencyContactInfos.address.administrativeArea` (string) Code of administrative area. For example: DL for Delhi, India. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (e.g. "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. E.g. in Switzerland this should be left unpopulated. Example: "CA" - `emergencyContactInfos.address.administrativeAreaName` (string) Name of administrative area. This is full name corresponding to administrativeArea. Like Delhi for DL area code. For some places, code and name maybe same as well like Tokyo. Example: "California" - `emergencyContactInfos.address.description` (string) Address description Example: "San Francisco Home" - `emergencyContactInfos.address.isDefault` (boolean) Whether this address is default address in case multiple addresses are specified. Example: true - `emergencyContactInfos.address.languageCode` (string) BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. Examples: "zh-Hant", "ja", "ja-Latn", "en". Example: "en" - `emergencyContactInfos.address.locality` (string) Generally refers to the city/town portion of the address. Example: "San Francisco" - `emergencyContactInfos.address.locationCode` (string) IATA 3-letter location code. See https://www.iata.org/en/services/codes. Example: "LAX" - `emergencyContactInfos.address.organization` (string) The name of the organization at the address. Example: "Spotnana" - `emergencyContactInfos.address.postalCode` (string) Postal code of the address. This is a required field when setting for a user/legal entity/company etc. Example: "94130" - `emergencyContactInfos.address.continentCode` (string) 2 letter continent code of the continent this address falls in. Example: "AF" - `emergencyContactInfos.address.recipients` (array) The recipient at the address. - `emergencyContactInfos.address.regionCode` (string, required) Region code of the country/region of the address. Example: "US" - `emergencyContactInfos.address.regionName` (string) Region name of the country/region of the address. Example: "America" - `emergencyContactInfos.address.revision` (integer) Example: 1 - `emergencyContactInfos.address.sortingCode` (string) Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (e.g. Côte d'Ivoire). Example: "Jamaica" - `emergencyContactInfos.address.sublocality` (string) Sublocality of the address. This can be neighborhoods, boroughs, districts. - `emergencyContactInfos.address.timezone` (string) Time zone of the address. Example: "America/Los_Angeles" - `emergencyContactInfos.address.coordinates` (object) Map coordinates of the address. - `emergencyContactInfos.address.coordinates.latitude` (number, required) Latitude of the Location Example: 77.1025 - `emergencyContactInfos.address.coordinates.longitude` (number, required) Longitude of the Location Example: 28.7041 - `emergencyContactInfos.designation` (string) Example: "MANAGER" - `emergencyContactInfos.email` (string, required) Example: "emergency-contact@email.com" - `emergencyContactInfos.name` (object) Full name containing first, middle, last (family) names, and suffix. - `emergencyContactInfos.name.family1` (string, required) Last (family) name. Example: "Gandas" - `emergencyContactInfos.name.family2` (string) Example: "FamilyTwo" - `emergencyContactInfos.name.given` (string, required) First (given) name. Example: "Vichitr" - `emergencyContactInfos.name.middle` (string) Middle name. Example: "Kumar" - `emergencyContactInfos.name.suffix` (string) Suffix used with the name. For example SR or JR. Enum: "NAME_SUFFIX_UNKNOWN", "SR", "JR", "MD", "PHD", "II", "III", "IV", "DO", "ATTY", "V", "VI", "ESQ", "DC", "DDS", "VM", "JD", "SECOND", "THIRD" - `emergencyContactInfos.name.preferred` (string) Informal preferred name added by traveler. This is not used on any PNR or tickets Example: "Don" - `emergencyContactInfos.phoneNumber` (object) Properly formatted phone number. - `emergencyContactInfos.userOrgId` (object) User and user's organization information. - `emergencyContactInfos.userOrgId.organizationId` (object, required) Organization id for traveler. - `emergencyContactInfos.userOrgId.organizationId.id` (string, required) - `emergencyContactInfos.userOrgId.userId` (object, required) User identifier - `emergencyContactInfos.userOrgId.tmcBasicInfo` (object) TMC related basic information. - `emergencyContactInfos.userOrgId.tmcBasicInfo.contractingTmc` (object, required) Contracting TMC is the TMC the user/organization contracted. - `emergencyContactInfos.userOrgId.tmcBasicInfo.contractingTmc.id` (object, required) Company ID - `emergencyContactInfos.userOrgId.tmcBasicInfo.contractingTmc.name` (string) - `emergencyContactInfos.userOrgId.tmcBasicInfo.contractingTmc.logo` (object) Company logo - `emergencyContactInfos.userOrgId.tmcBasicInfo.contractingTmc.logo.data` (string) Example: "6935813e12584abda0e43d71cd2ea260" - `emergencyContactInfos.userOrgId.tmcBasicInfo.contractingTmc.logo.dimensions` (object) Image dimensions ie width and height. - `emergencyContactInfos.userOrgId.tmcBasicInfo.contractingTmc.logo.dimensions.height` (integer) Example: 120 - `emergencyContactInfos.userOrgId.tmcBasicInfo.contractingTmc.logo.dimensions.width` (integer) Example: 240 - `emergencyContactInfos.userOrgId.tmcBasicInfo.contractingTmc.logo.url` (string) Example: "https://static.wixstatic.com/media/73f2e2_6935813e12584abda0e43d71cd2ea260~mv2.png/v1/fill/w_630,h_94,al_c,q_85,usm_0.66_1.00_0.01/Spotnana%403x.webp" - `emergencyContactInfos.userOrgId.tmcBasicInfo.bookingTmc` (object, required) Booking TMC is the TMC used for the bookings for the user/organization. - `emergencyContactInfos.userOrgId.organizationAgencyId` (object) Agency id for the organization. - `emergencyContactInfos.userOrgId.tmcInfo` (object) TMC config information. - `emergencyContactInfos.userOrgId.tmcInfo.id` (object, required) TMC id. - `emergencyContactInfos.userOrgId.tmcInfo.primaryServiceProviderTmc` (object, required) Primary service provider TMC for the TMC. - `emergencyContactInfos.userOrgId.tmcInfo.primaryServiceProviderTmc.tmcId` (object, required) Id of the service provider TMC. - `emergencyContactInfos.userOrgId.tmcInfo.secondaryServiceProviderTmcs` (array) Secondary service provider TMCs for the TMC. - `emergencyContactInfos.userOrgId.tmcInfo.secondaryServiceProviderTmcs.supplier` (string, required) Supplier for which this service provider should be used. Enum: "SABRE", "AMADEUS", "TRAVEL_FUSION", "FARELOGIX_NDC", "ATPCO_NDC", "TRAINLINE", "AVIA", "QBR", "BCD", "QANTAS_HOTELS", "SOUTHWEST", "EXPEDIA", "HOTEL_HUB", "NDC", "MARRIOTT", "CLEARTRIP", "KYTE", "GROUNDSPAN", "SABRE_NDC", "BOOKING_COM", "CARTRAWLER", "PREMIER_INN", "TRAVELODGE" - `emergencyContactInfos.userOrgId.tmcInfo.secondaryServiceProviderTmcs.travelType` (string, required) Travel type for which this service provider should be used. Enum: "AIR", "HOTEL", "CAR", "RAIL", "LIMO", "MISC", "ALL" - `emergencyContactInfos.userOrgId.tmcInfo.partnerTmcId` (object) Useful to identify the clients onboarded by a PARTNER_TMC - `isSelfSignUpEnabled` (boolean) Boolean to show if company has self sign up enabled. Example: true - `announcements` (array) Company announcements - `announcements.title` (string, required) Title of the announcement. Example: "Spotnana on Mission to Unbundle Travel" - `announcements.description` (string, required) Description of the announcement. Example: "Amex Ventures Joins Spotnana on Mission to Unbundle Travel." - `announcements.linkUrl` (string) Announcement link url which points to the atual announcement page. Example: "https://medium.com/inside-spotnana/amex-ventures-joins-spotnana-on-mission-to-unbundle-travel-3cdb2ecceff4" - `announcements.linkDisplayText` (string) Announcement link display text. Example: "New announcement" - `companyLogo` (object) Company logo - `contractedBy` (object) Company ID which have contracted this company. - `companyRoles` (array, required) Company roles Enum: "ORG", "TMC", "PARTNER_TMC", "HR_FEED_CONNECTOR", "TRIPS_DATA_CONNECTOR", "GLOBAL" - `supportConfigs` (array) Support Configs for company - `supportConfigs.contactNumbers` (array) List of support phone numbers. - `supportConfigs.emailAddresses` (array) List of the support email addresses. Example: ["support@spotnana.com"] - `supportConfigs.freshdeskConfig` (object) Configuration for freshdesk. - `supportConfigs.freshdeskConfig.enabled` (boolean, required) Whether freshdesk is enabled or not. Example: true - `supportConfigs.freshdeskConfig.hasCredentials` (boolean, required) Whether the company has its own freshdesk credentials. - `supportConfigs.freshdeskConfig.credentials` (object) Credentials for the fresh desk. This field has no impact in create/update APIs. The process to store / update the credentials are manual. - `supportConfigs.freshdeskConfig.credentials.webCredentials` (object) Credentials related to freshdesk. - `supportConfigs.freshdeskConfig.credentials.webCredentials.domain` (string, required) Domain related to fresh desk. - `supportConfigs.freshdeskConfig.credentials.webCredentials.appId` (string, required) An identifier for fresh desk's app. - `supportConfigs.freshdeskConfig.credentials.webCredentials.appKey` (string, required) A secret key assigned to user's app by fresh desk. - `supportConfigs.freshdeskConfig.credentials.mobileCredentials` (object) Credentials related to freshdesk. - `supportConfigs.tier` (string) Tier of User. Note: In default UI, BASIC is displayed as Standard, and SEAT1A is displayed as VIP. Enum: "BASIC", "SEAT1A" - `supportConfigs.genesysConfig` (object) Configuration for genesys. - `supportConfigs.genesysConfig.enabled` (boolean, required) Whether genesys is enabled or not. Example: true - `supportConfigs.genesysConfig.dataUrl` (string, required) Data url for genesys. - `supportConfigs.portalUrls` (array) List of the support portal urls. Example: ["www.support.spotnana.com"] - `supportConfigs.zendeskConfig` (object) Configuration for zendesk. - `supportConfigs.zendeskConfig.enabled` (boolean, required) Whether Zendesk Chat is enabled or not. Example: true - `supportConfigs.zendeskConfig.integrationId` (string, required) Integration ID for Zendesk Chat for Web. Example: "1234567890" - `supportConfigs.zendeskConfig.androidIntegrationId` (string) Integration ID for Zendesk Chat for Android. Example: "1234567890" - `supportConfigs.zendeskConfig.iosIntegrationId` (string) Integration ID for Zendesk Chat for iOS. Example: "1234567890" - `supportConfigs.genesysCloudConfig` (object) Configuration for Genesys cloud. - `supportConfigs.genesysCloudConfig.enabled` (boolean, required) Whether Genesys Cloud is enabled or not. Example: true - `supportConfigs.genesysCloudConfig.deploymentId` (string, required) DeploymentId for Genesys Cloud. Example: "52dc2a6f-772a-4edf-96d3-b3f0c49400a7" - `supportConfigs.genesysCloudConfig.environment` (string, required) Environment for Genesys Cloud. Example: "usa-1" - `supportConfigs.genesysCloudConfig.genesysScriptUrl` (string, required) Url for Genesys Cloud Script. Example: "https://test.test.com" - `supportConfigs.twilioChatConfig` (object) Configuration for Twilio Chat. - `supportConfigs.twilioChatConfig.enabled` (boolean, required) Whether Twilio Chat is enabled or not. - `supportConfigs.cognigyChatConfig` (object) Cognigy Chat Config. - `supportConfigs.cognigyChatConfig.enabled` (boolean) Whether Cognigy chat is enabled or not. - `supportConfigs.cognigyChatConfig.scriptUrl` (string) Url for Cognigy Script. Example: "https://your-cognigy-instance.com/script/abcdef123456" - `supportConfigs.cognigyChatConfig.initWebchatEndpoint` (string) Endpoint for Cognigy initWebchat method. Example: "https://your-cognigy-instance.com/initWebchat" - `supportConfigs.cognigyChatConfig.sessionTimeout` (integer) Session timeout (in minutes) for Cognigy Chat. Example: 30 - `supportConfigs.cognigyChatConfig.cssUrl` (string) Url for Cognigy Chat CSS. Example: "https://your-server.com/css/chat.css" - `ccEmailAddresses` (array) List of email addresses on which all confirmation emails will be cced. This is applicable only for company roles 'ORG' Example: ["example@gmail.com"] - `bccEmailAddresses` (array) List of email addresses on which all confirmation emails will be bcced. This is applicable only for company roles 'ORG' Example: ["example@gmail.com"] - `postalAddress` (object) Postal address of the company. - `redirectUrl` (string) Redirect URL for the company. It is applicable only for company roles 'PARTNER_TMC' - `tmcDefaultConfiguration` (object) Default Booking configuration for the TMC. It is applicable only for company roles 'TMC' - `tmcDefaultConfiguration.defaultBookingTmcId` (string) Default booking TMC to be used. If not set, then TMC itself will be default booking tmc. Example: "734f4ea2-e9ed-4c90-853c-9eed62f1254b" - `tmcDefaultConfiguration.countryWiseBookingTmcs` (array) Override for booking TMCs per country. - `tmcDefaultConfiguration.countryWiseBookingTmcs.countryCode` (string, required) The ISO 2-character country code for which booking TMCs needs to be overriden. Example: "US" - `tmcDefaultConfiguration.countryWiseBookingTmcs.bookingTmcId` (string, required) Booking TMC for above country code. Example: "734f4ea2-e9ed-4c90-853c-9eed62f1254b" - `expensePartnerConfig` (object) Expense Partner Configuration - `expensePartnerConfig.partner` (string, required) The expense partner name as enum. Enum: "EXPENSIFY", "EMBURSE_CHROMERIVER", "BREX" - `expensePartnerConfig.emailConfig` (object) The email configuration part of the ExpensePartnerConfig. - `expensePartnerConfig.emailConfig.personalCardConfig` (object) Configuration for bookings done with Personal card. - `expensePartnerConfig.emailConfig.personalCardConfig.sendToTraveler` (boolean) A boolean flag to show if expenses are to be sent to traveler's Expense partner account. - `expensePartnerConfig.emailConfig.personalCardConfig.personalCardExpenseEmail` (string) The email for the expense partner account. Example: "user@company.com" - `expensePartnerConfig.emailConfig.centralCardExpenseEmail` (string) Central email for bookings done with central card. Example: "finance+le@company.com" - `expensePartnerConfig.emailConfig.expensePartnerEmail` (string, required) The expense partner email where expense receipts are sent to. Example: "receipts@expensify.com" - `expensePartnerConfig.emailConfig.bccEmail` (string) Email to which we bcc expensify emails Example: "docs@company.com" - `expensePartnerConfig.travelType` (array) Applicable segments Enum: "AIR", "HOTEL", "CAR", "RAIL", "LIMO", "MISC", "ALL" - `expensePartnerConfig.isExpensePartnerEnabled` (boolean) A flag denoting is the expense partner config is enabled or not. Example: true - `expensePartnerConfig.reportCustomFields` (boolean) Send custom fields to the expense partner if enabled. Example: true - `expensePartnerConfig.personalCardExpenseOwner` (object) Determines who should the expense be reported against. - `expensePartnerConfig.personalCardExpenseOwner.traveler` (boolean) Report the expense against the traveler who made the booking. If set to true, central email should not be set. Example: true - `expensePartnerConfig.personalCardExpenseOwner.centralEmail` (string) Report the expense against a central email. Example: "docs@company.com" - `expensePartnerConfig.centralCardExpenseOwner` (object) Determines who should the expense be reported against. - `expensePartnerConfig.partnerReferralId` (string) Referral id used for this company/legal entity during expense partner setup Example: "1234hgd" - `expensePartnerConfig.itineraryConfig` (object) Itinerary configuration to control what expenses to send to the partner - `expensePartnerConfig.itineraryConfig.skipModificationUpdate` (boolean) Allow modification expenses to be skipped from sending to the partner Example: true - `expensePartnerConfig.itineraryConfig.skipCancellationUpdate` (boolean) Allow cancellation expenses to be skipped from sending to the partner Example: true - `mobileRedirectUrl` (string) Redirect URL for the company for mobile. It is applicable only for company roles 'PARTNER_TMC' - `applicableCustomFieldTypes` (array) List of custom fields supported by the company. Enum: "QUESTION", "MEETING", "BUDGET", "BREX_TOKEN" - `privacySettings` (object) Privacy settings for a company. - `privacySettings.allowCompanyAdminAccessToRelativesInfo` (boolean) Boolean to show if company admin can see information of users' relatives. Example: true - `emailClientConfig` (object) Email client configuration representing the email provider to be used. - `emailClientConfig.client` (string, required) The email client to be used for pushing out the emails Enum: "AWS_SES", "SENDGRID" - `emailClientConfig.credentials` (object, required) Credentials for connecting to the email client - `emailClientConfig.credentials.emailClientSecretKey` (object, required) EmailClientSecretKey - `emailClientConfig.credentials.emailClientSecretKey.secretKey` (string) Example: "SECRET_KEY" - `emailClientConfig.credentials.emailClientSecretKey.versionId` (string) Example: "1" - `emailClientConfig.defaultSenderAddress` (string, required) The default sender address to be used for the configured client Example: "test@somedomain.com" - `emailClientConfig.defaultSenderName` (string) The default sender name to be used for the configured client Example: "Test Sender" - `externalId` (string) External id for legal entity. Example: "company-external-id" - `isFake` (boolean) Whether the company is a fake company for testing. This is for internal use. - `tmcPartnerRoleMappings` (array) list of individual role mappings between spotnana and partner. - `tmcPartnerRoleMappings.partnerRole` (string, required) User's role at partner. - `tmcPartnerRoleMappings.spotnanaRole` (string, required) Enum: "UNKNOWN_TYPE", "COMPANY_ADMIN", "COMPANY_TRAVEL_ARRANGER", "TRAVEL_ARRANGER", "COMPANY_REPORT_ADMIN", "GLOBAL_ADMIN", "GLOBAL_AGENT", "TMC_AGENT", "TMC_ADMIN" - `loyaltyBlockedCountries` (array) List of 2 letter country codes where business travelers should not be allowed to add loyalty info. Example: ["US","IN"] - `allowDomainBasedAuthConfig` (boolean) Whether to allow user to get auth config based on email domain - `carbonCostConfig` (object) The config is used to calculate carbon cost of CO2 emission. - `carbonCostConfig.price` (object, required) The price for the carbon emission per weight. - `carbonCostConfig.price.amount` (number, required) The numeric value for the amount of money. Example: 510 - `carbonCostConfig.price.currencyCode` (string, required) The 3-letter currency code for the money amount (defined using ISO 4217 standard). Example: "GBP" - `carbonCostConfig.price.convertedAmount` (number) The converted currency and amount that has been converted (if a currency conversion has been requested). For example, if the call requests that money be sent in a specified currency (because the frontend requested the backend to send money in the user's preferred currency). Example: 715.42 - `carbonCostConfig.price.convertedCurrency` (string) The 3-letter currency code for the converted currency (defined using ISO 4217 standard). Example: "USD" - `carbonCostConfig.price.otherCoinage` (array) List of the dollar amount in other coinage systems like reward points, cryptocurrency etc. - `carbonCostConfig.price.otherCoinage.coinageCode` (string) Payment method Enum: "PAYMENT_METHOD_UNKNOWN", "CREDIT_CARD", "BREX_POINTS", "CASH", "QANTAS_POINTS", "VENDOR_PROGRAM_PAYMENT", "DELAYED_INVOICING", "FLIGHT_CREDITS", "QANTAS_TRAVEL_FUND", "CUSTOM_VIRTUAL_PAYMENT", "FLIGHT_PASS", "MISCELLANEOUS_CREDIT_ORDER" - `carbonCostConfig.price.otherCoinage.amount` (number) Example: 1000 - `carbonCostConfig.price.otherCoinage.conversionRate` (number) 1 coin in this system equals to how many currency value Example: 0.01 - `carbonCostConfig.price.otherCoinage.preferredCurrencyConversionRate` (number) 1 coin in this system equals to how many currency value Example: 0.01 - `carbonCostConfig.weight` (object, required) The weight unit and amount to calculate cost of carbon emission. - `carbonCostConfig.weight.weight` (number, required) Amount of weight. Example: 150 - `carbonCostConfig.weight.unit` (string, required) Unit of weight. Enum: "KG", "LBS" - `defaultBookingTmcId` (object) Id of the default booking TMC for the company. - `supportConfig` (object) Support Configuration for company - `rewardsProgram` (object) Rewards Program corresponding to partner. It is applicable only for company roles 'PARTNER_TMC'. - `rewardsProgram.allowedUserRoles` (array) Roles entitled to redeem company's reward points. Enum: "UNKNOWN_TYPE", "COMPANY_ADMIN", "COMPANY_TRAVEL_ARRANGER", "TRAVEL_ARRANGER", "COMPANY_REPORT_ADMIN", "GLOBAL_ADMIN", "GLOBAL_AGENT", "TMC_AGENT", "TMC_ADMIN" - `rewardsProgram.conversionRate` (object) Conversion rate of points to specified currency. - `rewardsProgram.conversionRate.currencyCode` (string) The 3-letter currency code defined in ISO 4217. Example: "USD" - `rewardsProgram.conversionRate.rate` (number) Conversion rate of points to specified currency. - `rewardsProgram.redeemablePaymentMethods` (array) Payment methods to redeem company's reward points. Enum: "PAYMENT_METHOD_UNKNOWN", "CREDIT_CARD", "BREX_POINTS", "CASH", "QANTAS_POINTS", "VENDOR_PROGRAM_PAYMENT", "DELAYED_INVOICING", "FLIGHT_CREDITS", "QANTAS_TRAVEL_FUND", "CUSTOM_VIRTUAL_PAYMENT", "FLIGHT_PASS", "MISCELLANEOUS_CREDIT_ORDER" - `rewardsProgram.backingCurrency` (array) The currencies backing up this rewards program. Example: ["USD"] - `oauthPartnerConfig` (object) Config for token exchange in case of partner's have their own IDP. - `oauthPartnerConfig.name` (string, required) Name of the partner. - `oauthPartnerConfig.userDetailEndpoint` (object) Generic object to encapsulate information about any external endpoint. - `oauthPartnerConfig.userDetailEndpoint.url` (string, required) Url from where user can be fetched. - `oauthPartnerConfig.userDetailEndpoint.authHeaderName` (string, required) Auth header where we have to send authentication/authorization details. - `oauthPartnerConfig.userDetailEndpoint.userIdentifierType` (string) Either use pid or email as the identifier for auth code exchange process Enum: "PID", "EMAIL" - `oauthPartnerConfig.userDetailEndpoint.responseAttributes` (array) List of relevant attribute names & their json xpath from response - `oauthPartnerConfig.userDetailEndpoint.responseAttributes.name` (string, required) Attribute name Enum: "PID", "EMAIL" - `oauthPartnerConfig.userDetailEndpoint.responseAttributes.jsonXpath` (string, required) Json xpath of the Attribute/Parameter value location Example: "$.user.email" - `oauthPartnerConfig.tokenVerifier` (object, required) Method to verify the external token sent by partners. - `oauthPartnerConfig.tokenVerifier.doVerifyToken` (boolean, required) Token verification rules will be applied only if this is true. - `oauthPartnerConfig.tokenVerifier.type` (string) Method to verify the external token sent by partners. Enum: "OKTA_JWT" - `oauthPartnerConfig.tokenVerifier.verifierDetails` (any) - `oauthPartnerConfig.doPersistToken` (boolean, required) Boolean to define whether to persist(in-memory/disk) token or not. ## Response 201 fields (application/json): - `id` (string, required) Example: "b93dc51f-12dd-46c7-b7d6-1cb12cd3f5b3" ## Response 400 fields (application/json): - `debugIdentifier` (string) Link to debug the error internally. - `errorMessages` (array) - `errorMessages.errorCode` (string) Error code to identify the specific errors. - `errorMessages.message` (string) Message containing details of error. - `errorMessages.errorParameters` (array) Error message parameters. - `errorMessages.errorParameters.name` (string) Parameter name - `errorMessages.errorParameters.value` (string) Parameter value - `errorMessages.errorDetail` (string) More details about the error. ## Response 401 fields (application/json): - `debugIdentifier` (string) Link to debug the error internally. - `errorMessages` (array) - `errorMessages.errorCode` (string) Error code to identify the specific errors. - `errorMessages.message` (string) Message containing details of error. - `errorMessages.errorParameters` (array) Error message parameters. - `errorMessages.errorParameters.name` (string) Parameter name - `errorMessages.errorParameters.value` (string) Parameter value - `errorMessages.errorDetail` (string) More details about the error. ## Response 403 fields (application/json): - `debugIdentifier` (string) Link to debug the error internally. - `errorMessages` (array) - `errorMessages.errorCode` (string) Error code to identify the specific errors. - `errorMessages.message` (string) Message containing details of error. - `errorMessages.errorParameters` (array) Error message parameters. - `errorMessages.errorParameters.name` (string) Parameter name - `errorMessages.errorParameters.value` (string) Parameter value - `errorMessages.errorDetail` (string) More details about the error.