Platform

listCompanies

get

로그인한 사용자가 액세스할 수 있는 모든 회사 목록을 가져옵니다.

Authorizations

Query parameters

permissionTypestring · enumOptionalDefault: readPossible values:

Responses

200

OK

*/*

400

Bad Request

404

Not Found

get

GET /platform/v2/companies HTTP/1.1
Host: api.kr.opsnow360.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "status": "success",
  "data": {
    "list": [
      {
        "companyId": "123e4567-e89b-12d3-a456-426614174000",
        "companyName": "company1",
        "isMainCompany": "Y"
      }
    ]
  }
}

listCompanyUsers

get

회사에 연결된 모든 사용자 목록을 가져옵니다.

Authorizations

Path parameters

companyIdstringRequired

조직의 ID로, 'listCompanies'를 통해 얻을 수 있습니다.

Example: f23a80d2-2077-4e0a-aa85-e7b08a379be7

Responses

200

OK

*/*

400

Bad Request

404

Not Found

get

GET /platform/v2/companies/{companyId}/users HTTP/1.1
Host: api.kr.opsnow360.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "status": "success",
  "data": {
    "list": [
      {
        "userId": "123e4567-e89b-12d3-a456-426614174000",
        "email": "[email protected]",
        "displayName": "John Doe",
        "masterCompanyId": "65dd4cbf-b412-4f83-8476-97a3f1e161b2",
        "userStatCd": "ACTIVATED",
        "userRoleId": "ADMIN",
        "userRoleName": "Admin",
        "masterUserRole": "OWNER",
        "enabled": true,
        "createdDate": "2023-01-01T12:00:00.000Z"
      }
    ]
  }
}

listAwsAccounts

get

지정된 회사 ID에 연결된 AWS 계정 목록을 가져옵니다.

Authorizations

Path parameters

companyIdstringRequired

조직의 ID로, 'listCompanies'를 통해 얻을 수 있습니다.

Example: f23a80d2-2077-4e0a-aa85-e7b08a379be7

Query parameters

isAddReadyToStartbooleanOptional

isAddReadyToStart가 true로 설정된 경우 추가 멤버 계정을 등록할 수 있는지 여부를 지정합니다.

Example: true

accountTypestringOptional

accountType 매개변수는 AWS 계정의 유형을 나타내며, 주로 마스터 계정과 멤버 계정을 구분하는 데 사용됩니다. AWS 계정 구조에서 마스터 계정은 AWS 조직의 루트 계정으로, 멤버 계정을 관리하고 청구를 통합하는 역할을 합니다. 반면 멤버 계정은 마스터 계정에 속한 개별 계정으로, 각각 고유한 리소스와 서비스를 가집니다. 이 매개변수는 API 요청에서 마스터 계정 또는 멤버 계정을 쿼리할지 지정하는 데 사용됩니다. 허용되는 값은 'master'와 'member'입니다.

Example: master

Responses

200

OK

*/*

400

Bad Request

404

Not Found

get

GET /platform/v2/companies/{companyId}/vendors/aws/accounts HTTP/1.1
Host: api.kr.opsnow360.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "status": "success",
  "data": {
    "list": [
      {
        "accountId": "123456789012",
        "accountAlias": "AWS 1st DEV Infra Account",
        "accountType": "master",
        "isCostAvailable": "true",
        "stackTemplateVersion": "1.0",
        "status": "healthy",
        "contractStatus": "SUBSCRIBED",
        "isSpPurchaseAccount": true,
        "errorDescription": "Error occurred during stack creation. You can identify the cause of the error in AWS Console > CloudFormation > Events tab. Please take necessary actions and retry.",
        "createdDate": "2024-05-20T07:06:47.253Z",
        "updatedDate": "2024-05-20T07:06:47.253Z"
      }
    ]
  }
}

getAwsAccount

get

지정된 회사 및 계정 ID를 사용하여 특정 AWS 계정의 세부 정보를 가져옵니다.

Authorizations

Path parameters

companyIdstringRequired

조직의 ID로, 'listCompanies'를 통해 얻을 수 있습니다.

Example: f23a80d2-2077-4e0a-aa85-e7b08a379be7

accountIdstringRequired

AWS 계정의 고유 식별자입니다.

Example: 123456789012

Responses

200

OK

*/*

400

Bad Request

404

Not Found

get

GET /platform/v2/companies/{companyId}/vendors/aws/accounts/{accountId} HTTP/1.1
Host: api.kr.opsnow360.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "status": "success",
  "data": {
    "accountId": "123456789012",
    "accountAlias": "AWS 1st DEV Infra Account",
    "accountType": "master",
    "managementAccountId": "987654321987",
    "status": "healthy",
    "roleArn": "arn:aws:iam::123456789012:role/role-name",
    "stackName": "stack-7bfe7be4-b423-4e92-b6ad-b685ce2fb2e2",
    "stackTemplateVersion": "1.0",
    "curBucketName": "bucket-name",
    "curBucketRegion": "us-east-1",
    "curBucketPrefix": "cur",
    "contractStatus": "us-east-1",
    "createdDate": "2024-05-20T07:06:47.253Z",
    "updatedDate": "2024-05-20T07:06:47.253Z"
  }
}

updateAwsAccount

put

회사 및 계정 ID로 식별된 기존 AWS 계정의 정보를 업데이트합니다.

Authorizations

Path parameters

companyIdstringRequired

조직의 ID로, 'listCompanies'를 통해 얻을 수 있습니다.

Example: f23a80d2-2077-4e0a-aa85-e7b08a379be7

accountIdstringRequired

AWS 계정의 고유 식별자입니다.

Example: 123456789012

Body

accountAliasstringOptional

AWS 계정의 별칭으로, 쉽게 식별할 수 있도록 사용됩니다.

Example: AWS 1st DEV Infra Account

isCancelDeleteAccountbooleanOptional

AWS 계정 삭제를 취소할지 여부를 지정합니다.

