Get the list of authenticated users for TCO using oauth

Select

SaaS

Customer Managed

Get the list of authenticated users for TCO using oauth

Query Parameters

• provider string

  Cloud provider ( Azure, AWS, etc)

• refreshTokenId string

  Refesh token id of the refresh token to be deleted

Responses

• 200
• 400
• 403
• 500

---

OK

application/json

• Schema
• Example (from schema)

---

Schema

• credentialId object[]

  id int32

  name string
• refreshToken TCORefreshToken

  RefreshTokenId int32

  Refresh Token ID

  RefreshToken string

  Refresh Token

  Provider string

  Cloud Provider name

  ErrorMesage string

  Error message while saving/validating refresh token

  ErrorCode int32

  Error code while saving/validating refresh token

• discoveryCriteria object

  Model for Workload Discovery Selector Object

  criteria WorkloadDiscoveryCriteriaEnum

  Possible values: [SUBSCRIPTIONS, REGIONS, PROJECTS, ZONES]

  Selection criteria for workload discovery while running a TCO Assessment

  details object[]

  Additional Details related to respective select

  id int32

  name string

  value string
• errorCode CyberResilienceErrorCode

  Possible values: [NO_ERROR, INVALID_INPUT, INDEX_SERVER_NOT_EXIST, INDEX_SERVER_INACCESSIBLE, INDEX_SERVER_DATA_ANALYTICS_ROLE_MISSING, CREDENTIAL_UNSUPPORTED, CREDENTIAL_INACCESSIBLE, CYBER_RESILIENCE_ALREADY_CONFIGURED, CYBER_RESILIENCE_NOT_CONFIGURED, DELETING_UNCONFIGURED_CREDENTIAL, ADDING_CONFIGURED_CREDENTIAL, UNKNOWN_ERROR, INTERNAL_SERVER_ERROR, CREDENTIAL_INVALID]

• errorMessage string

{
  "credentialId": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "refreshToken": {
    "RefreshTokenId": 0,
    "RefreshToken": "string",
    "Provider": "string",
    "ErrorMesage": "string",
    "ErrorCode": 0
  },
  "discoveryCriteria": {
    "criteria": "SUBSCRIPTIONS",
    "details": [
      {
        "id": 0,
        "name": "string",
        "value": "string"
      }
    ]
  },
  "errorCode": "NO_ERROR",
  "errorMessage": "string"
}

Bad Request

application/json

• Schema
• Example (from schema)

---

Schema

• credentialId object[]

  id int32

  name string
• refreshToken TCORefreshToken

  RefreshTokenId int32

  Refresh Token ID

  RefreshToken string

  Refresh Token

  Provider string

  Cloud Provider name

  ErrorMesage string

  Error message while saving/validating refresh token

  ErrorCode int32

  Error code while saving/validating refresh token

• discoveryCriteria object

  Model for Workload Discovery Selector Object

  criteria WorkloadDiscoveryCriteriaEnum

  Possible values: [SUBSCRIPTIONS, REGIONS, PROJECTS, ZONES]

  Selection criteria for workload discovery while running a TCO Assessment

  details object[]

  Additional Details related to respective select

  id int32

  name string

  value string
• errorCode CyberResilienceErrorCode

  Possible values: [NO_ERROR, INVALID_INPUT, INDEX_SERVER_NOT_EXIST, INDEX_SERVER_INACCESSIBLE, INDEX_SERVER_DATA_ANALYTICS_ROLE_MISSING, CREDENTIAL_UNSUPPORTED, CREDENTIAL_INACCESSIBLE, CYBER_RESILIENCE_ALREADY_CONFIGURED, CYBER_RESILIENCE_NOT_CONFIGURED, DELETING_UNCONFIGURED_CREDENTIAL, ADDING_CONFIGURED_CREDENTIAL, UNKNOWN_ERROR, INTERNAL_SERVER_ERROR, CREDENTIAL_INVALID]

• errorMessage string

{
  "credentialId": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "refreshToken": {
    "RefreshTokenId": 0,
    "RefreshToken": "string",
    "Provider": "string",
    "ErrorMesage": "string",
    "ErrorCode": 0
  },
  "discoveryCriteria": {
    "criteria": "SUBSCRIPTIONS",
    "details": [
      {
        "id": 0,
        "name": "string",
        "value": "string"
      }
    ]
  },
  "errorCode": "NO_ERROR",
  "errorMessage": "string"
}

