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

get

List available Tenants for the authenticated user

Authorizations

bearerapi_key

Bearer

In this case, you have to send a valid Access Token (as a JWT Token) in the Authorization header, using the Bearer authentication scheme.

e.g. Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6Ikpva...

Responses

200

success

application/json

get

/api/tenant

HTTPcURLJavaScriptPython

GET /api/tenant HTTP/1.1
Host: api.orb360.tech
Accept: */*

200

success

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

Get Tenant

get

Get an individual tenant by id

Authorizations

bearerapi_key

Bearer

In this case, you have to send a valid Access Token (as a JWT Token) in the Authorization header, using the Bearer authentication scheme.

e.g. Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6Ikpva...

Path parameters

tenantIdstringRequired

Unique tenant id

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

Responses

200

success

application/json

404

not found

application/json

get

/api/tenant/{tenantId}

HTTPcURLJavaScriptPython

GET /api/tenant/{tenantId} HTTP/1.1
Host: api.orb360.tech
Accept: */*

{
  "tenant": {
    "id": "fdb67f2e-219d-4771-b14f-a2ddc24b812b",
    "version": 123,
    "dateCreated": 1574782604487,
    "publicOriginHeaders": [
      "https://orb360.tech",
      "http://localhost:8080"
    ],
    "defaultShootSettings": {
      "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
        }
      },
      "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": true,
    "dateUpdated": 1594988393066,
    "role": "text"
  }
}

Create Tenant Alias

put

Create tenant aliases for the given tenant

Authorizations

bearerapi_key

Bearer

In this case, you have to send a valid Access Token (as a JWT Token) in the Authorization header, using the Bearer authentication scheme.

e.g. Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6Ikpva...

Path parameters

tenantIdstringRequired

Unique tenant id

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

Body

application/json

Responses

201

success

application/json

400

bad request

application/json

401

unauthorized

application/json

403

forbidden

application/json

404

not found

application/json

put

/api/tenant/{tenantId}/alias

HTTPcURLJavaScriptPython

PUT /api/tenant/{tenantId}/alias HTTP/1.1
Host: api.orb360.tech
Content-Type: application/json
Accept: */*
Content-Length: 44

{
  "aliases": [
    {
      "type": "joor",
      "value": "1234"
    }
  ]
}

{
  "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

Delete tenant aliases for the given tenant

Authorizations

bearerapi_key

Bearer

In this case, you have to send a valid Access Token (as a JWT Token) in the Authorization header, using the Bearer authentication scheme.

e.g. Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6Ikpva...

Path parameters

tenantIdstringRequired

Unique tenant id

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

Body

application/json

Responses

200

success

application/json

400

bad request

application/json

401

unauthorized

application/json

403

forbidden

application/json

404

not found

application/json

delete

/api/tenant/{tenantId}/alias

HTTPcURLJavaScriptPython

DELETE /api/tenant/{tenantId}/alias HTTP/1.1
Host: api.orb360.tech
Content-Type: application/json
Accept: */*
Content-Length: 44

{
  "aliases": [
    {
      "type": "joor",
      "value": "1234"
    }
  ]
}

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