Example: true

Responses

200

OK

*/*

400

Bad Request

404

Not Found

put

PUT /platform/v2/companies/{companyId}/vendors/aws/accounts/{accountId} HTTP/1.1
Host: api.kr.opsnow360.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 73

{
  "accountAlias": "AWS 1st DEV Infra Account",
  "isCancelDeleteAccount": true
}

{
  "status": "success",
  "data": {
    "accountId": "123456789012"
  }
}

deleteAwsAccount

delete

지정된 회사 및 계정 ID를 사용하여 시스템에서 AWS 계정을 제거합니다.

Authorizations

Path parameters

companyIdstringRequired

조직의 ID로, 'listCompanies'를 통해 얻을 수 있습니다.

Example: f23a80d2-2077-4e0a-aa85-e7b08a379be7

accountIdstringRequired

AWS 계정의 고유 식별자입니다.

Example: 123456789012

Responses

200

OK

*/*

400

Bad Request

404

Not Found

delete

DELETE /platform/v2/companies/{companyId}/vendors/aws/accounts/{accountId} HTTP/1.1
Host: api.kr.opsnow360.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "status": "success",
  "data": {
    "accountId": "123456789012"
  }
}

getAwsAccountSavingsAmount

get

지정된 회사 및 계정 ID를 사용하여 특정 AWS 계정의 절약 금액 정보를 가져옵니다.

Authorizations

Path parameters

companyIdstringRequired

조직의 ID로, 'listCompanies'를 통해 얻을 수 있습니다.

Example: f23a80d2-2077-4e0a-aa85-e7b08a379be7

accountIdstringRequired

AWS 계정의 고유 식별자입니다.

Example: 123456789012

Responses

200

OK

*/*

400

Bad Request

404

Not Found

get

GET /platform/v2/companies/{companyId}/vendors/aws/accounts/{accountId}/recommendation-savingsplan HTTP/1.1
Host: api.kr.opsnow360.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "status": "success",
  "data": {
    "netSavings": "10000.7",
    "calculationStatus": "10000.7"
  }
}

getAwsAccountSetup

get

지정된 회사 ID에 연결된 AWS 계정의 설정 정보를 가져옵니다.

Authorizations

Path parameters

companyIdstringRequired

조직의 ID로, 'listCompanies'를 통해 얻을 수 있습니다.

Example: f23a80d2-2077-4e0a-aa85-e7b08a379be7

Query parameters

registrationTypestringOptional

AWS 계정을 등록하는 방법을 결정하는 데 사용됩니다. 값이 'single'이면 단일 계정을 등록하고, 'bulk'이면 여러 계정을 한 번에 등록하기 위한 정보를 제공합니다.

Default: singleExample: single

excludeAccountsstring[]Optional

계정 등록에 필요한 정보를 가져올 때, 일괄 선택 시 제외할 계정을 지정합니다. AWS 계정 번호를 쉼표로 구분하여 입력하면, 해당 계정을 제외한 정보가 반환됩니다.

Example: 123456789012, 234567890123

Responses

200

OK

*/*

400

Bad Request

404

Not Found

get

GET /platform/v2/companies/{companyId}/vendors/aws/accounts/setup HTTP/1.1
Host: api.kr.opsnow360.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "status": "success",
  "data": {
    "stackCreateConsoleLink": "https://console.aws.amazon.com/cloudformation/home?region=us-east-1#/stacks/create/review?templateURL=https://s3-data-dev-cloudformation.s3.ap-northeast-2.amazonaws.com/v1.2/opsnow-template-v1.2.yml&stackName=opsnow-stack-d442326f-878e-4500-8f82-d7c868f275bb&param_CostUsageReportBucketName=cur-d442326f-878e-4500-8f82-d7c868f275bb&param_CrossAccountExternalID=ae06161e-8d5b-4c34-80c1-26f2cf00fff5&param_CrossLinkedAccountID=370166107047&param_Domain=opsnow360.io&param_Profile=us2&param_UserId=0f27a2-ae56-4a2f-8544-68ecb8674639&param_ResourceId=d442326f-878e-4500-8f82-d7c868f275bb",
    "stackCreateCliCommand": "aws cloudformation create-stack --stack-name opsnow-stack-d442326f-878e-4500-8f82-d7c868f275bb --region us-east-1 --template-url https://s3-data-dev-cloudformation.s3.ap-northeast-2.amazonaws.com/v1.2/opsnow-template-v1.2.yml --parameters ParameterKey=CrossAccountExternalID,ParameterValue=ae06161e-8d5b-4c34-80c1-26f2cf00fff5 ParameterKey=CrossLinkedAccountID,ParameterValue=370166107047 ParameterKey=CostUsageReportBucketName,ParameterValue=cur-d442326f-878e-4500-8f82-d7c868f275bb ParameterKey=Domain,ParameterValue=opsnow360.io ParameterKey=Profile,ParameterValue=us2 ParameterKey=UserId,ParameterValue=0a0f27a2-ae56-4a2f-8544-68ecb8674639 ParameterKey=ResourceId,ParameterValue=d442326f-878e-4500-8f82-d7c868f275bb --capabilities CAPABILITY_NAMED_IAM",
    "stackDeleteCliCommand": "aws cloudformation delete-stack-set --stack-name opsnow-stack-d442326f-878e-4500-8f82-d7c868f275bb --region us-east-1 \\\\ && \\\\aws cloudformation delete-stack --stack-name opsnow-stack-d442326f-878e-4500-8f82-d7c868f275bb --region us-east-1 ",
    "stackName": "stack-7bfe7be4-b423-4e92-b6ad-b685ce2fb2e2",
    "templateUrl": "3f50b07a-df54-4a7e-8db7-75a5406e970d",
    "crossAccountExternalId": "ae06161e-8d5b-4c34-80c1-26f2cf00fff5",
    "crossLinkedAccountId": "123123123123",
    "costUsageReportBucketName": "cur-d442326f-878e-4500-8f82-d7c868f275bb",
    "domain": "sample.io",
    "profile": "us2",
    "userId": "a6e1e5f8-924d-4a8f-9f78-61c0879c9243",
    "resourceId": "3f50b07a-df54-4a7e-8db7-75a5406e970d",
    "organizationId": "f23a80d2-2077-4e0a-aa85-e7b08a379be7"
  }
}

