Skip to content

Latest commit

 

History

History
787 lines (493 loc) · 24.7 KB

CloudInsightsApi.md

File metadata and controls

787 lines (493 loc) · 24.7 KB
Raw

\CloudInsightsApi

All URIs are relative to https://console.jumpcloud.com/api/v2

Method HTTP request Description
CloudInsightsCreateAccount Post /cloudinsights/accounts
CloudInsightsCreateSavedView Post /cloudinsights/views
CloudInsightsDeleteSavedView Delete /cloudinsights/views/{view_id}
CloudInsightsFetchDistinctFieldValues Post /cloudinsights/events/distinct
CloudInsightsFetchSavedView Get /cloudinsights/views/{view_id}
CloudInsightsFetchSavedViewsList Get /cloudinsights/views
CloudInsightsGetAccountByID Get /cloudinsights/accounts/{cloud_insights_id}
CloudInsightsListAccounts Get /cloudinsights/accounts
CloudInsightsListEvents Post /cloudinsights/events
CloudInsightsUpdateAccountByID Put /cloudinsights/accounts/{cloud_insights_id} Update Cloud Insights Account record by ID
CloudInsightsUpdateSavedView Put /cloudinsights/views/{view_id}

CloudInsightsCreateAccount

CloudInsightsAccountPostResponse CloudInsightsCreateAccount(ctx).XOrgId(xOrgId).Body(body).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/ConductorOne/baton-jumpcloud/pkg/jcapi2"
)

