Skip to content

Latest commit

 

History

History
683 lines (430 loc) · 20.1 KB

CloudAzureApi.md

File metadata and controls

683 lines (430 loc) · 20.1 KB
Raw

\CloudAzureApi

All URIs are relative to /api

Method HTTP request Description
V1AzureAdMigrationReportsIdDownloadGet Get /v1/azure-ad-migration/reports/{id}/download Download report of provided report ID
V1AzureAdMigrationReportsIdGet Get /v1/azure-ad-migration/reports/{id} Check status of azure ad migration report
V1AzureAdMigrationReportsPendingGet Get /v1/azure-ad-migration/reports/pending Get pending azure migration report
V1AzureAdMigrationReportsPost Post /v1/azure-ad-migration/reports Start Azure Ad Migration report generation
V1CloudAzureDefaultsMappingsGet Get /v1/cloud-azure/defaults/mappings Get default mappings
V1CloudAzureDefaultsServerConfigurationGet Get /v1/cloud-azure/defaults/server-configuration Get default server configuration
V1CloudAzureIdDelete Delete /v1/cloud-azure/{id} Delete Cloud Identity Provider configuration.
V1CloudAzureIdGet Get /v1/cloud-azure/{id} Get Azure Cloud Identity Provider configuration with given ID.
V1CloudAzureIdPut Put /v1/cloud-azure/{id} Update Azure Cloud Identity Provider configuration
V1CloudAzurePost Post /v1/cloud-azure Create Azure Cloud Identity Provider configuration

V1AzureAdMigrationReportsIdDownloadGet

interface{} V1AzureAdMigrationReportsIdDownloadGet(ctx, id).Execute()

Download report of provided report ID

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    id := "id_example" // string | Existing report ID

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string Existing report ID

Other Parameters

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

Name Type Description Notes

Return type

interface{}

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet, application/json

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

V1AzureAdMigrationReportsIdGet

AzureAdMigrationReportProcessStatus V1AzureAdMigrationReportsIdGet(ctx, id).Execute()

Check status of azure ad migration report

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    id := "id_example" // string | Existing report ID

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string Existing report ID

Other Parameters

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

Name Type Description Notes

Return type

AzureAdMigrationReportProcessStatus

Authorization

Bearer

HTTP request headers

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

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

V1AzureAdMigrationReportsPendingGet

AzureAdMigrationReportProcessStatus V1AzureAdMigrationReportsPendingGet(ctx).Execute()

Get pending azure migration report

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {

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

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

AzureAdMigrationReportProcessStatus

Authorization

Bearer

HTTP request headers

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

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

V1AzureAdMigrationReportsPost

HrefResponse V1AzureAdMigrationReportsPost(ctx).AzureAdMigrationReportRequest(azureAdMigrationReportRequest).Execute()

Start Azure Ad Migration report generation

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    azureAdMigrationReportRequest := *openapiclient.NewAzureAdMigrationReportRequest(int32(1), int32(1001), *openapiclient.NewAzureMappings("id", "userPrincipalName", "displayName", "mail", "department", "companyName", "officeLocation", "mobilePhone", "jobTitle", "id", "displayName")) // AzureAdMigrationReportRequest | Necessary input to create a new migration report

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

Path Parameters

Other Parameters

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

Name Type Description Notes
azureAdMigrationReportRequest AzureAdMigrationReportRequest Necessary input to create a new migration report

Return type

HrefResponse

Authorization

Bearer

HTTP request headers

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

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

V1CloudAzureDefaultsMappingsGet

AzureMappings V1CloudAzureDefaultsMappingsGet(ctx).Execute()

Get default mappings

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {

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

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

AzureMappings

Authorization

Bearer

HTTP request headers

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

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

V1CloudAzureDefaultsServerConfigurationGet

AzureServerConfiguration V1CloudAzureDefaultsServerConfigurationGet(ctx).Execute()

Get default server configuration

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {

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

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

AzureServerConfiguration

Authorization

Bearer

HTTP request headers

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

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

V1CloudAzureIdDelete

V1CloudAzureIdDelete(ctx, id).Execute()

Delete Cloud Identity Provider configuration.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    id := "id_example" // string | Cloud Identity Provider identifier

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.CloudAzureApi.V1CloudAzureIdDelete(context.Background(), id).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `CloudAzureApi.V1CloudAzureIdDelete``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string Cloud Identity Provider identifier

Other Parameters

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

Name Type Description Notes

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

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

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

V1CloudAzureIdGet

AzureConfiguration V1CloudAzureIdGet(ctx, id).Execute()

Get Azure Cloud Identity Provider configuration with given ID.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    id := "id_example" // string | Cloud Identity Provider identifier

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string Cloud Identity Provider identifier

Other Parameters

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

Name Type Description Notes

Return type

AzureConfiguration

Authorization

Bearer

HTTP request headers

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

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

V1CloudAzureIdPut

AzureConfiguration V1CloudAzureIdPut(ctx, id).AzureConfigurationUpdate(azureConfigurationUpdate).Execute()

Update Azure Cloud Identity Provider configuration

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    id := "id_example" // string | Cloud Identity Provider identifier
    azureConfigurationUpdate := *openapiclient.NewAzureConfigurationUpdate(*openapiclient.NewCloudIdPCommon("1001", "Google Secure LDAP", "GOOGLE"), *openapiclient.NewAzureServerConfigurationUpdate("1001", true, *openapiclient.NewAzureMappings("id", "userPrincipalName", "displayName", "mail", "department", "companyName", "officeLocation", "mobilePhone", "jobTitle", "id", "displayName"), int32(30), false, "userPrincipalName", false)) // AzureConfigurationUpdate | Azure Cloud Identity Provider configuration to update

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.CloudAzureApi.V1CloudAzureIdPut(context.Background(), id).AzureConfigurationUpdate(azureConfigurationUpdate).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `CloudAzureApi.V1CloudAzureIdPut``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `V1CloudAzureIdPut`: AzureConfiguration
    fmt.Fprintf(os.Stdout, "Response from `CloudAzureApi.V1CloudAzureIdPut`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string Cloud Identity Provider identifier

Other Parameters

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

Name Type Description Notes

azureConfigurationUpdate | AzureConfigurationUpdate | Azure Cloud Identity Provider configuration to update |

Return type

AzureConfiguration

Authorization

Bearer

HTTP request headers

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

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

V1CloudAzurePost

HrefResponse V1CloudAzurePost(ctx).AzureConfigurationRequest(azureConfigurationRequest).Execute()

Create Azure Cloud Identity Provider configuration

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    azureConfigurationRequest := *openapiclient.NewAzureConfigurationRequest(*openapiclient.NewCloudIdPCommonRequest("Google Secure LDAP", "GOOGLE"), *openapiclient.NewAzureServerConfigurationRequest("db65d325-0350-4a17-9af9-b302d0fc386b", true, *openapiclient.NewAzureMappings("id", "userPrincipalName", "displayName", "mail", "department", "companyName", "officeLocation", "mobilePhone", "jobTitle", "id", "displayName"), int32(30), false, "userPrincipalName", false, "auth")) // AzureConfigurationRequest | Azure Cloud Identity Provider configuration to create

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

Path Parameters

Other Parameters

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

Name Type Description Notes
azureConfigurationRequest AzureConfigurationRequest Azure Cloud Identity Provider configuration to create

Return type

HrefResponse

Authorization

Bearer

HTTP request headers

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

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