listAwsAccounts

get

지정된 회사 ID에 연결된 AWS 계정 목록을 가져옵니다.

Authorizations

Path parameters

companyIdstringRequired

조직의 ID로, 'listCompanies'를 통해 얻을 수 있습니다.

Example: f23a80d2-2077-4e0a-aa85-e7b08a379be7

Responses

200

OK

*/*

400

Bad Request

404

Not Found

get

GET /platform/v2/companies/{companyId}/vendors/aws/management-accounts HTTP/1.1
Host: api.kr.opsnow360.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "status": "success",
  "data": {
    "list": [
      {
        "accountId": "123456789012",
        "accountAlias": "AWS 1st DEV Infra Account",
        "accountType": "master",
        "isCostAvailable": "true",
        "stackTemplateVersion": "1.0",
        "status": "healthy",
        "contractStatus": "SUBSCRIBED",
        "isSpPurchaseAccount": true,
        "errorDescription": "Error occurred during stack creation. You can identify the cause of the error in AWS Console > CloudFormation > Events tab. Please take necessary actions and retry.",
        "createdDate": "2024-05-20T07:06:47.253Z",
        "updatedDate": "2024-05-20T07:06:47.253Z"
      }
    ]
  }
}

listAzureTenants

get

지정된 회사 ID에 연결된 Azure 테넌트 목록을 가져옵니다.

Authorizations

Path parameters

companyIdstringRequired

조직의 ID로, 'listCompanies'를 통해 얻을 수 있습니다.

Example: f23a80d2-2077-4e0a-aa85-e7b08a379be7

Responses

200

OK

*/*

400

Bad Request

404

Not Found

get

GET /platform/v2/companies/{companyId}/vendors/azure/tenants HTTP/1.1
Host: api.kr.opsnow360.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "status": "success",
  "data": {
    "list": [
      {
        "tenantId": "6a05a771-d671-440a-9d64-087df0c16d6a",
        "applicationId": "993a65dd-691f-44f7-ba1d-21e7b4c60d38",
        "tenantAlias": "First Tenant",
        "tenantType": "PAY-AS-YOU-GO",
        "status": "healthy",
        "subscriptionCount": 5,
        "createdDate": "2023-07-10T14:48:00.000Z",
        "updatedDate": "2023-07-10T14:48:00.000Z"
      }
    ]
  }
}

createAzureTenant

post

지정된 회사 ID에 대한 새 Azure 테넌트를 생성합니다.

Authorizations

Path parameters

companyIdstringRequired

조직의 ID로, 'listCompanies'를 통해 얻을 수 있습니다.

Example: f23a80d2-2077-4e0a-aa85-e7b08a379be7

Body

tenantIdstringRequired

Azure Active Directory (AAD) 테넌트를 식별하는 데 사용되는 고유 식별자입니다. 조직의 모든 Azure 리소스와 서비스가 속한 테넌트를 구분하는 데 사용됩니다.

Example: 6a05a771-d671-440a-9d64-087df0c16d6a

tenantAliasstringRequired

Azure 테넌트의 별칭 이름입니다.

Example: First Tenant

applicationIdstringRequired

applicationId는 Azure Active Directory (AAD)에 등록된 애플리케이션에 할당된 고유 식별자입니다. 이 식별자는 애플리케이션을 식별하고 다른 서비스나 애플리케이션과 통신할 때 인증하는 데 사용됩니다. 종종 ClientId라고도 합니다. 예를 들어, 애플리케이션이 AAD에 인증 요청을 보낼 때 이 applicationId를 포함하여 자신의 신원을 증명합니다.

Example: 993a65dd-691f-44f7-ba1d-21e7b4c60d38

clientSecretstringRequired

clientSecret은 Azure Active Directory (AAD)에 애플리케이션을 등록할 때 생성되는 비밀 키입니다. 이 비밀 키는 애플리케이션이 인증 요청을 할 때 applicationId와 함께 사용됩니다. 두 정보가 일치하면 AAD는 애플리케이션의 정당성을 확인합니다. clientSecret은 민감한 정보이므로 안전하게 저장하고 관리하는 것이 중요합니다.

Example: your-client-secret

tenantTypestringRequired

테넌트의 유형을 나타내며, 주로 구독 모델에 따라 분류됩니다. 예를 들어 EA (Enterprise Agreement), Pay-As-You-Go, CSP, Azure Plan 등이 있습니다. 이는 테넌트가 사용하는 청구 계획과 관련된 정보를 제공합니다.

Example: PAY-AS-YOU-GOPattern: PAY-AS-YOU-GO|EA|AZURE-PLAN|CSP

enrollmentNumberstringOptional

'Enrollment Number'는 조직이 Microsoft Azure 서비스를 구매할 때 할당되는 고유 식별자입니다. 이 번호는 여러 구독을 관리하고, 사용량과 비용을 추적하여 청구 목적으로 사용되며, 특정 구독에 연결된 서비스와 리소스를 감독하는 데 사용됩니다. 조직이 Azure 서비스를 효율적으로 관리하고 모니터링할 수 있도록 합니다.

Example: 123456

primaryKeystringOptional

Azure Enterprise Agreement (EA) 계정의 맥락에서 PRIMARY_KEY는 조직에 제공되는 고유 키입니다. 이 키는 EA 계정과 관련된 Azure 서비스 및 리소스에 인증하고 접근하는 데 사용됩니다. 보안 자격 증명 역할을 하여 조직이 Azure 사용량과 청구를 관리하고 모니터링할 수 있도록 합니다.

