openapi: 3.2.0 info: version: admin-v1 title: Admin API V1 User Profiles API servers: - url: https://dogfood.commerce.insitesandbox.com security: [] tags: - name: User Profiles paths: /api/v1/admin/UserProfiles: get: tags: - User Profiles summary: Returns the EntitySet UserProfiles operationId: UserProfiles_Get parameters: - name: $expand in: query description: Expands related entities inline. required: false schema: type: string - name: $filter in: query description: Filters the results, based on a Boolean condition. required: false schema: type: string - name: $select in: query description: Selects which properties to include in the response. required: false schema: type: string - name: $apply in: query description: Aggregates the results according to one or more transformations. required: false schema: type: string - name: $orderby in: query description: Sorts the results. required: false schema: type: string - name: $top in: query description: Returns only the first n results. required: false schema: type: integer format: int32 - name: $skip in: query description: Skips the first n results. required: false schema: type: integer format: int32 - name: $count in: query description: Includes a count of the matching results in the response. required: false schema: type: boolean responses: '200': description: OK content: '*/*': schema: type: object deprecated: false security: - access_token: [] post: tags: - User Profiles summary: Post a new entity to EntitySet UserProfiles operationId: UserProfiles_Post requestBody: content: application/json: schema: $ref: '#/components/schemas/Insite.Data.Entities.UserProfile' description: The entity to post required: true responses: '200': description: OK content: '*/*': schema: type: object deprecated: false security: - access_token: [] /api/v1/admin/UserProfiles({id}): get: tags: - User Profiles summary: Returns the entity with the key from UserProfiles operationId: UserProfiles_GetById parameters: - name: id in: path description: 'key: id' required: true schema: type: string format: uuid - name: $expand in: query description: Expands related entities inline. required: false schema: type: string - name: $select in: query description: Selects which properties to include in the response. required: false schema: type: string responses: '200': description: OK content: '*/*': schema: type: object deprecated: false security: - access_token: [] put: tags: - User Profiles summary: Replace entity in EntitySet UserProfiles operationId: UserProfiles_PutById parameters: - name: id in: path description: 'key: id' required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: '#/components/schemas/Insite.Data.Entities.UserProfile' description: The entity to put required: true responses: '200': description: OK content: '*/*': schema: type: object deprecated: false security: - access_token: [] delete: tags: - User Profiles summary: Delete entity in EntitySet UserProfiles operationId: UserProfiles_DeleteById parameters: - name: id in: path description: 'key: id' required: true schema: type: string format: uuid - name: If-Match in: header description: If-Match header required: false schema: type: string responses: '200': description: OK content: '*/*': schema: type: object deprecated: false security: - access_token: [] patch: tags: - User Profiles summary: Update entity in EntitySet UserProfiles operationId: UserProfiles_PatchById parameters: - name: id in: path description: 'key: id' required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: '#/components/schemas/Insite.Data.Entities.UserProfile' description: The entity to patch required: true responses: '200': description: OK content: '*/*': schema: type: object deprecated: false security: - access_token: [] /api/v1/admin/UserProfiles/Default.Default(): get: tags: - User Profiles summary: Call operation Default operationId: UserProfiles_Default responses: '200': description: OK content: '*/*': schema: type: object deprecated: false security: - access_token: [] /api/v1/admin/UserProfiles({id})/Default.Roles(): get: tags: - User Profiles summary: Call operation Roles operationId: UserProfiles_GetRolesById parameters: - name: id in: path description: 'key: id' required: true schema: type: string format: uuid - name: $expand in: query description: Expands related entities inline. required: false schema: type: string - name: $filter in: query description: Filters the results, based on a Boolean condition. required: false schema: type: string - name: $select in: query description: Selects which properties to include in the response. required: false schema: type: string - name: $apply in: query description: Aggregates the results according to one or more transformations. required: false schema: type: string - name: $orderby in: query description: Sorts the results. required: false schema: type: string - name: $top in: query description: Returns only the first n results. required: false schema: type: integer format: int32 - name: $skip in: query description: Skips the first n results. required: false schema: type: integer format: int32 - name: $count in: query description: Includes a count of the matching results in the response. required: false schema: type: boolean responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ODataResponseStringList' deprecated: false security: - access_token: [] /api/v1/admin/UserProfiles/Default.Current(): get: tags: - User Profiles summary: Call operation Current operationId: UserProfiles_Current_1 parameters: - name: $expand in: query description: Expands related entities inline. required: false schema: type: string - name: $select in: query description: Selects which properties to include in the response. required: false schema: type: string responses: '200': description: OK content: '*/*': schema: type: object deprecated: false security: - access_token: [] /api/v1/admin/userprofiles/current: get: tags: - User Profiles operationId: UserProfiles_Current_2 parameters: - name: $expand in: query description: Expands related entities inline. required: false schema: type: string - name: $select in: query description: Selects which properties to include in the response. required: false schema: type: string responses: '200': description: OK content: '*/*': schema: type: object deprecated: false security: - access_token: [] /api/v1/admin/userprofiles({key})/roles: get: tags: - User Profiles operationId: UserProfiles_GetRolesByKey parameters: - name: key in: path required: true schema: type: string format: uuid - name: $expand in: query description: Expands related entities inline. required: false schema: type: string - name: $filter in: query description: Filters the results, based on a Boolean condition. required: false schema: type: string - name: $select in: query description: Selects which properties to include in the response. required: false schema: type: string - name: $apply in: query description: Aggregates the results according to one or more transformations. required: false schema: type: string - name: $orderby in: query description: Sorts the results. required: false schema: type: string - name: $top in: query description: Returns only the first n results. required: false schema: type: integer format: int32 - name: $skip in: query description: Skips the first n results. required: false schema: type: integer format: int32 - name: $count in: query description: Includes a count of the matching results in the response. required: false schema: type: boolean responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ODataResponseStringList' deprecated: false security: - access_token: [] put: tags: - User Profiles operationId: UserProfiles_SetRolesByKey_1 parameters: - name: key in: path required: true schema: type: string format: uuid requestBody: $ref: '#/components/requestBodies/AdminUserProfiles_SetRolesByKey_1Roles' responses: '200': description: OK content: '*/*': schema: type: object deprecated: false security: - access_token: [] post: tags: - User Profiles operationId: UserProfiles_SetRolesByKey_2 parameters: - name: key in: path required: true schema: type: string format: uuid requestBody: $ref: '#/components/requestBodies/AdminUserProfiles_SetRolesByKey_1Roles' responses: '200': description: OK content: '*/*': schema: type: object deprecated: false security: - access_token: [] delete: tags: - User Profiles operationId: UserProfiles_DeleteRolesByKey parameters: - name: key in: path required: true schema: type: string format: uuid requestBody: $ref: '#/components/requestBodies/AdminUserProfiles_SetRolesByKey_1Roles' responses: '200': description: OK content: '*/*': schema: type: object deprecated: false security: - access_token: [] /api/v1/admin/userprofiles({key})/allowedwebsites: get: tags: - User Profiles operationId: UserProfiles_AllowedWebsitesByKey parameters: - name: key in: path required: true schema: type: string format: uuid - name: $expand in: query description: Expands related entities inline. required: false schema: type: string - name: $filter in: query description: Filters the results, based on a Boolean condition. required: false schema: type: string - name: $select in: query description: Selects which properties to include in the response. required: false schema: type: string - name: $apply in: query description: Aggregates the results according to one or more transformations. required: false schema: type: string - name: $orderby in: query description: Sorts the results. required: false schema: type: string - name: $top in: query description: Returns only the first n results. required: false schema: type: integer format: int32 - name: $skip in: query description: Skips the first n results. required: false schema: type: integer format: int32 - name: $count in: query description: Includes a count of the matching results in the response. required: false schema: type: boolean responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ODataResponseWebsiteList' deprecated: false security: - access_token: [] /api/v1/admin/userprofiles({key})/approvers: get: tags: - User Profiles operationId: UserProfiles_ApproversByKey parameters: - name: key in: path required: true schema: type: string format: uuid - name: $expand in: query description: Expands related entities inline. required: false schema: type: string - name: $filter in: query description: Filters the results, based on a Boolean condition. required: false schema: type: string - name: $select in: query description: Selects which properties to include in the response. required: false schema: type: string - name: $apply in: query description: Aggregates the results according to one or more transformations. required: false schema: type: string - name: $orderby in: query description: Sorts the results. required: false schema: type: string - name: $top in: query description: Returns only the first n results. required: false schema: type: integer format: int32 - name: $skip in: query description: Skips the first n results. required: false schema: type: integer format: int32 - name: $count in: query description: Includes a count of the matching results in the response. required: false schema: type: boolean responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ODataResponseUserProfileList' deprecated: false security: - access_token: [] /api/v1/admin/userprofiles({key})/availablecustomers: get: tags: - User Profiles operationId: UserProfiles_AvailableCustomersByKey parameters: - name: key in: path required: true schema: type: string format: uuid - name: $expand in: query description: Expands related entities inline. required: false schema: type: string - name: $filter in: query description: Filters the results, based on a Boolean condition. required: false schema: type: string - name: $select in: query description: Selects which properties to include in the response. required: false schema: type: string - name: $apply in: query description: Aggregates the results according to one or more transformations. required: false schema: type: string - name: $orderby in: query description: Sorts the results. required: false schema: type: string - name: $top in: query description: Returns only the first n results. required: false schema: type: integer format: int32 - name: $skip in: query description: Skips the first n results. required: false schema: type: integer format: int32 - name: $count in: query description: Includes a count of the matching results in the response. required: false schema: type: boolean responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ODataResponseCustomerList' deprecated: false security: - access_token: [] /api/v1/admin/userprofiles/delete: delete: tags: - User Profiles operationId: UserProfiles_DeleteRoute parameters: - name: ids in: query required: true explode: true schema: type: array items: type: string format: uuid responses: '200': description: OK content: '*/*': schema: type: object deprecated: false security: - access_token: [] /api/v1/admin/userprofiles({key})/customers({customerKey}): get: tags: - User Profiles operationId: UserProfiles_GetCustomerByKeyAndCustomerkey parameters: - name: key in: path required: true schema: type: string format: uuid - name: customerKey in: path required: true schema: type: string format: uuid - name: $expand in: query description: Expands related entities inline. required: false schema: type: string - name: $select in: query description: Selects which properties to include in the response. required: false schema: type: string responses: '200': description: OK content: '*/*': schema: type: object deprecated: false security: - access_token: [] /api/v1/admin/userprofiles({key})/customproperties({custompropertyKey}): get: tags: - User Profiles operationId: UserProfiles_GetCustomPropertyByKeyAndCustompropertykey parameters: - name: key in: path required: true schema: type: string format: uuid - name: custompropertyKey in: path required: true schema: type: string format: uuid - name: $expand in: query description: Expands related entities inline. required: false schema: type: string - name: $select in: query description: Selects which properties to include in the response. required: false schema: type: string responses: '200': description: OK content: '*/*': schema: type: object deprecated: false security: - access_token: [] /api/v1/admin/userprofiles({key})/dashboardpanelpositions({dashboardpanelpositionKey}): get: tags: - User Profiles operationId: UserProfiles_GetDashboardPanelPositionByKeyAndDashboardpanelpositionkey parameters: - name: key in: path required: true schema: type: string format: uuid - name: dashboardpanelpositionKey in: path required: true schema: type: string format: uuid - name: $expand in: query description: Expands related entities inline. required: false schema: type: string - name: $select in: query description: Selects which properties to include in the response. required: false schema: type: string responses: '200': description: OK content: '*/*': schema: type: object deprecated: false security: - access_token: [] /api/v1/admin/userprofiles({key})/emaillists({emaillistKey}): get: tags: - User Profiles operationId: UserProfiles_GetEmailListByKeyAndEmaillistkey parameters: - name: key in: path required: true schema: type: string format: uuid - name: emaillistKey in: path required: true schema: type: string format: uuid - name: $expand in: query description: Expands related entities inline. required: false schema: type: string - name: $select in: query description: Selects which properties to include in the response. required: false schema: type: string responses: '200': description: OK content: '*/*': schema: type: object deprecated: false security: - access_token: [] /api/v1/admin/userprofiles({key})/messagestatuses({messagestatusKey}): get: tags: - User Profiles operationId: UserProfiles_GetMessageStatusByKeyAndMessagestatuskey parameters: - name: key in: path required: true schema: type: string format: uuid - name: messagestatusKey in: path required: true schema: type: string format: uuid - name: $expand in: query description: Expands related entities inline. required: false schema: type: string - name: $select in: query description: Selects which properties to include in the response. required: false schema: type: string responses: '200': description: OK content: '*/*': schema: type: object deprecated: false security: - access_token: [] /api/v1/admin/userprofiles({key})/odppersonas({personaKey}): get: tags: - User Profiles operationId: UserProfiles_GetOdpPersonaByKeyAndPersonakey parameters: - name: key in: path required: true schema: type: string format: uuid - name: personaKey in: path required: true schema: type: string format: uuid - name: $expand in: query description: Expands related entities inline. required: false schema: type: string - name: $select in: query description: Selects which properties to include in the response. required: false schema: type: string responses: '200': description: OK content: '*/*': schema: type: object deprecated: false security: - access_token: [] /api/v1/admin/userprofiles({key})/salespersons({salespersonKey}): get: tags: - User Profiles operationId: UserProfiles_GetSalespersonByKeyAndSalespersonkey parameters: - name: key in: path required: true schema: type: string format: uuid - name: salespersonKey in: path required: true schema: type: string format: uuid - name: $expand in: query description: Expands related entities inline. required: false schema: type: string - name: $select in: query description: Selects which properties to include in the response. required: false schema: type: string responses: '200': description: OK content: '*/*': schema: type: object deprecated: false security: - access_token: [] /api/v1/admin/userprofiles({key})/userpaymentprofiles({userpaymentprofileKey}): get: tags: - User Profiles operationId: UserProfiles_GetUserPaymentProfileByKeyAndUserpaymentprofilekey parameters: - name: key in: path required: true schema: type: string format: uuid - name: userpaymentprofileKey in: path required: true schema: type: string format: uuid - name: $expand in: query description: Expands related entities inline. required: false schema: type: string - name: $select in: query description: Selects which properties to include in the response. required: false schema: type: string responses: '200': description: OK content: '*/*': schema: type: object deprecated: false security: - access_token: [] /api/v1/admin/userprofiles({key})/userprofilepasswords({userprofilepasswordKey}): get: tags: - User Profiles operationId: UserProfiles_GetUserProfilePasswordByKeyAndUserprofilepasswordkey parameters: - name: key in: path required: true schema: type: string format: uuid - name: userprofilepasswordKey in: path required: true schema: type: string format: uuid - name: $expand in: query description: Expands related entities inline. required: false schema: type: string - name: $select in: query description: Selects which properties to include in the response. required: false schema: type: string responses: '200': description: OK content: '*/*': schema: type: object deprecated: false security: - access_token: [] /api/v1/admin/userprofiles({key})/userprofilewishlistfavorites({userprofilewishlistfavoriteKey}): get: tags: - User Profiles operationId: UserProfiles_GetUserProfileWishListFavoriteByKeyAndUserprofilewishlistfavoritekey parameters: - name: key in: path required: true schema: type: string format: uuid - name: userprofilewishlistfavoriteKey in: path required: true schema: type: string format: uuid - name: $expand in: query description: Expands related entities inline. required: false schema: type: string - name: $select in: query description: Selects which properties to include in the response. required: false schema: type: string responses: '200': description: OK content: '*/*': schema: type: object deprecated: false security: - access_token: [] /api/v1/admin/userprofiles({key})/userprofilewishlisthides({userprofilewishlisthideKey}): get: tags: - User Profiles operationId: UserProfiles_GetUserProfileWishListHideByKeyAndUserprofilewishlisthidekey parameters: - name: key in: path required: true schema: type: string format: uuid - name: userprofilewishlisthideKey in: path required: true schema: type: string format: uuid - name: $expand in: query description: Expands related entities inline. required: false schema: type: string - name: $select in: query description: Selects which properties to include in the response. required: false schema: type: string responses: '200': description: OK content: '*/*': schema: type: object deprecated: false security: - access_token: [] /api/v1/admin/userprofiles({key})/userprofilewishlisttags({userprofilewishlisttagKey}): get: tags: - User Profiles operationId: UserProfiles_GetUserProfileWishListTagByKeyAndUserprofilewishlisttagkey parameters: - name: key in: path required: true schema: type: string format: uuid - name: userprofilewishlisttagKey in: path required: true schema: type: string format: uuid - name: $expand in: query description: Expands related entities inline. required: false schema: type: string - name: $select in: query description: Selects which properties to include in the response. required: false schema: type: string responses: '200': description: OK content: '*/*': schema: type: object deprecated: false security: - access_token: [] /api/v1/admin/userprofiles({key})/websites({websiteKey}): get: tags: - User Profiles operationId: UserProfiles_GetWebsiteByKeyAndWebsitekey parameters: - name: key in: path required: true schema: type: string format: uuid - name: websiteKey in: path required: true schema: type: string format: uuid - name: $expand in: query description: Expands related entities inline. required: false schema: type: string - name: $select in: query description: Selects which properties to include in the response. required: false schema: type: string responses: '200': description: OK content: '*/*': schema: type: object deprecated: false security: - access_token: [] /api/v1/admin/userprofiles({key})/wishlistproducts({wishlistproductKey}): get: tags: - User Profiles operationId: UserProfiles_GetWishListProductByKeyAndWishlistproductkey parameters: - name: key in: path required: true schema: type: string format: uuid - name: wishlistproductKey in: path required: true schema: type: string format: uuid - name: $expand in: query description: Expands related entities inline. required: false schema: type: string - name: $select in: query description: Selects which properties to include in the response. required: false schema: type: string responses: '200': description: OK content: '*/*': schema: type: object deprecated: false security: - access_token: [] /api/v1/admin/userprofiles({key})/wishlists({wishlistKey}): get: tags: - User Profiles operationId: UserProfiles_GetWishListByKeyAndWishlistkey parameters: - name: key in: path required: true schema: type: string format: uuid - name: wishlistKey in: path required: true schema: type: string format: uuid - name: $expand in: query description: Expands related entities inline. required: false schema: type: string - name: $select in: query description: Selects which properties to include in the response. required: false schema: type: string responses: '200': description: OK content: '*/*': schema: type: object deprecated: false security: - access_token: [] components: schemas: Insite.Data.Entities.UserProfile: required: - userName - firstName - lastName - company - phone - extension - fax - position - activationStatus - email - defaultFulfillmentMethod type: object properties: id: format: uuid type: string example: 00000000-0000-0000-0000-000000000000 userName: maxLength: 256 minLength: 0 type: string firstName: maxLength: 100 minLength: 0 type: string lastName: maxLength: 100 minLength: 0 type: string company: maxLength: 100 minLength: 0 type: string phone: maxLength: 50 minLength: 0 type: string extension: maxLength: 50 minLength: 0 type: string fax: maxLength: 50 minLength: 0 type: string position: maxLength: 100 minLength: 0 type: string activationStatus: maxLength: 50 minLength: 0 type: string isGuest: type: boolean email: maxLength: 256 minLength: 0 type: string recentlyViewedProducts: type: string defaultCustomerId: format: uuid type: string example: 00000000-0000-0000-0000-000000000000 approverUserProfileId: format: uuid type: string example: 00000000-0000-0000-0000-000000000000 limitExceededNotification: type: boolean dashboardIsHomepage: type: boolean currencyId: format: uuid type: string example: 00000000-0000-0000-0000-000000000000 isPasswordChangeRequired: type: boolean hasRfqUpdates: type: boolean languageId: format: uuid type: string example: 00000000-0000-0000-0000-000000000000 passwordChangedOn: format: date-time type: string rolesChangedOn: format: date-time type: string lastLoginOn: format: date-time type: string lastActivityDate: format: date-time type: string isDeactivated: type: boolean lastReactivatedOn: format: date-time type: string lastActivationEmailSentOn: format: date-time type: string defaultWarehouseId: format: uuid type: string example: 00000000-0000-0000-0000-000000000000 defaultFulfillmentMethod: maxLength: 50 minLength: 0 type: string emailOptOutAbandonedCart: type: boolean punchOutAcceptPriceProvided: type: boolean punchOutUseProvidedShipToId: type: boolean carryOverUnusedMonthlyBalances: type: boolean displayPricingAndInventory: type: boolean exemptFromSsoOnlyLoginPolicy: type: boolean createdOn: format: date-time type: string createdBy: type: string modifiedOn: format: date-time type: string modifiedBy: type: string ODataResponseUserProfileList: type: object properties: '@odata.context': type: string ODataResponseCustomerList: type: object properties: '@odata.context': type: string ODataResponseStringList: type: object properties: '@odata.context': type: string value: type: array items: type: string ODataResponseWebsiteList: type: object properties: '@odata.context': type: string requestBodies: AdminUserProfiles_SetRolesByKey_1Roles: content: application/json: schema: type: array items: type: string required: true securitySchemes: access_token: type: apiKey description: Token used to access storefront API. name: access_token in: query