Authenticated User

Description

The authenticated user.

Properties

Property Description
created read-only

The date on which this user was created.

email

The email address for this user.

firstName

The first name for this user.

id

The identifier for this user.

isStudioOwner read-only

Whether the authenticated user is the owner of the studio.

lastLogin nullable read-only

The date on which this user last logged in to the Studio Panel.

lastName

The last name for this user.

links required read-only

Each property defines a hypertext link relationship as indicated by a link object or array of link objects. The target URL of each hypertext link relationship is related to the current resource according to the defined semantics of the link relationship property name.

name

The full name for this user.

permissions

An array of permission identifiers indicating the permission levels this user has within the Studio Panel.

Permission Description
account.payment-read The user may view the studio account's plan & billing information.
account.payment-withdrawal The user may request payment withdrawals on behalf of the studio.
account.read The user may view studio account settings (e.g. contact info, users, etc.).
account.update The user may update studio account settings (e.g. contact info, users, etc.).
brand-theme.create The user may create themes.
brand-theme.read The user may view themes.
brand-theme.update The user may edit themes.
brand.homepage-update The user may edit the client galleries homepage for a brand.
contact.create The user may create contacts.
contact.read The user may view contacts.
contact.update The user may edit contacts.
contract.create The user may create contracts.
contract.read The user may view contracts.
contract.update The user may edit contracts.
email-template.create The user may create email templates and automation groups.
email-template.read The user may view email templates and automation groups.
email-template.update The user may edit email templates and automation groups.
event-defaults.create The user may create default settings for events.
event-defaults.read The user may view default settings for events.
event-defaults.update The user may edit default settings for events.
event-photo.create The user may create event photos.
event-photo.update The user may edit event photos.
event.create The user may create events.
event.created-only The user may only view/edit/delete events they created.
event.delete The user may delete events.
event.read The user may view events.
event.update The user may edit events.
invoice.create The user may create invoices.
invoice.read The user may view invoices.
invoice.update The user may edit invoices.
mobile-app.create The user may create mobile apps.
mobile-app.read The user may view mobile apps.
mobile-app.update The user may edit mobile apps.
order.read The user may view orders.
order.update The user may edit orders.
playlist.read The user may view music playlists.
playlist.update The user may edit music playlists.
price-sheet.create The user may create price sheets.
price-sheet.read The user may view price sheets.
price-sheet.update The user may edit price sheets.
report.event-visitors-read The user may view the "Event Visitors" report.
report.invoices-read The user may view the "Invoices" report.
report.items-read The user may view the "Top-Selling Items" report.
report.orders-read The user may view the "Orders" report.
report.sales-read The user may view the "Sales" report.
tool.read The user may view the available downloadable tools (i.e. Desktop Uploader).
watermark.create The user may create watermarks.
watermark.read The user may view watermarks.
watermark.update The user may edit watermarks.
signature

A signature.

studio read-only

The studio to which the authenticated user belongs.

type

The type of object represented.

userStatus read-only

A human-readable string describing this user's status.

userStatusId

The numeric identifier for this user's status.

OpenAPI Schema

The following schema is based on OpenAPI 3.0 and is provided in our downloadable OpenAPI document.