Example: jwt-token-format

Responses

200

OK

*/*

400

Bad Request

404

Not Found

post

POST /platform/v2/companies/{companyId}/vendors/azure/tenants HTTP/1.1
Host: api.kr.opsnow360.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 260

{
  "tenantId": "6a05a771-d671-440a-9d64-087df0c16d6a",
  "tenantAlias": "First Tenant",
  "applicationId": "993a65dd-691f-44f7-ba1d-21e7b4c60d38",
  "clientSecret": "your-client-secret",
  "tenantType": "PAY-AS-YOU-GO",
  "enrollmentNumber": "123456",
  "primaryKey": "jwt-token-format"
}

{
  "status": "success",
  "data": {
    "tenantId": "6a05a771-d671-440a-9d64-087df0c16d6a"
  }
}

getAzureTenant

get

지정된 회사 ID에 연결된 특정 Azure 테넌트의 세부 정보를 가져옵니다.

Authorizations

Path parameters

companyIdstringRequired

조직의 ID로, 'listCompanies'를 통해 얻을 수 있습니다.

Example: f23a80d2-2077-4e0a-aa85-e7b08a379be7

tenantIdstringRequired

Azure Active Directory (AAD) 테넌트를 식별하는 데 사용되는 고유 식별자입니다. 조직의 모든 Azure 리소스와 서비스가 속한 테넌트를 구분하는 데 사용됩니다.

Example: 6a05a771-d671-440a-9d64-087df0c16d6a

Responses

200

OK

*/*

400

Bad Request

404

Not Found

get

GET /platform/v2/companies/{companyId}/vendors/azure/tenants/{tenantId} HTTP/1.1
Host: api.kr.opsnow360.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "status": "success",
  "data": {
    "tenantId": "6a05a771-d671-440a-9d64-087df0c16d6a",
    "tenantAlias": "First Tenant",
    "tenantType": "PAY-AS-YOU-GO",
    "applicationId": "993a65dd-691f-44f7-ba1d-21e7b4c60d38",
    "enrollmentNumber": "123456",
    "status": "healthy",
    "createdDate": "2023-07-10T14:48:00.000Z",
    "updatedDate": "2023-07-10T14:48:00.000Z"
  }
}

updateAzureTenant

put

지정된 회사 ID에 연결된 특정 Azure 테넌트의 정보를 업데이트합니다.

Authorizations

Path parameters

companyIdstringRequired

조직의 ID로, 'listCompanies'를 통해 얻을 수 있습니다.

Example: f23a80d2-2077-4e0a-aa85-e7b08a379be7

tenantIdstringRequired

Azure Active Directory (AAD) 테넌트를 식별하는 데 사용되는 고유 식별자입니다. 조직의 모든 Azure 리소스와 서비스가 속한 테넌트를 구분하는 데 사용됩니다.

Example: 6a05a771-d671-440a-9d64-087df0c16d6a

Body

tenantAliasstringRequired

Azure 테넌트의 별칭 이름입니다.

Example: First Tenant

Responses

200

OK

*/*

400

Bad Request

404

Not Found

put

PUT /platform/v2/companies/{companyId}/vendors/azure/tenants/{tenantId} HTTP/1.1
Host: api.kr.opsnow360.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 30

{
  "tenantAlias": "First Tenant"
}

{
  "status": "success",
  "data": {
    "tenantId": "6a05a771-d671-440a-9d64-087df0c16d6a",
    "subscriptionId": "c925a595-81d2-470c-a8cd-f7bd56fa8e95"
  }
}

deleteAzureTenant

delete

지정된 회사 ID에 연결된 특정 Azure 테넌트를 삭제합니다.

Authorizations

Path parameters

companyIdstringRequired

조직의 ID로, 'listCompanies'를 통해 얻을 수 있습니다.

Example: f23a80d2-2077-4e0a-aa85-e7b08a379be7

tenantIdstringRequired

Azure Active Directory (AAD) 테넌트를 식별하는 데 사용되는 고유 식별자입니다. 조직의 모든 Azure 리소스와 서비스가 속한 테넌트를 구분하는 데 사용됩니다.

Example: 6a05a771-d671-440a-9d64-087df0c16d6a

Responses

200

OK

*/*

400

Bad Request

404

Not Found

delete

DELETE /platform/v2/companies/{companyId}/vendors/azure/tenants/{tenantId} HTTP/1.1
Host: api.kr.opsnow360.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "status": "success",
  "data": {
    "tenantId": "6a05a771-d671-440a-9d64-087df0c16d6a"
  }
}

listAzureSubscriptions

get

지정된 테넌트 ID에 연결된 Azure 구독 목록을 가져옵니다.

Authorizations

Path parameters

companyIdstringRequired

조직의 ID로, 'listCompanies'를 통해 얻을 수 있습니다.

Example: f23a80d2-2077-4e0a-aa85-e7b08a379be7

tenantIdstringRequired

Azure Active Directory (AAD) 테넌트를 식별하는 데 사용되는 고유 식별자입니다. 조직의 모든 Azure 리소스와 서비스가 속한 테넌트를 구분하는 데 사용됩니다.

Example: 6a05a771-d671-440a-9d64-087df0c16d6a

Responses

200

OK

