Tenant

The Tenant object represents an organisation (designer) within the DAM.

Users will typically have access to a subset of the available Tenants on the system.

List Tenants

List available Tenants for the authenticated user

GEThttps://api.orb360.tech/api/tenant

Authorization

bearerapi_key

Response

200

success

Body

application/json

tenantsany

The available tenants for this user

userall of

The currently authenticated user details

Request

JavaScriptCurlPython

const response = await fetch('https://api.orb360.tech/api/tenant', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "user": {
    "enabled": true,
    "version": 123,
    "dateCreated": 1574782604487,
    "mfa": true,
    "name": "James Kirk",
    "email": "[e-mail]",
    "id": "auth0|dd5e21fb23efe45d1761ddce",
    "createdBy": "auth0|a3d8badce67905bc1a397fcc",
    "globalRole": "customer",
    "lastLogin": 1594988391000,
    "dateUpdated": 1594988393066,
    "apiKey": "9275c777-360f-4d60-8a4c-e2af0d933eaa:LuwqbCnOig8hJScpkjlioVhExeeDDkbn7kuYUwS0"
  }
}

Get Tenant

Get an individual tenant by id

GEThttps://api.orb360.tech/api/tenant/{tenantId}

Authorization

bearerapi_key

Path parameters

tenantId*string

Unique tenant id

Example: "f700d27e-64ed-4571-ae2e-8c948c1c296e"

Response

200404

success

Body

application/json

tenantall of

The requested tenant

Request

JavaScriptCurlPython

const response = await fetch('https://api.orb360.tech/api/tenant/{tenantId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200404

{
  "tenant": {
    "id": "fdb67f2e-219d-4771-b14f-a2ddc24b812b",
    "version": 123,
    "dateCreated": 1574782604487,
    "publicOriginHeaders": [
      "https://orb360.tech",
      "http://localhost:8080"
    ],
    "defaultShootSettings": {
      "integrations": {
        "findByTag": {
          "enabled-apiKey": false,
          "enabled-public": false
        },
        "findById": {
          "enabled-apiKey": false,
          "enabled-public": false
        }
      },
      "generatedMediaPresets": {
        "360_V2": {},
        "SINGLE_IMAGE": {},
        "VIDEO": {}
      },
      "mediaNameFormat": "{tag:StyleNumber}"
    },
    "aliases": {
      "joor": [
        {
          "alias": "joor:1234",
          "createdBy": "auth0|dd5e21fb23efe45d1761ddce",
          "dateCreated": 1594988393066,
          "dateUpdated": 1594988393066,
          "tenant": "fdb67f2e-219d-4771-b14f-a2ddc24b812b",
          "type": "joor",
          "value": "1234"
        }
      ]
    },
    "createdBy": "auth0|dd5e21fb23efe45d1761ddce",
    "name": "All About Cats",
    "requireMfa": false,
    "dateUpdated": 1594988393066,
    "role": "text"
  }
}

Create Tenant Alias

Create tenant aliases for the given tenant

PUThttps://api.orb360.tech/api/tenant/{tenantId}/alias

Authorization

bearerapi_key

Path parameters

tenantId*string

Unique tenant id

Example: "f700d27e-64ed-4571-ae2e-8c948c1c296e"

Body

application/json

aliasesarray of object

Alias type value pairs to be created for the specified tenant

Response

201400401403404

success

Body

application/json

aliasesall of

All tenant aliases for the requested tenant, including changes made by this request

Request

JavaScriptCurlPython

const response = await fetch('https://api.orb360.tech/api/tenant/{tenantId}/alias', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

201400401403404

{
  "aliases": {
    "joor": [
      {
        "alias": "joor:1234",
        "createdBy": "auth0|dd5e21fb23efe45d1761ddce",
        "dateCreated": 1594988393066,
        "dateUpdated": 1594988393066,
        "tenant": "fdb67f2e-219d-4771-b14f-a2ddc24b812b",
        "type": "joor",
        "value": "1234"
      }
    ]
  }
}

Delete Tenant Alias

Delete tenant aliases for the given tenant

DELETEhttps://api.orb360.tech/api/tenant/{tenantId}/alias

Authorization

bearerapi_key

Path parameters

tenantId*string

Unique tenant id

Example: "f700d27e-64ed-4571-ae2e-8c948c1c296e"

Body

application/json

aliasesarray of object

Alias type value pairs to be deleted for the specified tenant

Response

200400401403404

success

Body

application/json

aliasesall of

All tenant aliases for the requested tenant, including changes made by this request

Request

JavaScriptCurlPython

const response = await fetch('https://api.orb360.tech/api/tenant/{tenantId}/alias', {
    method: 'DELETE',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400401403404

{
  "aliases": {
    "joor": [
      {
        "alias": "joor:1234",
        "createdBy": "auth0|dd5e21fb23efe45d1761ddce",
        "dateCreated": 1594988393066,
        "dateUpdated": 1594988393066,
        "tenant": "fdb67f2e-219d-4771-b14f-a2ddc24b812b",
        "type": "joor",
        "value": "1234"
      }
    ]
  }
}