Tenant

Manage tenant settings.

Get a list of tenants.

Retrieve a list of tenants and their details.

SecuritybearerAuth

Request

query Parameters

deleted

boolean

Default: false

Include soft-deleted tenants in the response when true.

Responses

200

Executed successfully.

400

Bad request.

401

Unauthorized

403

Forbidden

500

unexpected error

503

unexpected error

get/api/v1/tenants

Response samples

application/json

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

SecuritybearerAuth

Request

Request Body schema: application/json
required

The tenant to create.

name required	string^[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9]$ The name of the tenant.
email required	string^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2... The email of the tenant's admin user.
password	string The password for the tenant's admin user.
contractType	string Enum: "normal" "trial" ""
role	string or null (Roles) The role assigned to the tenant's admin user. Possible value: System administrator. Enum: "System administrator" "Cloud operator"
	object or null

Responses

201

Created

400

Bad request.

401

Unauthorized

403

Forbidden

404

The specified resource was not found

409

The specified resource already exists

500

unexpected error

503

unexpected error

post/api/v1/tenants

Request samples

Payload

application/json

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

Response samples

application/json

{"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": {"tenant-test@run.ai": "Abc!23"
},
"customerUser": {"user@tenant": "Abc!23"
}
}
}

Get tenant

SecuritybearerAuth

Request

path Parameters

tenantId

required

integer <int32> >= 0

The id of the tenant to retrieve

Responses

200

Executed successfully.

400

Bad request.

401

Unauthorized

403

Forbidden

500

unexpected error

503

unexpected error

get/api/v1/tenants/{tenantId}

Response samples

application/json

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

SecuritybearerAuth

Request

path Parameters

tenantId

required

integer <int32> >= 0

The id of the tenant to retrieve

query Parameters

isHardDelete

boolean

Boolean indicator for soft/hard delete

Responses

200

tenant uid that was deleted.

400

Bad request.

401

Unauthorized

403

Forbidden

404

The specified resource was not found

500

unexpected error

503

unexpected error

delete/api/v1/tenants/{tenantId}

Response samples

application/json

{"uid": "string"
}

➔ Next to Access Keys

Tenant

Get a list of tenants.

query Parameters

Create tenant

Request Body schema: application/jsonrequired

Get tenant

path Parameters

soft/hard delete tenant

path Parameters

query Parameters

Request Body schema: application/json
required