*/*

400

Bad Request

404

Not Found

get

GET /platform/v2/companies/{companyId}/vendors/azure/tenants/{tenantId}/subscriptions HTTP/1.1
Host: api.kr.opsnow360.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "status": "success",
  "data": {
    "list": [
      {
        "companyId": "123e4567-e89b-12d3-a456-426614174000",
        "subscriptionId": "c925a595-81d2-470c-a8cd-f7bd56fa8e95",
        "subscriptionAlias": "First Subscription",
        "tenantId": "6a05a771-d671-440a-9d64-087df0c16d6a",
        "status": "healthy"
      }
    ]
  }
}

createAzureSubscription

post

지정된 테넌트 ID에 대한 새 Azure 구독을 생성합니다.

Authorizations

Path parameters

companyIdstringRequired

조직의 ID로, 'listCompanies'를 통해 얻을 수 있습니다.

Example: f23a80d2-2077-4e0a-aa85-e7b08a379be7

tenantIdstringRequired

Azure Active Directory (AAD) 테넌트를 식별하는 데 사용되는 고유 식별자입니다. 조직의 모든 Azure 리소스와 서비스가 속한 테넌트를 구분하는 데 사용됩니다.

Example: 6a05a771-d671-440a-9d64-087df0c16d6a

Body

subscriptionIdstringRequired

Azure 구독의 고유 식별자입니다. Azure 리소스 및 서비스 집합을 관리하고 비용을 청구하는 데 사용됩니다.

Example: c925a595-81d2-470c-a8cd-f7bd56fa8e95

subscriptionAliasstringRequired

Azure 구독의 별칭 이름입니다.

Example: First Subscription

Responses

200

OK

*/*

400

Bad Request

404

Not Found

post

POST /platform/v2/companies/{companyId}/vendors/azure/tenants/{tenantId}/subscriptions HTTP/1.1
Host: api.kr.opsnow360.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 98

{
  "subscriptionId": "c925a595-81d2-470c-a8cd-f7bd56fa8e95",
  "subscriptionAlias": "First Subscription"
}

{
  "status": "success",
  "data": {
    "subscriptionId": "c925a595-81d2-470c-a8cd-f7bd56fa8e95",
    "tenantId": "6a05a771-d671-440a-9d64-087df0c16d6a"
  }
}

getAzureSubscription

get

지정된 테넌트 ID에 연결된 특정 Azure 구독의 세부 정보를 가져옵니다.

Authorizations

Path parameters

companyIdstringRequired

조직의 ID로, 'listCompanies'를 통해 얻을 수 있습니다.

Example: f23a80d2-2077-4e0a-aa85-e7b08a379be7

tenantIdstringRequired

Azure Active Directory (AAD) 테넌트를 식별하는 데 사용되는 고유 식별자입니다. 조직의 모든 Azure 리소스와 서비스가 속한 테넌트를 구분하는 데 사용됩니다.

Example: 6a05a771-d671-440a-9d64-087df0c16d6a

subscriptionIdstringRequired

Azure 구독의 고유 식별자입니다. Azure 리소스 및 서비스 집합을 관리하고 비용을 청구하는 데 사용됩니다.

Example: c925a595-81d2-470c-a8cd-f7bd56fa8e95

Responses

200

OK

*/*

400

Bad Request

404

Not Found

get

GET /platform/v2/companies/{companyId}/vendors/azure/tenants/{tenantId}/subscriptions/{subscriptionId} HTTP/1.1
Host: api.kr.opsnow360.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "status": "success",
  "data": {
    "tenantId": "6a05a771-d671-440a-9d64-087df0c16d6a",
    "subscriptionId": "c925a595-81d2-470c-a8cd-f7bd56fa8e95",
    "subscriptionAlias": "First Subscription",
    "status": "healthy",
    "createdDate": "2023-07-10T14:48:00.000Z",
    "updatedDate": "2023-07-10T14:48:00.000Z"
  }
}

updateAzureSubscription

put

지정된 테넌트 ID에 연결된 특정 Azure 구독의 정보를 업데이트합니다.

Authorizations

Path parameters

companyIdstringRequired

조직의 ID로, 'listCompanies'를 통해 얻을 수 있습니다.

Example: f23a80d2-2077-4e0a-aa85-e7b08a379be7

tenantIdstringRequired

Azure Active Directory (AAD) 테넌트를 식별하는 데 사용되는 고유 식별자입니다. 조직의 모든 Azure 리소스와 서비스가 속한 테넌트를 구분하는 데 사용됩니다.

Example: 6a05a771-d671-440a-9d64-087df0c16d6a

subscriptionIdstringRequired

Azure 구독의 고유 식별자입니다. Azure 리소스 및 서비스 집합을 관리하고 비용을 청구하는 데 사용됩니다.

Example: c925a595-81d2-470c-a8cd-f7bd56fa8e95

Body

subscriptionAliasstringRequired

Azure 구독의 별칭 이름입니다.

Example: First Subscription

Responses

200

OK

*/*

400

Bad Request

404

Not Found

put

PUT /platform/v2/companies/{companyId}/vendors/azure/tenants/{tenantId}/subscriptions/{subscriptionId} HTTP/1.1
Host: api.kr.opsnow360.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 42

{
  "subscriptionAlias": "First Subscription"
}

{
  "status": "success",
  "data": {
    "subscriptionId": "c925a595-81d2-470c-a8cd-f7bd56fa8e95",
    "tenantId": "6a05a771-d671-440a-9d64-087df0c16d6a"
  }
}

deleteAzureSubscription

delete

지정된 테넌트 ID에 연결된 특정 Azure 구독을 삭제합니다.

Authorizations

Path parameters

companyIdstringRequired

조직의 ID로, 'listCompanies'를 통해 얻을 수 있습니다.

Example: f23a80d2-2077-4e0a-aa85-e7b08a379be7

tenantIdstringRequired

Azure Active Directory (AAD) 테넌트를 식별하는 데 사용되는 고유 식별자입니다. 조직의 모든 Azure 리소스와 서비스가 속한 테넌트를 구분하는 데 사용됩니다.

Example: 6a05a771-d671-440a-9d64-087df0c16d6a

subscriptionIdstringRequired

Azure 구독의 고유 식별자입니다. Azure 리소스 및 서비스 집합을 관리하고 비용을 청구하는 데 사용됩니다.

Example: c925a595-81d2-470c-a8cd-f7bd56fa8e95

Responses

200

OK

