platform/adminuser/accounts

The Accounts resource displays the user accounts and account details associated with a developer or Kibo eCommerce tenant administrator. Email addresses uniquely identify admin user accounts.

JSON Example

User Properties

Property Description
emailAddress

type: string

The email address for the customer account and contact. This email may be used for login to the storefront and for subscription mailing lists.

firstName

type: string

The full first name of a customer or contact name.

id

type: string

Unique identifier of the source property, such as a catalog, discount, order, or email template.

For a product field it will be the name of the field.

For a category ID, must be a positive integer not greater than 2000000. By default, Kibo eCommerce auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the useProvidedId query string in the endpoint. For example, api/commerce/catalog/admin/categories/?useProvidedId=true. Then, use the id property to specify the desired category ID.

For a product attribute it will be the Attribute FQN.

For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, bba0a1a885e2413bb097ceacf7bac366
or
bba0a1a8-85e2-413b-b097-ceacf7bac366.

For email templates, the ID must be one of the following values:
BackInStock
OrderChanged
OrderShipped
OrderFulfillmentDetailsChanged
ShopperLoginCreated
ShopperPasswordReset
ReturnCreated
ReturnAuthorized
ReturnUpdated
ReturnRejected
ReturnCancelled
ReturnClosed
RefundCreated
StoreCreditCreated
StoreCreditUpdated
GiftCardCreated

lastName

type: string

The full last name of a customer or contact name.

localeCode

type: string

The two character locale code, per the country code provided. This code determines the localized content to use and display.

password

type: string

The write-only password for the customer account.

Operations

Operation Name Request URI Description
GetTenantScopesForUser GET %7buserId%7d%2ftenants%3fresponseFields%3d%7bresponseFields%7d

Retrieves a list of the Kibo eCommerce tenants or development stores for which the specified user has an assigned role.

GetUser GET %7buserId%7d%3fresponseFields%3d%7bresponseFields%7d

Retrieves the details of the specified administrator user account.