Sitecore API catalog/OrderCloud/Me

Me

Endpoints for managing the currently authenticated user's profile and information.

Operations

Get the currently authenticated user

Request

Security
OAuth2
curl -i -X GET \
  https://api.ordercloud.io/v1/me \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json
Buyerobject(MeBuyer)read-only
Example:
{
  "ID": "",
  "DefaultCatalogID": ""
}
Supplierobject(MeSupplier)read-only
Example:
{
  "ID": ""
}
Sellerobject(MeSeller)read-only
Example:
{
  "ID": ""
}
IDstring, <= 100 characters
Example:""
CompanyIDstringread-only
Example:""
Usernamestring, <= 100 characters

Must be unique across all organizations.

Example:""
Passwordstring, (password)
Example:""
FirstNamestring, <= 100 characters
Example:""
LastNamestring, <= 100 characters
Example:""
Emailstring, <= 200 characters
Example:""
Phonestring, <= 100 characters
Example:""
TermsAcceptedstring, (date-time)
Example:"2018-01-01T00:00:00-06:00"
Activeboolean

If false, authentication is prohibited.

Example:false
xpobject
Example:
{}
AvailableRolesArray of stringsread-only

List of roles currently available to the user via all security profile assignments.

Example:
[
  ""
]
Localeobject(Locale)read-only

Most specific locale assigned to the user, if any.

Example:
{
  "ID": "",
  "OwnerID": "",
  "Currency": "",
  "Language": ""
}
DateCreatedstring, (date-time)read-only
Example:"2018-01-01T00:00:00-06:00"
LastActivestring, (date-time)read-only

Accurate within a few minutes. Includes impersonation activity.

Example:"2018-01-01T00:00:00-06:00"
PasswordLastSetDatestring, (date-time)read-only

Can be used in conjunction with SecurityProfile.PasswordConfig to enforce password reset schedules.

Example:"2018-01-01T00:00:00-06:00"
Response
{
  "Buyer": {
    "ID": "",
    "DefaultCatalogID": ""
  },
  "Supplier": {
    "ID": ""
  },
  "Seller": {
    "ID": ""
  },
  "ID": "",
  "CompanyID": "",
  "Username": "",
  "Password": "",
  "FirstName": "",
  "LastName": "",
  "Email": "",
  "Phone": "",
  "TermsAccepted": "2018-01-01T00:00:00-06:00",
  "Active": false,
  "xp": {},
  "AvailableRoles": [
    ""
  ],
  "Locale": {
    "ID": "",
    "OwnerID": "",
    "Currency": "",
    "Language": ""
  },
  "DateCreated": "2018-01-01T00:00:00-06:00",
  "LastActive": "2018-01-01T00:00:00-06:00",
  "PasswordLastSetDate": "2018-01-01T00:00:00-06:00"
}