*/*

400

Bad Request

404

Not Found

delete

DELETE /platform/v2/companies/{companyId}/vendors/azure/tenants/{tenantId}/subscriptions/{subscriptionId} HTTP/1.1
Host: api.kr.opsnow360.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "status": "success",
  "data": {
    "subscriptionId": "c925a595-81d2-470c-a8cd-f7bd56fa8e95",
    "tenantId": "6a05a771-d671-440a-9d64-087df0c16d6a"
  }
}

listAzureRegistrableSubscriptions

post

지정된 테넌트 ID에 대한 등록 가능한 Azure 구독 목록을 표시합니다.

Authorizations

Path parameters

companyIdstringRequired

조직의 ID로, 'listCompanies'를 통해 얻을 수 있습니다.

Example: f23a80d2-2077-4e0a-aa85-e7b08a379be7

Body

tenantIdstringRequired

Azure Active Directory (AAD) 테넌트를 식별하는 데 사용되는 고유 식별자입니다. 조직의 모든 Azure 리소스와 서비스가 속한 테넌트를 구분하는 데 사용됩니다.

Example: 6a05a771-d671-440a-9d64-087df0c16d6a

applicationIdstringRequired

applicationId는 Azure Active Directory (AAD)에 등록된 애플리케이션에 할당된 고유 식별자입니다. 이 식별자는 애플리케이션을 식별하고 다른 서비스나 애플리케이션과 통신할 때 인증하는 데 사용됩니다. 종종 ClientId라고도 합니다. 예를 들어, 애플리케이션이 AAD에 인증 요청을 보낼 때 이 applicationId를 포함하여 자신의 신원을 증명합니다.

Example: 993a65dd-691f-44f7-ba1d-21e7b4c60d38

clientSecretstringRequired

clientSecret은 Azure Active Directory (AAD)에 애플리케이션을 등록할 때 생성되는 비밀 키입니다. 이 비밀 키는 애플리케이션이 인증 요청을 할 때 applicationId와 함께 사용됩니다. 두 정보가 일치하면 AAD는 애플리케이션의 정당성을 확인합니다. clientSecret은 민감한 정보이므로 안전하게 저장하고 관리하는 것이 중요합니다.

Example: your-client-secret

tenantTypestringRequired

테넌트의 유형을 나타내며, 주로 구독 모델에 따라 분류됩니다. 예를 들어 EA (Enterprise Agreement), Pay-As-You-Go, CSP, Azure Plan 등이 있습니다. 이는 테넌트가 사용하는 청구 계획과 관련된 정보를 제공합니다.

Example: PAY-AS-YOU-GOPattern: PAY-AS-YOU-GO|EA|AZURE-PLAN|CSP

Responses

200

OK

*/*

400

Bad Request

404

Not Found

post

POST /platform/v2/companies/{companyId}/vendors/azure/tenants/registrable-subscriptions HTTP/1.1
Host: api.kr.opsnow360.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 171

{
  "tenantId": "6a05a771-d671-440a-9d64-087df0c16d6a",
  "applicationId": "993a65dd-691f-44f7-ba1d-21e7b4c60d38",
  "clientSecret": "your-client-secret",
  "tenantType": "PAY-AS-YOU-GO"
}

{
  "status": "success",
  "data": {
    "list": [
      {
        "companyId": "123e4567-e89b-12d3-a456-426614174000",
        "subscriptionId": "c925a595-81d2-470c-a8cd-f7bd56fa8e95",
        "subscriptionAlias": "First Subscription",
        "tenantId": "6a05a771-d671-440a-9d64-087df0c16d6a",
        "status": "healthy"
      }
    ]
  }
}

listGcpProjects

get

지정된 회사 ID에 연결된 GCP 프로젝트 목록을 가져옵니다.

Authorizations

Path parameters

companyIdstringRequired

조직의 ID로, 'listCompanies'를 통해 얻을 수 있습니다.

Example: f23a80d2-2077-4e0a-aa85-e7b08a379be7

Responses

200

OK

*/*

400

Bad Request

404

Not Found

get

GET /platform/v2/companies/{companyId}/vendors/gcp/projects HTTP/1.1
Host: api.kr.opsnow360.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "status": "success",
  "data": {
    "list": [
      {
        "projectId": "cloud-platform-1234",
        "projectAlias": "My Cloud Project",
        "projectType": "BILLING",
        "companyName": "company1",
        "serviceAccountId": "106821279384347983826",
        "datasetId": "my_dataset",
        "bigqueryTableName": "users_table",
        "status": "active"
      }
    ]
  }
}

createGcpProject

post

지정된 회사 ID에 대한 새 GCP 프로젝트를 생성합니다.

Authorizations

Path parameters

companyIdstringRequired

조직의 ID로, 'listCompanies'를 통해 얻을 수 있습니다.

Example: f23a80d2-2077-4e0a-aa85-e7b08a379be7

Body

serviceAccountIdstringRequired

Google Cloud 서비스 계정을 식별하는 데 사용되는 고유 식별자입니다. Google Cloud 리소스 및 서비스와 상호 작용하는 서비스 계정을 구분하는 데 사용됩니다.

Example: 106821279384347983826

projectIdstringRequired

Google Cloud Platform 프로젝트의 고유 식별자입니다. GCP 리소스, 서비스 및 청구를 조직하고 관리하는 데 사용됩니다.

Example: cloud-platform-1234

projectAliasstringRequired

GCP 프로젝트의 사용자 친화적인 이름 또는 별칭으로, 더 쉽게 식별하고 관리할 수 있도록 사용됩니다.

Example: My Cloud Project

datasetIdstringOptional

BigQuery 데이터셋의 고유 식별자입니다. Google Cloud Platform에서 테이블과 뷰의 모음입니다.

Example: my_dataset

Responses

200

OK

*/*

400

Bad Request

404

Not Found

post

POST /platform/v2/companies/{companyId}/vendors/gcp/projects HTTP/1.1
Host: api.kr.opsnow360.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 137

{
  "serviceAccountId": "106821279384347983826",
  "projectId": "cloud-platform-1234",
  "projectAlias": "My Cloud Project",
  "datasetId": "my_dataset"
}