func main() {
    xOrgId := "xOrgId_example" // string | Organization identifier that can be obtained from console settings. (optional)
    body := *openapiclient.NewCloudInsightsAccountPost("AwsAccountId_example", "AwsRegion_example") // CloudInsightsAccountPost |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.CloudInsightsApi.CloudInsightsCreateAccount(context.Background()).XOrgId(xOrgId).Body(body).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `CloudInsightsApi.CloudInsightsCreateAccount``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `CloudInsightsCreateAccount`: CloudInsightsAccountPostResponse
    fmt.Fprintf(os.Stdout, "Response from `CloudInsightsApi.CloudInsightsCreateAccount`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiCloudInsightsCreateAccountRequest struct via the builder pattern

Name Type Description Notes
xOrgId string Organization identifier that can be obtained from console settings.
body CloudInsightsAccountPost

Return type

CloudInsightsAccountPostResponse

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: text/plain, text/json, text/html

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CloudInsightsCreateSavedView

CloudInsightsSavedViewResponse CloudInsightsCreateSavedView(ctx).XOrgId(xOrgId).Body(body).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/ConductorOne/baton-jumpcloud/pkg/jcapi2"
)

func main() {
    xOrgId := "xOrgId_example" // string | Organization identifier that can be obtained from console settings. (optional)
    body := *openapiclient.NewCloudInsightsSavedViewPost("Name_example") // CloudInsightsSavedViewPost |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.CloudInsightsApi.CloudInsightsCreateSavedView(context.Background()).XOrgId(xOrgId).Body(body).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `CloudInsightsApi.CloudInsightsCreateSavedView``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `CloudInsightsCreateSavedView`: CloudInsightsSavedViewResponse
    fmt.Fprintf(os.Stdout, "Response from `CloudInsightsApi.CloudInsightsCreateSavedView`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiCloudInsightsCreateSavedViewRequest struct via the builder pattern

Name Type Description Notes
xOrgId string Organization identifier that can be obtained from console settings.
body CloudInsightsSavedViewPost

Return type

CloudInsightsSavedViewResponse

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CloudInsightsDeleteSavedView

CloudInsightsSavedViewId CloudInsightsDeleteSavedView(ctx, viewId).XOrgId(xOrgId).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/ConductorOne/baton-jumpcloud/pkg/jcapi2"
)

func main() {
    viewId := "viewId_example" // string | objectId of the Cloud Insights Saved View record.
    xOrgId := "xOrgId_example" // string | Organization identifier that can be obtained from console settings. (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.CloudInsightsApi.CloudInsightsDeleteSavedView(context.Background(), viewId).XOrgId(xOrgId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `CloudInsightsApi.CloudInsightsDeleteSavedView``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `CloudInsightsDeleteSavedView`: CloudInsightsSavedViewId
    fmt.Fprintf(os.Stdout, "Response from `CloudInsightsApi.CloudInsightsDeleteSavedView`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
viewId string objectId of the Cloud Insights Saved View record.

Other Parameters

Other parameters are passed through a pointer to a apiCloudInsightsDeleteSavedViewRequest struct via the builder pattern

Name Type Description Notes

xOrgId | string | Organization identifier that can be obtained from console settings. |

Return type

CloudInsightsSavedViewId

Authorization

x-api-key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CloudInsightsFetchDistinctFieldValues

CloudInsightsEventsDistinctResponse CloudInsightsFetchDistinctFieldValues(ctx).XOrgId(xOrgId).Body(body).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/ConductorOne/baton-jumpcloud/pkg/jcapi2"
)

func main() {
    xOrgId := "xOrgId_example" // string | Organization identifier that can be obtained from console settings. (optional)
    body := *openapiclient.NewCloudInsightsEventsDistinctPost([]string{"AwsAccounts_example"}, *openapiclient.NewCloudInsightsEventsDistinctPostEndTime()) // CloudInsightsEventsDistinctPost |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.CloudInsightsApi.CloudInsightsFetchDistinctFieldValues(context.Background()).XOrgId(xOrgId).Body(body).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `CloudInsightsApi.CloudInsightsFetchDistinctFieldValues``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `CloudInsightsFetchDistinctFieldValues`: CloudInsightsEventsDistinctResponse
    fmt.Fprintf(os.Stdout, "Response from `CloudInsightsApi.CloudInsightsFetchDistinctFieldValues`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiCloudInsightsFetchDistinctFieldValuesRequest struct via the builder pattern

Name Type Description Notes
xOrgId string Organization identifier that can be obtained from console settings.
body CloudInsightsEventsDistinctPost

Return type

CloudInsightsEventsDistinctResponse

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CloudInsightsFetchSavedView

CloudInsightsSavedViewResponse CloudInsightsFetchSavedView(ctx, viewId).XOrgId(xOrgId).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/ConductorOne/baton-jumpcloud/pkg/jcapi2"
)

func main() {
    viewId := "viewId_example" // string | objectId of the Cloud Insights Saved View record.
    xOrgId := "xOrgId_example" // string | Organization identifier that can be obtained from console settings. (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.CloudInsightsApi.CloudInsightsFetchSavedView(context.Background(), viewId).XOrgId(xOrgId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `CloudInsightsApi.CloudInsightsFetchSavedView``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `CloudInsightsFetchSavedView`: CloudInsightsSavedViewResponse
    fmt.Fprintf(os.Stdout, "Response from `CloudInsightsApi.CloudInsightsFetchSavedView`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
viewId string objectId of the Cloud Insights Saved View record.

Other Parameters

Other parameters are passed through a pointer to a apiCloudInsightsFetchSavedViewRequest struct via the builder pattern

Name Type Description Notes

xOrgId | string | Organization identifier that can be obtained from console settings. |

Return type

CloudInsightsSavedViewResponse

Authorization

x-api-key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CloudInsightsFetchSavedViewsList

[]CloudInsightsSavedViewResponse CloudInsightsFetchSavedViewsList(ctx).XOrgId(xOrgId).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/ConductorOne/baton-jumpcloud/pkg/jcapi2"
)

func main() {
    xOrgId := "xOrgId_example" // string | Organization identifier that can be obtained from console settings. (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.CloudInsightsApi.CloudInsightsFetchSavedViewsList(context.Background()).XOrgId(xOrgId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `CloudInsightsApi.CloudInsightsFetchSavedViewsList``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `CloudInsightsFetchSavedViewsList`: []CloudInsightsSavedViewResponse
    fmt.Fprintf(os.Stdout, "Response from `CloudInsightsApi.CloudInsightsFetchSavedViewsList`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiCloudInsightsFetchSavedViewsListRequest struct via the builder pattern

Name Type Description Notes
xOrgId string Organization identifier that can be obtained from console settings.

Return type

[]CloudInsightsSavedViewResponse

Authorization

x-api-key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CloudInsightsGetAccountByID

CloudInsightsAccountGet CloudInsightsGetAccountByID(ctx, cloudInsightsId).XOrgId(xOrgId).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/ConductorOne/baton-jumpcloud/pkg/jcapi2"
)

func main() {
    cloudInsightsId := "cloudInsightsId_example" // string | objectId of the Cloud Insights instance.
    xOrgId := "xOrgId_example" // string | Organization identifier that can be obtained from console settings. (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.CloudInsightsApi.CloudInsightsGetAccountByID(context.Background(), cloudInsightsId).XOrgId(xOrgId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `CloudInsightsApi.CloudInsightsGetAccountByID``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `CloudInsightsGetAccountByID`: CloudInsightsAccountGet
    fmt.Fprintf(os.Stdout, "Response from `CloudInsightsApi.CloudInsightsGetAccountByID`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
cloudInsightsId string objectId of the Cloud Insights instance.

Other Parameters

Other parameters are passed through a pointer to a apiCloudInsightsGetAccountByIDRequest struct via the builder pattern

Name Type Description Notes

xOrgId | string | Organization identifier that can be obtained from console settings. |

Return type

CloudInsightsAccountGet

Authorization

x-api-key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CloudInsightsListAccounts

CloudInsightsAccountListResponse CloudInsightsListAccounts(ctx).XOrgId(xOrgId).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/ConductorOne/baton-jumpcloud/pkg/jcapi2"
)

func main() {
    xOrgId := "xOrgId_example" // string | Organization identifier that can be obtained from console settings. (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.CloudInsightsApi.CloudInsightsListAccounts(context.Background()).XOrgId(xOrgId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `CloudInsightsApi.CloudInsightsListAccounts``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `CloudInsightsListAccounts`: CloudInsightsAccountListResponse
    fmt.Fprintf(os.Stdout, "Response from `CloudInsightsApi.CloudInsightsListAccounts`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiCloudInsightsListAccountsRequest struct via the builder pattern

Name Type Description Notes
xOrgId string Organization identifier that can be obtained from console settings.

Return type

CloudInsightsAccountListResponse

Authorization

x-api-key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CloudInsightsListEvents

CloudInsightsEventsListResponse CloudInsightsListEvents(ctx).XOrgId(xOrgId).Body(body).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/ConductorOne/baton-jumpcloud/pkg/jcapi2"
)

func main() {
    xOrgId := "xOrgId_example" // string | Organization identifier that can be obtained from console settings. (optional)
    body := *openapiclient.NewCloudInsightsEventsListPost() // CloudInsightsEventsListPost |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.CloudInsightsApi.CloudInsightsListEvents(context.Background()).XOrgId(xOrgId).Body(body).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `CloudInsightsApi.CloudInsightsListEvents``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `CloudInsightsListEvents`: CloudInsightsEventsListResponse
    fmt.Fprintf(os.Stdout, "Response from `CloudInsightsApi.CloudInsightsListEvents`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiCloudInsightsListEventsRequest struct via the builder pattern

Name Type Description Notes
xOrgId string Organization identifier that can be obtained from console settings.
body CloudInsightsEventsListPost

Return type

CloudInsightsEventsListResponse

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CloudInsightsUpdateAccountByID

CloudInsightsAccountGet CloudInsightsUpdateAccountByID(ctx, cloudInsightsId).XOrgId(xOrgId).Body(body).Execute()

Update Cloud Insights Account record by ID

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/ConductorOne/baton-jumpcloud/pkg/jcapi2"
)

func main() {
    cloudInsightsId := "cloudInsightsId_example" // string | objectId of the Cloud Insights instance.
    xOrgId := "xOrgId_example" // string | Organization identifier that can be obtained from console settings. (optional)
    body := *openapiclient.NewCloudInsightsAccountPut() // CloudInsightsAccountPut |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.CloudInsightsApi.CloudInsightsUpdateAccountByID(context.Background(), cloudInsightsId).XOrgId(xOrgId).Body(body).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `CloudInsightsApi.CloudInsightsUpdateAccountByID``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `CloudInsightsUpdateAccountByID`: CloudInsightsAccountGet
    fmt.Fprintf(os.Stdout, "Response from `CloudInsightsApi.CloudInsightsUpdateAccountByID`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
cloudInsightsId string objectId of the Cloud Insights instance.

Other Parameters

Other parameters are passed through a pointer to a apiCloudInsightsUpdateAccountByIDRequest struct via the builder pattern

Name Type Description Notes

xOrgId | string | Organization identifier that can be obtained from console settings. | body | CloudInsightsAccountPut | |

Return type

CloudInsightsAccountGet

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CloudInsightsUpdateSavedView

CloudInsightsSavedViewResponse CloudInsightsUpdateSavedView(ctx, viewId).XOrgId(xOrgId).Body(body).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/ConductorOne/baton-jumpcloud/pkg/jcapi2"
)

func main() {
    viewId := "viewId_example" // string | objectId of the Cloud Insights Saved View record.
    xOrgId := "xOrgId_example" // string | Organization identifier that can be obtained from console settings. (optional)
    body := *openapiclient.NewCloudInsightsSavedViewPut() // CloudInsightsSavedViewPut |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.CloudInsightsApi.CloudInsightsUpdateSavedView(context.Background(), viewId).XOrgId(xOrgId).Body(body).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `CloudInsightsApi.CloudInsightsUpdateSavedView``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `CloudInsightsUpdateSavedView`: CloudInsightsSavedViewResponse
    fmt.Fprintf(os.Stdout, "Response from `CloudInsightsApi.CloudInsightsUpdateSavedView`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
viewId string objectId of the Cloud Insights Saved View record.

Other Parameters

Other parameters are passed through a pointer to a apiCloudInsightsUpdateSavedViewRequest struct via the builder pattern

Name Type Description Notes

xOrgId | string | Organization identifier that can be obtained from console settings. | body | CloudInsightsSavedViewPut | |

Return type

CloudInsightsSavedViewResponse

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]