Organizations

White Label Admin - Get a white label user

White label admin only API to get information about a user.

get/api/organizations/{organizationId}/whitelabel/users/{userId}

Request

Base URL
https://studio.edgeimpulse.com/v1
Auth
- API key in header x-api-key
- or API key in cookie jwt
- or API key in header x-jwt-token
- or OAuth 2
  Authorization code/v1/oauth/authorize
  Client credentials
  Implicit/v1/oauth/authorize
  Password
  Token URL/v1/oauth/token
TypeScript
https://skmtc.dev/edgeimpulse/apis/edge-impulse-api/docs/api/organizations/:organizationId/whitelabel/users/:userId/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

organizationIdinteger required

Organization ID

userIdinteger required

User ID

Response

successboolean required

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

Example response

{
  "user": {
    "id": 1,
    "username": "janjongboom",
    "name": "Jan Jongboom",
    "email": "quijote@edgeimpulse.com",
    "photo": "https://usercdn.edgeimpulse.com/photos/1.jpg",
    "created": "2019-08-31T17:32:28Z",
    "lastSeen": "2019-08-31T17:32:28Z",
    "jobTitle": "Software Engineer",
    "companyName": "Edge Impulse Inc.",
    "organizations": [
      {
        "created": "2019-08-31T17:32:28Z",
        "trialId": 1,
        "trialExpiredDate": "2019-08-31T17:32:28Z",
        "trialUpgradedDate": "2019-08-31T17:32:28Z"
      }
    ],
    "projects": [
      {
        "id": 1,
        "name": "Water hammer detection",
        "created": "2019-07-21T17:32:28Z",
        "lastAccessed": "2019-07-21T17:32:28Z",
        "lastModified": "2019-07-21T17:32:28Z",
        "lastModificationDetails": "Data sample added",
        "collaborators": [
          {
            "id": 1,
            "username": "janjongboom",
            "name": "Jan Jongboom",
            "email": "quijote@edgeimpulse.com",
            "photo": "https://usercdn.edgeimpulse.com/photos/1.jpg",
            "created": "2019-08-31T17:32:28Z",
            "lastSeen": "2019-08-31T17:32:28Z",
            "jobTitle": "Software Engineer",
            "companyName": "Edge Impulse Inc."
          }
        ],
        "tags": [
          "FOMO",
          "beers"
        ]
      }
    ],
    "trials": [
      {
        "expirationDate": "2020-01-01T00:00:00Z",
        "notes": "This is a trial for the company's new project."
      }
    ],
    "dailyMetrics": [
      {
        "date": "2021-01-01T00:00:00Z",
        "totalUsers": 100,
        "totalStaffUsers": 10,
        "totalProjects": 50,
        "totalCurrentContractCpuComputeTimeSeconds": 100000,
        "totalCurrentContractGpuComputeTimeSeconds": 100000,
        "totalCurrentContractComputeTimeSeconds": 100000,
        "computeTimeCalculatedSince": "2021-01-01T00:00:00Z",
        "totalStorageSizeBytes": 1000000000,
        "usersAdded": 10,
        "staffUsersAdded": 1,
        "usersDeleted": 5,
        "staffUsersDeleted": 1,
        "projectsAdded": 10,
        "projectsDeleted": 5,
        "cpuComputeTimeSeconds": 10000,
        "gpuComputeTimeSeconds": 10000,
        "computeTimeSeconds": 10000,
        "storageBytesAdded": 1000000000,
        "storageBytesDeleted": 500000000
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.