{
  "status": "success",
  "data": {
    "projectId": "cloud-platform-1234"
  }
}

getGcpProject

get

지정된 회사 ID 및 프로젝트 ID에 연결된 특정 GCP 프로젝트의 세부 정보를 가져옵니다.

Authorizations

Path parameters

companyIdstringRequired

조직의 ID로, 'listCompanies'를 통해 얻을 수 있습니다.

Example: f23a80d2-2077-4e0a-aa85-e7b08a379be7

projectIdstringRequired

Google Cloud Platform 프로젝트의 고유 식별자입니다. GCP 리소스, 서비스 및 청구를 조직하고 관리하는 데 사용됩니다.

Example: cloud-platform-1234

Responses

200

OK

*/*

400

Bad Request

404

Not Found

get

GET /platform/v2/companies/{companyId}/vendors/gcp/projects/{projectId} HTTP/1.1
Host: api.kr.opsnow360.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "status": "success",
  "data": {
    "projectId": "cloud-platform-1234",
    "projectAlias": "My Cloud Project",
    "companyName": "company1",
    "serviceAccountId": "106821279384347983826",
    "projectType": "BILLING",
    "datasetId": "my_dataset",
    "bigQueryTableName": "users_table",
    "status": "active",
    "createdDate": "2023-07-10T14:48:00.000Z",
    "updatedDate": "2023-07-10T14:48:00.000Z"
  }
}

updateGcpProject

put

지정된 프로젝트 ID에 대한 특정 GCP 프로젝트의 정보를 업데이트합니다.

Authorizations

Path parameters

companyIdstringRequired

조직의 ID로, 'listCompanies'를 통해 얻을 수 있습니다.

Example: f23a80d2-2077-4e0a-aa85-e7b08a379be7

projectIdstringRequired

Google Cloud Platform 프로젝트의 고유 식별자입니다. GCP 리소스, 서비스 및 청구를 조직하고 관리하는 데 사용됩니다.

Example: cloud-platform-1234

Body

projectAliasstringOptional

GCP 프로젝트의 사용자 친화적인 이름 또는 별칭으로, 더 쉽게 식별하고 관리할 수 있도록 사용됩니다.

Example: My Cloud Project

datasetIdstringOptional

BigQuery 데이터셋의 고유 식별자입니다. Google Cloud Platform에서 테이블과 뷰의 모음입니다.

Example: my_dataset

Responses

200

OK

*/*

400

Bad Request

404

Not Found

put

PUT /platform/v2/companies/{companyId}/vendors/gcp/projects/{projectId} HTTP/1.1
Host: api.kr.opsnow360.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 60

{
  "projectAlias": "My Cloud Project",
  "datasetId": "my_dataset"
}

{
  "status": "success",
  "data": {
    "projectId": "cloud-platform-1234"
  }
}

deleteGcpProject

delete

지정된 프로젝트 ID에 연결된 특정 GCP 프로젝트를 삭제합니다.

Authorizations

Path parameters

companyIdstringRequired

조직의 ID로, 'listCompanies'를 통해 얻을 수 있습니다.

Example: f23a80d2-2077-4e0a-aa85-e7b08a379be7

projectIdstringRequired

Google Cloud Platform 프로젝트의 고유 식별자입니다. GCP 리소스, 서비스 및 청구를 조직하고 관리하는 데 사용됩니다.

Example: cloud-platform-1234

Responses

200

OK

*/*

400

Bad Request

404

Not Found

delete

DELETE /platform/v2/companies/{companyId}/vendors/gcp/projects/{projectId} HTTP/1.1
Host: api.kr.opsnow360.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "status": "success",
  "data": {
    "projectId": "cloud-platform-1234"
  }
}

listGcpServiceAccounts

get

지정된 회사 ID에 연결된 GCP 서비스 계정 목록을 가져옵니다.

Authorizations

Path parameters

companyIdstringRequired

조직의 ID로, 'listCompanies'를 통해 얻을 수 있습니다.

Example: f23a80d2-2077-4e0a-aa85-e7b08a379be7

Responses

200

OK

*/*

400

Bad Request

404

Not Found

get

GET /platform/v2/companies/{companyId}/vendors/gcp/service-accounts HTTP/1.1
Host: api.kr.opsnow360.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "status": "success",
  "data": {
    "list": [
      {
        "serviceAccountId": "106821279384347983826",
        "serviceAccountAlias": "my-service-account",
        "serviceAccountEmail": "[email protected]",
        "status": "healthy",
        "createdDate": "2023-07-10T14:48:00.000Z",
        "updatedDate": "2023-07-10T14:48:00.000Z"
      }
    ]
  }
}

createGcpServiceAccount

post

지정된 회사 ID에 대한 새 GCP 서비스 계정을 생성합니다.

Authorizations

Path parameters

companyIdstringRequired

조직의 ID로, 'listCompanies'를 통해 얻을 수 있습니다.

Example: f23a80d2-2077-4e0a-aa85-e7b08a379be7

Body

serviceAccountAliasstringRequired

GCP 서비스 계정의 별칭 이름입니다.

Example: my-service-account

serviceAccountKeystringRequired

GCP 서비스 계정의 자격 증명을 포함하는 JSON 키 파일의 Base64 인코딩된 문자열입니다.

Example: <Base64-encoded JSON key file string>

Responses

200

OK