Forbidden

application/json

• Schema
• Example (from schema)

---

Schema

• credentialId object[]

  id int32

  name string
• refreshToken TCORefreshToken

  RefreshTokenId int32

  Refresh Token ID

  RefreshToken string

  Refresh Token

  Provider string

  Cloud Provider name

  ErrorMesage string

  Error message while saving/validating refresh token

  ErrorCode int32

  Error code while saving/validating refresh token

• discoveryCriteria object

  Model for Workload Discovery Selector Object

  criteria WorkloadDiscoveryCriteriaEnum

  Possible values: [SUBSCRIPTIONS, REGIONS, PROJECTS, ZONES]

  Selection criteria for workload discovery while running a TCO Assessment

  details object[]

  Additional Details related to respective select

  id int32

  name string

  value string
• errorCode CyberResilienceErrorCode

  Possible values: [NO_ERROR, INVALID_INPUT, INDEX_SERVER_NOT_EXIST, INDEX_SERVER_INACCESSIBLE, INDEX_SERVER_DATA_ANALYTICS_ROLE_MISSING, CREDENTIAL_UNSUPPORTED, CREDENTIAL_INACCESSIBLE, CYBER_RESILIENCE_ALREADY_CONFIGURED, CYBER_RESILIENCE_NOT_CONFIGURED, DELETING_UNCONFIGURED_CREDENTIAL, ADDING_CONFIGURED_CREDENTIAL, UNKNOWN_ERROR, INTERNAL_SERVER_ERROR, CREDENTIAL_INVALID]

• errorMessage string

{
  "credentialId": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "refreshToken": {
    "RefreshTokenId": 0,
    "RefreshToken": "string",
    "Provider": "string",
    "ErrorMesage": "string",
    "ErrorCode": 0
  },
  "discoveryCriteria": {
    "criteria": "SUBSCRIPTIONS",
    "details": [
      {
        "id": 0,
        "name": "string",
        "value": "string"
      }
    ]
  },
  "errorCode": "NO_ERROR",
  "errorMessage": "string"
}

Internal Server Error

application/json

• Schema
• Example (from schema)

---

Schema

• Assessments object[]

  credentialId int32

  Credential Id

  assessmentId string

  Assessment Id

  assessmentName string

  Assessment Name

  createTime int32

  Assessment creation time

  tcoAssessmentProperties object

  credentialId int32

  cloudConnector CyberResiliencyCloudConnector

  Possible values: [AZURE, AWS, GCP, M365, AD]

  Default value: AZURE

  Supported Connector Types for Cyber Resilience Cost Assessment Dashboard

  authType TCOCredentialAuthType

  Possible values: [OAUTH2, CREDENTIAL_VAULT]

  Default value: CREDENTIAL_VAULT

  Supported Credential Authentication Types for Cyber Resilience Cost Assessment Dashboard

  discoveryCriteria object

  Model for Workload Discovery Selector Object

  criteria WorkloadDiscoveryCriteriaEnum

  Possible values: [SUBSCRIPTIONS, REGIONS, PROJECTS, ZONES]

  Selection criteria for workload discovery while running a TCO Assessment

  details object[]

  Additional Details related to respective select

  id int32

  name string

  value string

  assessmentConfig object

  TCO Assessment Configuration Fields

  utilizationFactorVM float

  Virtual Machine Utilization Percentage

  standardRetention float

  Standard Retention in Days for Workloadd

  annualGrowthRate float

  Annual Projected Growth Rate for Workload

  dailyChangeRateVM float

  dailyChangeRateDB float

  dailyChangeRateFO float

  storageReplicationTarget float

  workloadDetails object[]

  costdetails object[]

  name string

  value string

  resourceDetails object[]

  resourcetype string

  Type of the resource

  count int32

  Number of resources of this type

  resourceSize int64

  Sum of the size of all the resources of this type

  details object[]

  resourceName string

  resourceProperties object[]

  name string

  value string

  workloadtype string

  discoveredCount int32

  Total Count of Workload Resources

  discoveredSize int64

  Total Size In Bytes for Discovered Resources

  commvaultCost object

  primarySnapshotStorageCost int64

  secondarySnapshotStorageCost int64

  asrTotalVMEnvironment int64

  primaryCloudStorageUsedCost int64

  primaryCloudStorageUsed3YCost int64

  secondaryCloudStorageUsedCost int64

  secondaryCloudStorageUsed3YCost int64

  protectionCost int64

  primaryInfraCost int64

  secondaryInfraCost int64

  dataTranmissionCost int64

  provider string

  status DcubeJobState

  Possible values: [IDLE, STARTING, RUNNING, FINISHING, FINISHED, STOPPING, STOPPED, ABORTING, ABORTED, EXCEPTION, UNKNOWN, SYNCING, PENDING, COMPLETED_WITH_ERRORS]

