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

get

/api/tenant

Authorizations

bearerapi_key

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.orb360.tech/api/tenant'

200

200

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

success

Get Tenant

Get an individual tenant by id

get

/api/tenant/{tenantId}

Authorizations

bearerapi_key

Path parameters

tenantIdstringrequired

Unique tenant id

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

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.orb360.tech/api/tenant/{tenantId}'

200

404

200

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

success

Create Tenant Alias

Create tenant aliases for the given tenant

put

/api/tenant/{tenantId}/alias

Authorizations

bearerapi_key

Path parameters

tenantIdstringrequired

Unique tenant id

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

Body

aliasesobject[]

Responses

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://api.orb360.tech/api/tenant/{tenantId}/alias' \
  --header 'Content-Type: application/json' \
  --data '{
    "aliases": [
      {
        "value": "1234",
        "type": "joor"
      }
    ]
  }'

201

400

401

403

404

201

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

success

Delete Tenant Alias

Delete tenant aliases for the given tenant

delete

/api/tenant/{tenantId}/alias

Authorizations

bearerapi_key

Path parameters

tenantIdstringrequired

Unique tenant id

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

Body

aliasesobject[]

Responses

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://api.orb360.tech/api/tenant/{tenantId}/alias' \
  --header 'Content-Type: application/json' \
  --data '{
    "aliases": [
      {
        "value": "1234",
        "type": "joor"
      }
    ]
  }'

200

400

401

403

404

200

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

success