*/*

400

Bad Request

404

Not Found

post

POST /platform/v2/companies/{companyId}/vendors/gcp/service-accounts HTTP/1.1
Host: api.kr.opsnow360.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 104

{
  "serviceAccountAlias": "my-service-account",
  "serviceAccountKey": "<Base64-encoded JSON key file string>"
}

{
  "status": "success",
  "data": {
    "serviceAccountId": "106821279384347983826"
  }
}

getGcpServiceAccount

get

특정 GCP 서비스 계정과 그 연결된 프로젝트에 대한 세부 정보를 가져옵니다.

Authorizations

Path parameters

companyIdstringRequired

조직의 ID로, 'listCompanies'를 통해 얻을 수 있습니다.

Example: f23a80d2-2077-4e0a-aa85-e7b08a379be7

serviceAccountIdstringRequired

Google Cloud 서비스 계정을 식별하는 데 사용되는 고유 식별자입니다. Google Cloud 리소스 및 서비스와 상호 작용하는 서비스 계정을 구분하는 데 사용됩니다.

Example: 106821279384347980000

Responses

200

OK

*/*

400

Bad Request

404

Not Found

get

GET /platform/v2/companies/{companyId}/vendors/gcp/service-accounts/{serviceAccountId} HTTP/1.1
Host: api.kr.opsnow360.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "status": "success",
  "data": {
    "serviceAccountId": "106821279384347983826",
    "serviceAccountAlias": "my-service-account",
    "serviceAccountProjectId": "cloud-platform-1234",
    "serviceAccountEmail": "[email protected]",
    "createdDate": "2023-07-10T14:48:00.000Z",
    "updatedDate": "2023-07-10T14:48:00.000Z",
    "projects": [
      {
        "projectId": "cloud-platform-1234",
        "projectAlias": "My Cloud Project",
        "companyName": "company1",
        "serviceAccountId": "106821279384347983826",
        "projectType": "BILLING",
        "datasetId": "my_dataset",
        "bigQueryTableName": "users_table",
        "status": "active",
        "createdDate": "2023-07-10T14:48:00.000Z",
        "updatedDate": "2023-07-10T14:48:00.000Z"
      }
    ]
  }
}

updateGcpServiceAccount

put

지정된 회사 ID에 연결된 특정 GCP 계정의 정보를 업데이트합니다.

Authorizations

Path parameters

companyIdstringRequired

조직의 ID로, 'listCompanies'를 통해 얻을 수 있습니다.

Example: f23a80d2-2077-4e0a-aa85-e7b08a379be7

serviceAccountIdstringRequired

Google Cloud 서비스 계정을 식별하는 데 사용되는 고유 식별자입니다. Google Cloud 리소스 및 서비스와 상호 작용하는 서비스 계정을 구분하는 데 사용됩니다.

Example: 106821279384347980000

Body

serviceAccountAliasstringRequired

GCP 서비스 계정의 별칭 이름입니다.

Example: my-service-account

Responses

200

OK

*/*

400

Bad Request

404

Not Found

put

PUT /platform/v2/companies/{companyId}/vendors/gcp/service-accounts/{serviceAccountId} HTTP/1.1
Host: api.kr.opsnow360.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 44

{
  "serviceAccountAlias": "my-service-account"
}

{
  "status": "success",
  "data": {
    "serviceAccountId": "106821279384347983826"
  }
}

deleteGcpServiceAccount

delete

지정된 회사 ID에 연결된 특정 GCP 계정을 삭제합니다.

Authorizations

Path parameters

companyIdstringRequired

조직의 ID로, 'listCompanies'를 통해 얻을 수 있습니다.

Example: f23a80d2-2077-4e0a-aa85-e7b08a379be7

serviceAccountIdstringRequired

Google Cloud 서비스 계정을 식별하는 데 사용되는 고유 식별자입니다. Google Cloud 리소스 및 서비스와 상호 작용하는 서비스 계정을 구분하는 데 사용됩니다.

Example: 106821279384347980000

Responses

200

OK

*/*

400

Bad Request

404

Not Found

delete

DELETE /platform/v2/companies/{companyId}/vendors/gcp/service-accounts/{serviceAccountId} HTTP/1.1
Host: api.kr.opsnow360.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "status": "success",
  "data": {
    "serviceAccountId": "106821279384347983826"
  }
}

listGcpServiceAccountProjects

get

지정된 서비스 계정 ID에 연결된 GCP 프로젝트 목록을 가져옵니다.

Authorizations

Path parameters

companyIdstringRequired

조직의 ID로, 'listCompanies'를 통해 얻을 수 있습니다.

Example: f23a80d2-2077-4e0a-aa85-e7b08a379be7

serviceAccountIdstringRequired

Google Cloud 서비스 계정을 식별하는 데 사용되는 고유 식별자입니다. Google Cloud 리소스 및 서비스와 상호 작용하는 서비스 계정을 구분하는 데 사용됩니다.

Example: 106821279384347980000

Responses

200

OK

*/*

400

Bad Request

404

Not Found

get

GET /platform/v2/companies/{companyId}/vendors/gcp/service-accounts/{serviceAccountId}/projects HTTP/1.1
Host: api.kr.opsnow360.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "status": "success",
  "data": {
    "list": [
      {
        "projectId": "cloud-platform-1234",
        "projectAlias": "My Cloud Project",
        "projectType": "BILLING",
        "companyName": "company1",
        "serviceAccountId": "106821279384347983826",
        "datasetId": "my_dataset",
        "bigqueryTableName": "users_table",
        "status": "active"
      }
    ]
  }
}

Company APIs

listCompanies

listCompanyUsers

Cloud Account - AWS APIs

listAwsAccounts

getAwsAccount

updateAwsAccount

deleteAwsAccount

getAwsAccountSavingsAmount

getAwsAccountSetup

listAwsAccounts

Cloud Account - Azure APIs

listAzureTenants

createAzureTenant

getAzureTenant

updateAzureTenant

deleteAzureTenant

listAzureSubscriptions

createAzureSubscription

getAzureSubscription

updateAzureSubscription

deleteAzureSubscription

listAzureRegistrableSubscriptions

Cloud Account - GCP APIs

listGcpProjects

createGcpProject

getGcpProject

updateGcpProject

deleteGcpProject

listGcpServiceAccounts

createGcpServiceAccount

getGcpServiceAccount

updateGcpServiceAccount

deleteGcpServiceAccount

listGcpServiceAccountProjects