• errorCode CyberResilienceErrorCode

  Possible values: [NO_ERROR, INVALID_INPUT, INDEX_SERVER_NOT_EXIST, INDEX_SERVER_INACCESSIBLE, INDEX_SERVER_DATA_ANALYTICS_ROLE_MISSING, CREDENTIAL_UNSUPPORTED, CREDENTIAL_INACCESSIBLE, CYBER_RESILIENCE_ALREADY_CONFIGURED, CYBER_RESILIENCE_NOT_CONFIGURED, DELETING_UNCONFIGURED_CREDENTIAL, ADDING_CONFIGURED_CREDENTIAL, UNKNOWN_ERROR, INTERNAL_SERVER_ERROR, CREDENTIAL_INVALID]

• errorMessage string

{
  "Assessments": [
    {
      "credentialId": 0,
      "assessmentId": "string",
      "assessmentName": "string",
      "createTime": 0,
      "tcoAssessmentProperties": {
        "credentialId": 0,
        "cloudConnector": "AZURE",
        "authType": "CREDENTIAL_VAULT",
        "discoveryCriteria": {
          "criteria": "SUBSCRIPTIONS",
          "details": [
            {
              "id": 0,
              "name": "string",
              "value": "string"
            }
          ]
        },
        "assessmentConfig": {
          "utilizationFactorVM": 0,
          "standardRetention": 0,
          "annualGrowthRate": 0,
          "dailyChangeRateVM": 0,
          "dailyChangeRateDB": 0,
          "dailyChangeRateFO": 0,
          "storageReplicationTarget": 0
        },
        "workloadDetails": [
          {
            "costdetails": [
              {
                "name": "string",
                "value": "string"
              }
            ],
            "resourceDetails": [
              {
                "resourcetype": "string",
                "count": 0,
                "resourceSize": 0,
                "details": [
                  {
                    "resourceName": "string",
                    "resourceProperties": [
                      {
                        "name": "string",
                        "value": "string"
                      }
                    ]
                  }
                ]
              }
            ],
            "workloadtype": "string",
            "discoveredCount": 0,
            "discoveredSize": 0
          }
        ],
        "commvaultCost": {
          "primarySnapshotStorageCost": 0,
          "secondarySnapshotStorageCost": 0,
          "asrTotalVMEnvironment": 0,
          "primaryCloudStorageUsedCost": 0,
          "primaryCloudStorageUsed3YCost": 0,
          "secondaryCloudStorageUsedCost": 0,
          "secondaryCloudStorageUsed3YCost": 0,
          "protectionCost": 0,
          "primaryInfraCost": 0,
          "secondaryInfraCost": 0,
          "dataTranmissionCost": 0
        }
      },
      "provider": "string",
      "status": "IDLE"
    }
  ],
  "errorCode": "NO_ERROR",
  "errorMessage": "string"
}

GET /v4/tco/authenticatedusers    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://CommandCenterHostName/commandcenter/api

Security Scheme

tokenbearerToken

token

provider — query

refreshTokenId — query

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V4/TCO/AuthenticatedUsers' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V4/TCO/AuthenticatedUsers' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V4/TCO/AuthenticatedUsers' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V4/TCO/AuthenticatedUsers' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V4/TCO/AuthenticatedUsers' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V4/TCO/AuthenticatedUsers' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V4/TCO/AuthenticatedUsers' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'