Dev GuideAPI ReferenceUser Guide
Dev GuideAPI Reference
Dev GuideAPI ReferenceUser GuideLegal TermsGitHubDev CommunityOptimizely AcademySubmit a ticketLog In
Dev Guide
Legal TermsGitHubDev CommunityOptimizely AcademySubmit a ticket

Account pipeline

Suggest Edits

AssignCustomer

OrderPipeDescription
100AssignCustomerIf customer is not yet assigned to user then assign customer.

CreateGetAccountResult

OrderPipeDescription
100CreateGetAccountResultCreates GetAccountResult object and fills next fields:

UserProfile - uses parameter.UserProfile

IsSubscribed - checks if parameter.UserProfile.Email is subscribed to list

IsLockedOut - uses parameter.UserProfile.

IsDeactivatedCanApproveOrders - checks that user has one of next roles: Administrator or Buyer3

CanViewApprovalOrders - checks that user has one of next roles: Administrator, Buyer1, Buyer2, Buyer3

Role - uses first user standard role
200CopyCustomPropertiesToResultCopies custom properties from parameter.UserProfile to createdGetAccountResult.

GetCustomLandingPage

OrderPipeDescription
100GetCustomLandingPageReturns custom landing page for specified customer. If customer is not specified then returns null. If customer CustomLandingPage property is blank then returns empty string. Else returns customer CustomLandingPage property. If user located at microsite then microsite prefix will be added to page url.

GetRoleName

OrderPipeDescription
100GetRoleNameReturns first standard role which user has. If user has no standard roles then returns empty string.

GetRoles

OrderPipeDescription
100GetRolesReturns GetRolesResult object with next fields:
  • StandardRoles - list of all standard roles. It includes Administrator, also if budged management is enabled it includes Buyer1, Buyer2 and Buyer3, also if requisitions is enabled then it includes Requisitioner
  • RolesThatCanBeApprovers - Administrator, Buyer3
  • RolesThatRequireApprover - Requisitioner, Buyer1, Buyer2
  • RolesThatCanViewApprovals - Administrator, Buyer1, Buyer2, Buyer3
  • RolesThatCanViewUsers - Administrator
  • RolesThatCanAddUsers - Administrator
  • RolesThatCanUpdateUsers - Administrator

SetRole

OrderPipeDescription
100SetRoleSets role to user. A user can only be assigned to one standard role, so if the role to set is one of the standard roles removes the current standard role and adds the new one.

UnassignCustomer

OrderPipeDescription
100UnassignCustomerUnassigns specified customer from specified user if user has this customer.

Updated over 1 year ago

Next