Agent Maturity Compass API - v1.2.0
Guides
HTTP API
GitHub
Preparing search index...
index
TenantManager
Class TenantManager
Index
Constructors
constructor
Methods
create
Tenant
generate
Federated
Benchmark
get
Isolation
get
Tenant
list
Tenants
validate
Cross
Region
Access
Constructors
constructor
new
TenantManager
()
:
TenantManager
Returns
TenantManager
Methods
create
Tenant
createTenant
(
input
:
{
dataRegion
:
"global"
|
"eu"
|
"us"
|
"ap"
;
name
:
string
;
tier
:
"enterprise"
|
"free"
|
"team"
;
}
,
)
:
{
createdAt
:
number
;
dataRegion
:
"global"
|
"eu"
|
"us"
|
"ap"
;
isolationLevel
:
"logical"
|
"physical"
;
maxAgents
:
number
;
maxUsers
:
number
;
name
:
string
;
settings
:
{
allowAnonymizedBenchmarking
:
boolean
;
customComplianceFrameworks
:
string
[]
;
dataRetentionDays
:
number
;
}
;
ssoProviderId
?:
string
;
tenantId
:
string
;
tier
:
"enterprise"
|
"free"
|
"team"
;
}
Parameters
input
:
{
dataRegion
:
"global"
|
"eu"
|
"us"
|
"ap"
;
name
:
string
;
tier
:
"enterprise"
|
"free"
|
"team"
;
}
Returns
{
createdAt
:
number
;
dataRegion
:
"global"
|
"eu"
|
"us"
|
"ap"
;
isolationLevel
:
"logical"
|
"physical"
;
maxAgents
:
number
;
maxUsers
:
number
;
name
:
string
;
settings
:
{
allowAnonymizedBenchmarking
:
boolean
;
customComplianceFrameworks
:
string
[]
;
dataRetentionDays
:
number
;
}
;
ssoProviderId
?:
string
;
tenantId
:
string
;
tier
:
"enterprise"
|
"free"
|
"team"
;
}
generate
Federated
Benchmark
generateFederatedBenchmark
(
tenantId
:
string
,
framework
:
string
,
tenantScore
:
number
,
allScores
:
number
[]
,
)
:
FederatedBenchmark
|
null
Parameters
tenantId
:
string
framework
:
string
tenantScore
:
number
allScores
:
number
[]
Returns
FederatedBenchmark
|
null
get
Isolation
getIsolation
(
tenantId
:
string
)
:
TenantIsolation
|
undefined
Parameters
tenantId
:
string
Returns
TenantIsolation
|
undefined
get
Tenant
getTenant
(
tenantId
:
string
,
)
:
|
{
createdAt
:
number
;
dataRegion
:
"global"
|
"eu"
|
"us"
|
"ap"
;
isolationLevel
:
"logical"
|
"physical"
;
maxAgents
:
number
;
maxUsers
:
number
;
name
:
string
;
settings
:
{
allowAnonymizedBenchmarking
:
boolean
;
customComplianceFrameworks
:
string
[]
;
dataRetentionDays
:
number
;
}
;
ssoProviderId
?:
string
;
tenantId
:
string
;
tier
:
"enterprise"
|
"free"
|
"team"
;
}
|
undefined
Parameters
tenantId
:
string
Returns
|
{
createdAt
:
number
;
dataRegion
:
"global"
|
"eu"
|
"us"
|
"ap"
;
isolationLevel
:
"logical"
|
"physical"
;
maxAgents
:
number
;
maxUsers
:
number
;
name
:
string
;
settings
:
{
allowAnonymizedBenchmarking
:
boolean
;
customComplianceFrameworks
:
string
[]
;
dataRetentionDays
:
number
;
}
;
ssoProviderId
?:
string
;
tenantId
:
string
;
tier
:
"enterprise"
|
"free"
|
"team"
;
}
|
undefined
list
Tenants
listTenants
()
:
{
createdAt
:
number
;
dataRegion
:
"global"
|
"eu"
|
"us"
|
"ap"
;
isolationLevel
:
"logical"
|
"physical"
;
maxAgents
:
number
;
maxUsers
:
number
;
name
:
string
;
settings
:
{
allowAnonymizedBenchmarking
:
boolean
;
customComplianceFrameworks
:
string
[]
;
dataRetentionDays
:
number
;
}
;
ssoProviderId
?:
string
;
tenantId
:
string
;
tier
:
"enterprise"
|
"free"
|
"team"
;
}
[]
Returns
{
createdAt
:
number
;
dataRegion
:
"global"
|
"eu"
|
"us"
|
"ap"
;
isolationLevel
:
"logical"
|
"physical"
;
maxAgents
:
number
;
maxUsers
:
number
;
name
:
string
;
settings
:
{
allowAnonymizedBenchmarking
:
boolean
;
customComplianceFrameworks
:
string
[]
;
dataRetentionDays
:
number
;
}
;
ssoProviderId
?:
string
;
tenantId
:
string
;
tier
:
"enterprise"
|
"free"
|
"team"
;
}
[]
validate
Cross
Region
Access
validateCrossRegionAccess
(
sourceTenantId
:
string
,
targetTenantId
:
string
,
)
:
{
allowed
:
boolean
;
reason
:
string
}
Parameters
sourceTenantId
:
string
targetTenantId
:
string
Returns
{
allowed
:
boolean
;
reason
:
string
}
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Methods
create
Tenant
generate
Federated
Benchmark
get
Isolation
get
Tenant
list
Tenants
validate
Cross
Region
Access
Guides
HTTP API
GitHub
Agent Maturity Compass API - v1.2.0
Loading...