Sign in

v1

latestOpenAPI 3.0.02026-07-145965251.1 KB
Users

Get info for a user

Get the details for a specific user. You can use the include parameter to also get the details of related records, such as the account or the home directory.

Notes:

  • You must have admin or master access to use this.
get/users/{id}

Query parameters

includestring
Example:homeResource,ownerAccount

Comma-separated list of relationships to include in response. Possible values include homeResource and ownerAccount.

Headers

ev-api-keystring required
Example:exampleaccount-zwSuWUZ8S38h33qPS8v0s

API Key

ev-access-tokenstring required
Example:19853ef63a0bc348024a9e4cfd4a92520d2dfd04e88d8679fb1ed6bc551593d1

Access token required to make the API call.

Response

Successful Operation

responseStatusinteger

Http code for the response.

Example response

{
  "data": {
    "attributes": {
      "accessTimestamp": "2011-03-21T00:18:56-07:00",
      "accountName": "exampleaccount",
      "created": "2018-07-27T15:43:55-07:00",
      "email": "example@exavault.mail",
      "expiration": "2020-06-30T13:33:30-07:00",
      "homePath": "/",
      "modified": "2018-07-29T15:43:55-07:00",
      "nickname": "exampleuser",
      "role": "user",
      "status": 1,
      "timeZone": "America/Chicago",
      "username": "exampleuser"
    },
    "id": 655621,
    "relationships": {
      "homeResource": {
        "data": {
          "type": "resource"
        }
      },
      "ownerAccount": {
        "data": {
          "type": "account"
        }
      }
    },
    "type": "user"
  },
  "included": [
    {
      "attributes": {
        "allowedIp": [
          {
            "ipEnd": "192.30.24.5",
            "ipStart": "192.30.23.2"
          }
        ],
        "branding": true,
        "brandingSettings": {
          "customEmail": "custom@example.com",
          "logo": "examplelogo.png",
          "logoExt": "png",
          "theme": "default"
        },
        "clientId": 1,
        "created": "2017-01-12T09:06:21Z",
        "customDomain": true,
        "externalDomains": [],
        "maxUsers": 1000,
        "modified": "2017-06-03T20:42:05Z",
        "quota": {
          "diskLimit": 375809638400,
          "diskUsed": 1225352192,
          "noticeEnabled": true,
          "noticeThreshold": 80
        },
        "showReferralLinks": true,
        "status": 1,
        "userCount": 3,
        "welcomeEmailContent": "Welcome to your new account!",
        "welcomeEmailSubject": "ExaVault File Sharing Account"
      },
      "id": 13758,
      "relationships": {
        "masterUser": {
          "data": {
            "type": "user"
          }
        }
      }
    }
  ],
  "responseStatus": 200
}