Tenant

Manage tenant settings.

Get a list of tenants.

get

Retrieve a list of tenants and their details.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Query parameters

deletedbooleanOptional

Include soft-deleted tenants in the response when true.

Default: false

Responses

200

Executed successfully.

application/json

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

500

unexpected error

application/json

503

unexpected error

application/json

get

/api/v1/tenants

HTTPcURLJavaScriptPython

GET /api/v1/tenants HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "id": 1,
    "name": "example",
    "displayName": "Example",
    "status": "Ready",
    "tenantId": 123,
    "createdAt": "2020-01-01T00:00:00Z",
    "updatedAt": "2020-01-02T00:00:00Z",
    "deletedAt": null
  }
]

Create tenant

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Body

application/json

namestring · min: 2 · max: 255Required

The name of the tenant.

Example: namePattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9]$

emailstring · min: 5 · max: 254Required

The email of the tenant's admin user.

Example: [email protected]Pattern: ^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$

passwordstring · min: 8 · max: 255Optional

The password for the tenant's admin user. Must contain at least 1 special character, 1 uppercase letter, 1 lowercase letter, 1 digit, and be at least 8 characters long.

contractTypestring · enumOptionalPossible values:

rolestring · enum · nullableOptional

The role assigned to the tenant's admin user. Possible value: System administrator.

Possible values:

Responses

201

Created

application/json

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

The specified resource was not found

application/json

409

The specified resource already exists

application/json

500

unexpected error

application/json

503

unexpected error

application/json

post

/api/v1/tenants

HTTPcURLJavaScriptPython

POST /api/v1/tenants HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 437

{
  "name": "name",
  "email": "[email protected]",
  "password": "text",
  "contractType": "normal",
  "role": "System administrator",
  "metricStore": {
    "read": {
      "url": "http://mimir-nginx.mimir-test.svc:80/api/v1/query",
      "auth": {
        "basic": {
          "username": "text",
          "password": "text"
        }
      },
      "headers": {
        "X-Scope-OrgID": "id"
      }
    },
    "write": {
      "url": "http://mimir-nginx.mimir-test.svc:80/api/v1/query",
      "auth": {
        "basic": {
          "username": "text",
          "password": "text"
        }
      },
      "headers": {
        "X-Scope-OrgID": "id"
      }
    }
  }
}

{
  "tenant": {
    "id": 1,
    "name": "example",
    "displayName": "Example",
    "status": "Ready",
    "tenantId": 123,
    "eulaSigningUser": {
      "email": "user@tenant",
      "date": "2020-01-01T00:00:00Z",
      "ip": "192.168.10.210",
      "contract_type": "normal"
    },
    "created_at": "2020-01-01T00:00:00Z",
    "updated_at": "2020-01-02T00:00:00Z",
    "deleted_at": null
  },
  "additionalData": {
    "tenantDomain": "tenant.test.run.ai",
    "testUser": {
      "[email protected]": "Abc!23"
    },
    "customerUser": {
      "user@tenant": "Abc!23"
    }
  }
}

Get tenant

get

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Path parameters

tenantIdinteger · int32Required

The id of the tenant to retrieve

Responses

200

Executed successfully.

application/json

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

500

unexpected error

application/json

503

unexpected error

application/json

get

/api/v1/tenants/{tenantId}

HTTPcURLJavaScriptPython

GET /api/v1/tenants/{tenantId} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": 1,
  "name": "example",
  "displayName": "Example",
  "status": "Ready",
  "tenantId": 123,
  "createdAt": "2020-01-01T00:00:00Z",
  "updatedAt": "2020-01-02T00:00:00Z",
  "deletedAt": null
}

soft/hard delete tenant

delete

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Path parameters

tenantIdinteger · int32Required

The id of the tenant to retrieve

Query parameters

isHardDeletebooleanOptional

Boolean indicator for soft/hard delete

Responses

200

tenant uid that was deleted.

application/json

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

The specified resource was not found

application/json

500

unexpected error

application/json

503

unexpected error

application/json

delete

/api/v1/tenants/{tenantId}

HTTPcURLJavaScriptPython

DELETE /api/v1/tenants/{tenantId} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "uid": "text"
}