Sitecore OrderCloud Documentation

docs

Portal login

Create or update a user.

PUT

/buyers/{buyerID}/users/{userID}

200

Description

If an object with the same ID already exists, it will be overwritten.

Roles

At least one of the roles below is required to access this endpoint.

FullAccessBuyerUserAdmin

Parameters

NameTypeDescriptionPossible Values
buyerIDRequiredstringID of the buyer.---
userIDRequiredstringID of the user.---

Request Body

PropertyTypeFormatMax LengthPossible Values
IDstring---100 characters---
UsernameRequiredstring---100 characters---

Passwordstringpassword------
FirstNameRequiredstring---100 characters---
LastNameRequiredstring---100 characters---
EmailRequiredstring---200 characters---
Phonestring---100 characters---
TermsAcceptedstringdate-time------
ActiveRequiredboolean---------

xpobject---------

Response Body

PropertyTypeFormatMax LengthPossible Values
IDstring---100 characters---
CompanyIDRead Onlystring---------
Usernamestring---100 characters---

Passwordstringpassword------
FirstNamestring---100 characters---
LastNamestring---100 characters---
Emailstring---200 characters---
Phonestring---100 characters---
TermsAcceptedstringdate-time------
Activeboolean---------

xpobject---------
AvailableRolesRead Onlyarray---------

LocaleRead Onlyobject---------

DateCreatedRead Onlystringdate-time------
PasswordLastSetDateRead Onlystringdate-time------

Create or update a user.

PUT

/buyers/{buyerID}/users/{userID}

200

Description

If an object with the same ID already exists, it will be overwritten.

Roles

At least one of the roles below is required to access this endpoint.

FullAccessBuyerUserAdmin

Parameters

NameTypeDescriptionPossible Values
buyerIDRequiredstringID of the buyer.---
userIDRequiredstringID of the user.---

Request Body

PropertyTypeFormatMax LengthPossible Values
IDstring---100 characters---
UsernameRequiredstring---100 characters---

Passwordstringpassword------
FirstNameRequiredstring---100 characters---
LastNameRequiredstring---100 characters---
EmailRequiredstring---200 characters---
Phonestring---100 characters---
TermsAcceptedstringdate-time------
ActiveRequiredboolean---------

xpobject---------

Response Body

PropertyTypeFormatMax LengthPossible Values
IDstring---100 characters---
CompanyIDRead Onlystring---------
Usernamestring---100 characters---

Passwordstringpassword------
FirstNamestring---100 characters---
LastNamestring---100 characters---
Emailstring---200 characters---
Phonestring---100 characters---
TermsAcceptedstringdate-time------
Activeboolean---------

xpobject---------
AvailableRolesRead Onlyarray---------

LocaleRead Onlyobject---------

DateCreatedRead Onlystringdate-time------
PasswordLastSetDateRead Onlystringdate-time------

Sitecore Logo

© Copyright 2024, Sitecore OrderCloud®. All rights reserved.

Contact Us
Privacy Policy
Sitecore