{
  "description": "The authenticated user.",
  "properties": {
    "created": {
      "description": "The date on which this user was created.",
      "format": "date-time",
      "readOnly": true,
      "type": "string"
    },
    "email": {
      "description": "The email address for this user.",
      "format": "email",
      "type": "string"
    },
    "firstName": {
      "description": "The first name for this user.",
      "type": "string"
    },
    "id": {
      "description": "The identifier for this user.",
      "type": "number"
    },
    "isStudioOwner": {
      "description": "Whether the authenticated user is the owner of the studio.",
      "readOnly": true,
      "type": "boolean"
    },
    "lastLogin": {
      "description": "The date on which this user last logged in to the Studio Panel.",
      "format": "date-time",
      "nullable": true,
      "readOnly": true,
      "type": "string"
    },
    "lastName": {
      "description": "The last name for this user.",
      "type": "string"
    },
    "links": {
      "$ref": "#/components/schemas/Links"
    },
    "name": {
      "description": "The full name for this user.",
      "type": "string"
    },
    "permissions": {
      "description": "An array of permission identifiers indicating the permission levels\nthis user has within the Studio Panel.\n\n| Permission | Description |\n| ---------- | ----------- |\n| `account.payment-read` | The user may view the studio account's plan & billing information. |\n| `account.payment-withdrawal` | The user may request payment withdrawals on behalf of the studio. |\n| `account.read` | The user may view studio account settings (e.g. contact info, users, etc.). |\n| `account.update` | The user may update studio account settings (e.g. contact info, users, etc.). |\n| `brand-theme.create` | The user may create themes. |\n| `brand-theme.read` | The user may view themes. |\n| `brand-theme.update` | The user may edit themes. |\n| `brand.homepage-update` | The user may edit the client galleries homepage for a brand. |\n| `contact.create` | The user may create contacts. |\n| `contact.read` | The user may view contacts. |\n| `contact.update` | The user may edit contacts. |\n| `contract.create` | The user may create contracts. |\n| `contract.read` | The user may view contracts. |\n| `contract.update` | The user may edit contracts. |\n| `email-template.create` | The user may create email templates and automation groups. |\n| `email-template.read` | The user may view email templates and automation groups. |\n| `email-template.update` | The user may edit email templates and automation groups. |\n| `event-defaults.create` | The user may create default settings for events. |\n| `event-defaults.read` | The user may view default settings for events. |\n| `event-defaults.update` | The user may edit default settings for events. |\n| `event-photo.create` | The user may create event photos. |\n| `event-photo.update` | The user may edit event photos. |\n| `event.create` | The user may create events. |\n| `event.created-only` | The user may only view/edit/delete events they created. |\n| `event.delete` | The user may delete events. |\n| `event.read` | The user may view events. |\n| `event.update` | The user may edit events. |\n| `invoice.create` | The user may create invoices. |\n| `invoice.read` | The user may view invoices. |\n| `invoice.update` | The user may edit invoices. |\n| `mobile-app.create` | The user may create mobile apps. |\n| `mobile-app.read` | The user may view mobile apps. |\n| `mobile-app.update` | The user may edit mobile apps. |\n| `order.read` | The user may view orders. |\n| `order.update` | The user may edit orders. |\n| `playlist.read` | The user may view music playlists. |\n| `playlist.update` |  The user may edit music playlists. |\n| `price-sheet.create` | The user may create price sheets. |\n| `price-sheet.read` | The user may view price sheets. |\n| `price-sheet.update` | The user may edit price sheets. |\n| `report.event-visitors-read` | The user may view the \"Event Visitors\" report. |\n| `report.invoices-read` | The user may view the \"Invoices\" report. |\n| `report.items-read` | The user may view the \"Top-Selling Items\" report. |\n| `report.orders-read` | The user may view the \"Orders\" report. |\n| `report.sales-read` | The user may view the \"Sales\" report. |\n| `tool.read` | The user may view the available downloadable tools (i.e. Desktop Uploader). |\n| `watermark.create` | The user may create watermarks. |\n| `watermark.read` | The user may view watermarks. |\n| `watermark.update` | The user may edit watermarks. |",
      "items": {
        "description": "A permission identifier",
        "enum": [
          "account.payment-read",
          "account.payment-withdrawal",
          "account.read",
          "account.update",
          "brand-theme.create",
          "brand-theme.read",
          "brand-theme.update",
          "brand.homepage-update",
          "contact.create",
          "contact.read",
          "contact.update",
          "contract.create",
          "contract.read",
          "contract.update",
          "email-template.create",
          "email-template.read",
          "email-template.update",
          "event-defaults.create",
          "event-defaults.read",
          "event-defaults.update",
          "event-photo.create",
          "event-photo.update",
          "event.create",
          "event.created-only",
          "event.delete",
          "event.read",
          "event.update",
          "invoice.create",
          "invoice.read",
          "invoice.update",
          "mobile-app.create",
          "mobile-app.read",
          "mobile-app.update",
          "order.read",
          "order.update",
          "playlist.read",
          "playlist.update",
          "price-sheet.create",
          "price-sheet.read",
          "price-sheet.update",
          "report.event-visitors-read",
          "report.invoices-read",
          "report.items-read",
          "report.orders-read",
          "report.sales-read",
          "tool.read",
          "watermark.create",
          "watermark.read",
          "watermark.update"
        ],
        "type": "string"
      },
      "type": "array",
      "uniqueItems": true
    },
    "signature": {
      "$ref": "#/components/schemas/Signature"
    },
    "studio": {
      "allOf": [
        {
          "description": "The studio to which the authenticated user belongs.",
          "readOnly": true
        },
        {
          "$ref": "#/components/schemas/Studio"
        }
      ]
    },
    "type": {
      "description": "The type of object represented.",
      "enum": [
        "user"
      ],
      "type": "string"
    },
    "userStatus": {
      "description": "A human-readable string describing this user's status.",
      "readOnly": true,
      "type": "string"
    },
    "userStatusId": {
      "description": "The numeric identifier for this user's status.",
      "type": "number"
    }
  },
  "title": "Authenticated User",
  "type": "object"
}