openapi: 3.2.0 info: version: admin-v1 title: Admin API V1 Admin User Profiles API servers: - url: https://dogfood.commerce.insitesandbox.com security: [] tags: - name: Admin User Profiles paths: /api/v1/admin/AdminUserProfiles: get: tags: - Admin User Profiles summary: Returns the EntitySet AdminUserProfiles operationId: AdminUserProfiles_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: - Admin User Profiles summary: Post a new entity to EntitySet AdminUserProfiles operationId: AdminUserProfiles_Post requestBody: content: application/json: schema: $ref: '#/components/schemas/Insite.Data.Entities.AdminUserProfile' description: The entity to post required: true responses: '200': description: OK content: '*/*': schema: type: object deprecated: false security: - access_token: [] /api/v1/admin/AdminUserProfiles({id}): get: tags: - Admin User Profiles summary: Returns the entity with the key from AdminUserProfiles operationId: AdminUserProfiles_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: - Admin User Profiles summary: Replace entity in EntitySet AdminUserProfiles operationId: AdminUserProfiles_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.AdminUserProfile' description: The entity to put required: true responses: '200': description: OK content: '*/*': schema: type: object deprecated: false security: - access_token: [] delete: tags: - Admin User Profiles summary: Delete entity in EntitySet AdminUserProfiles operationId: AdminUserProfiles_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: - Admin User Profiles summary: Update entity in EntitySet AdminUserProfiles operationId: AdminUserProfiles_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.AdminUserProfile' description: The entity to patch required: true responses: '200': description: OK content: '*/*': schema: type: object deprecated: false security: - access_token: [] /api/v1/admin/AdminUserProfiles/Default.Default(): get: tags: - Admin User Profiles summary: Call operation Default operationId: AdminUserProfiles_Default responses: '200': description: OK content: '*/*': schema: type: object deprecated: false security: - access_token: [] /api/v1/admin/AdminUserProfiles({id})/Default.Roles(): get: tags: - Admin User Profiles summary: Call operation Roles operationId: AdminUserProfiles_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/AdminUserProfiles/Default.Current(): get: tags: - Admin User Profiles summary: Call operation Current operationId: AdminUserProfiles_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/adminuserprofiles/current: get: tags: - Admin User Profiles operationId: AdminUserProfiles_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/adminuserprofiles({key})/roles: get: tags: - Admin User Profiles operationId: AdminUserProfiles_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: - Admin User Profiles operationId: AdminUserProfiles_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: - Admin User Profiles operationId: AdminUserProfiles_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: - Admin User Profiles operationId: AdminUserProfiles_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/adminuserprofiles/delete: delete: tags: - Admin User Profiles operationId: AdminUserProfiles_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/adminuserprofiles({key})/adminuserprofilepasswords({adminuserprofilepasswordKey}): get: tags: - Admin User Profiles operationId: AdminUserProfiles_GetAdminUserProfilePasswordByKeyAndAdminuserprofilepasswordkey parameters: - name: key in: path required: true schema: type: string format: uuid - name: adminuserprofilepasswordKey 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/adminuserprofiles({key})/adminuserprofilepreferences({adminuserprofilepreferenceKey}): get: tags: - Admin User Profiles operationId: AdminUserProfiles_GetAdminUserProfilePreferenceByKeyAndAdminuserprofilepreferencekey parameters: - name: key in: path required: true schema: type: string format: uuid - name: adminuserprofilepreferenceKey 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/adminuserprofiles({key})/customproperties({custompropertyKey}): get: tags: - Admin User Profiles operationId: AdminUserProfiles_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/adminuserprofiles({key})/websites({websiteKey}): get: tags: - Admin User Profiles operationId: AdminUserProfiles_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: [] components: requestBodies: AdminUserProfiles_SetRolesByKey_1Roles: content: application/json: schema: type: array items: type: string required: true schemas: ODataResponseStringList: type: object properties: '@odata.context': type: string value: type: array items: type: string Insite.Data.Entities.AdminUserProfile: required: - userName - firstName - lastName - company - phone - extension - fax - position - email - activationStatus - defaultAdminConsoleLanguageCode 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 email: maxLength: 256 minLength: 0 type: string activationStatus: maxLength: 50 minLength: 0 type: string passwordChangedOn: format: date-time type: string isPasswordChangeRequired: type: boolean lastLoginOn: format: date-time type: string isDeactivated: type: boolean lastReactivatedOn: format: date-time type: string lastActivationEmailSentOn: format: date-time type: string piiRegionId: format: uuid type: string example: 00000000-0000-0000-0000-000000000000 exemptFromSsoOnlyLoginPolicy: type: boolean defaultAdminConsoleLanguageCode: type: string createdOn: format: date-time type: string createdBy: type: string modifiedOn: format: date-time type: string modifiedBy: type: string securitySchemes: access_token: type: apiKey description: Token used to access storefront API. name: access_token in: query