Profile

Use these operations to manage user profiles. A profile represents the person that is signed in to Rebilly.
Operations

Retrieve user's own profile

Request

Retrieves the user's own profile as requested by the user.
Security
SecretApiKey or JWT
curl -i -X GET \
  https://www.rebilly.com/_mock/catalog/all/profile \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'

Responses

Profile retrieved.
Bodyapplication/json
idstring, <= 50 characters(ResourceId)read-only
ID of the user.
Example:"4f6cf35x-2c4y-483z-a0a9-158621f77a21"
emailstring, (email), <= 100 charactersread-only
Email address of the user.
firstNamestringread-only
User's first name.
lastNamestringread-only
User's last name.
businessPhonestring or nullread-only
User's business phone number.
mobilePhonestring or nullread-only
User's mobile phone number.
permissionsArray of strings, (operationId)(AclPermissions)read-only

Permissions that the user has within organizations. Use the wildcard character * for full access.

Example:
[
  "PostFile",
  "StorefrontGetAccount",
  "StorefrontGetWebsite",
  "StorefrontGetKycDocument",
  "StorefrontPostKycDocument"
]
createdTimestring, (date-time)(CreatedTime)read-only
Date and time when the resource is created. This value is set automatically when the resource is created.
updatedTimestring, (date-time)(UpdatedTime)read-only
Date and time when the resource is updated. This value is set automatically when the resource is updated.
availableCurrenciesArray of stringsread-only
Array of reporting currencies that are enabled for the merchant.
reportingCurrencystringread-only
User's currency code in ISO 4217 format. This value is used for reports.
loginTimestring or null, (date-time)read-only
Date and time when the user last logged in.
statusstringread-only
Status of the user account.
Enum:"active""inactive""pending-confirmation"
countrystringread-only

User's country of residence in ISO 3166 alpha-2 country code. For examples, see ISO.org.

preferencesobject or null
User preferences, such as: timezone, language, and more. This is an object with custom properties.
hasPermissionsEmulationbooleanread-only
Specifies if the current user session has permissions emulation enabled.
mfaRequiredByOrganizationbooleanread-only

Specifies if the user is in an organization in the current environment that requires multi-factor authentication (MFA). Deactivated organizations are not included. The requirement is enforced on each request to an organization that requires MFA, regardless of this value. This value is false for API key and service account sessions.

Default:false
displayNamestringread-only
User's full display name.
hashstringread-only
Unique hash value that represents the user.
requiresCardOnFilebooleanread-only
Specifies whether the current organization must have a payment card on file before it can transact in the live environment.
Default:false
hasCardOnFilebooleanread-only
Specifies whether the current organization has an active payment card on file.
Default:false
billingManagementTokenstring or null, (password)read-only

Session token used to manage the payment method on file for a Rebilly subscription. This value is returned only to organization owners.

Treat as a secret. Do not log, do not expose in URLs, do not store in shared client storage.

pastDueInvoiceobject or nullread-only

Details of the oldest past-due invoice for the Rebilly subscription associated with the current organization. This value is returned to all organization members to support consistent enforcement of the billing gate. The token is returned only to organization owners.

_linksArray of objects(SelfLink)read-only
Related links.
Response
{
  "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  "email": "user@example.com",
  "firstName": "string",
  "lastName": "string",
  "businessPhone": "string",
  "mobilePhone": "string",
  "permissions": [
    "PostFile",
    "StorefrontGetAccount",
    "StorefrontGetWebsite",
    "StorefrontGetKycDocument",
    "StorefrontPostKycDocument"
  ],
  "createdTime": "2019-08-24T14:15:22Z",
  "updatedTime": "2019-08-24T14:15:22Z",
  "availableCurrencies": [
    "string"
  ],
  "reportingCurrency": "string",
  "loginTime": "2019-08-24T14:15:22Z",
  "status": "active",
  "country": "string",
  "preferences": {},
  "hasPermissionsEmulation": true,
  "mfaRequiredByOrganization": false,
  "displayName": "string",
  "hash": "string",
  "requiresCardOnFile": false,
  "hasCardOnFile": false,
  "billingManagementToken": "pa$$word",
  "pastDueInvoice": {
    "invoiceId": "string",
    "websiteId": "string",
    "token": "pa$$word"
  },
  "_links": [
    { … }
  ]
}