Documentation Index

Fetch the complete documentation index at: https://docs.graphiant.com/llms.txt

Use this file to discover all available pages before exploring further.

/v1/enterprises

Prev Next
Get
/v1/enterprises

Get specific enterprises by their IDs with detailed information. Query just your own enterprise Id for more detailed info.

Security
API Key: jwtAuth
Header parameter nameauthorization

Use Bearer <token>

Header parameters
Authorization
stringRequired

Bearer token. Format: Bearer <your_token_here>

Query parameters
enterpriseIds
array of integer

Lists enterprises

Example[ 0 ]
Item Example1234567891011
Responses
200

OK

Expand All
object
enterprises
Array of object (iamEnterprise)
object
acceptEula
boolean
Exampletrue
accountType
string
ExampleENUM_VALUE
adminEmail
string
Exampleexample string
cloudProvider
string
ExampleENUM_VALUE
companyName
string
Exampleexample string
counts
object (iamCounts)
activeDownCount
integer (int64)
Example1234567891011
activeUpCount
integer (int64)
Example1234567891011
deactivatedDownCount
integer (int64)
Example1234567891011
downSitesCount
integer (int64)
Example1234567891011
emptySitesCount
integer (int64)
Example1234567891011
impairedSitesCount
integer (int64)
Example1234567891011
stagingDownCount
integer (int64)
Example1234567891011
stagingUpCount
integer (int64)
Example1234567891011
totalCustomers
integer (int64)
Example1234567891011
totalEdges
integer (int64)
Example1234567891011
totalMsps
integer (int64)
Example1234567891011
totalSites
integer (int64)
Example1234567891011
upSitesCount
integer (int64)
Example1234567891011
creditLimit
integer (int32)
Example123
customers
object
property*
object (iamCustomer) additionalProperties
adminEmail
string
Exampleexample string
companyName
string
Exampleexample string
counts
object (iamCounts)
activeDownCount
integer (int64)
Example1234567891011
activeUpCount
integer (int64)
Example1234567891011
deactivatedDownCount
integer (int64)
Example1234567891011
downSitesCount
integer (int64)
Example1234567891011
emptySitesCount
integer (int64)
Example1234567891011
impairedSitesCount
integer (int64)
Example1234567891011
stagingDownCount
integer (int64)
Example1234567891011
stagingUpCount
integer (int64)
Example1234567891011
totalCustomers
integer (int64)
Example1234567891011
totalEdges
integer (int64)
Example1234567891011
totalMsps
integer (int64)
Example1234567891011
totalSites
integer (int64)
Example1234567891011
upSitesCount
integer (int64)
Example1234567891011
description
string
Exampleexample string
enterpriseId
integer (int64)
Example1234567891011
impersonationEnabled
boolean
Exampletrue
marketplaceId
string
Exampleexample string
description
string
Exampleexample string
enterpriseId
integer (int64)
Example1234567891011
eulaAgreementDate
object (googleProtobufTimestamp)
nanos
integer (int32)
Example123
seconds
integer (int64)
Example1234567891011
impersonationEnabled
boolean
Exampletrue
logo
string
Exampleexample string
marketplaceId
string
Exampleexample string
parentCompanyName
string
Exampleexample string
parentEnterpriseId
integer (int64)
Example1234567891011
portalBanner
string
Exampleexample string
proxyTenantId
integer (int64)
Example1234567891011
smallLogo
string
Exampleexample string
tokenExpiry
string
Exampleexample string