Skip to content

Latest commit

 

History

History
453 lines (282 loc) · 11.2 KB

AccountManagementApi.md

File metadata and controls

453 lines (282 loc) · 11.2 KB
Raw

\AccountManagementApi

All URIs are relative to https://api.au.sumologic.com/api

Method HTTP request Description
CreateSubdomain Post /v1/account/subdomain Create account subdomain.
DeleteSubdomain Delete /v1/account/subdomain Delete the configured subdomain.
GetAccountOwner Get /v1/account/accountOwner Get the owner of an account.
GetStatus Get /v1/account/status Get overview of the account status.
GetSubdomain Get /v1/account/subdomain Get the configured subdomain.
RecoverSubdomains Post /v1/account/subdomain/recover Recover subdomains for a user.
UpdateSubdomain Put /v1/account/subdomain Update account subdomain.

CreateSubdomain

SubdomainDefinitionResponse CreateSubdomain(ctx).ConfigureSubdomainRequest(configureSubdomainRequest).Execute()

Create account subdomain.

Example

package main

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

func main() {
    configureSubdomainRequest := *openapiclient.NewConfigureSubdomainRequest("my-company") // ConfigureSubdomainRequest | The new subdomain.

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

Path Parameters

Other Parameters

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

Name Type Description Notes
configureSubdomainRequest ConfigureSubdomainRequest The new subdomain.

Return type

SubdomainDefinitionResponse

Authorization

basicAuth

HTTP request headers

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

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

DeleteSubdomain

DeleteSubdomain(ctx).Execute()

Delete the configured subdomain.

Example

package main

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

func main() {

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

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

(empty response body)

Authorization

basicAuth

HTTP request headers

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

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

GetAccountOwner

string GetAccountOwner(ctx).Execute()

Get the owner of an account.

Example

package main

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

func main() {

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

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

string

Authorization

basicAuth

HTTP request headers

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

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

GetStatus

AccountStatusResponse GetStatus(ctx).Execute()

Get overview of the account status.

Example

package main

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

func main() {

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

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

AccountStatusResponse

Authorization

basicAuth

HTTP request headers

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

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

GetSubdomain

SubdomainDefinitionResponse GetSubdomain(ctx).Execute()

Get the configured subdomain.

Example

package main

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

func main() {

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

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

SubdomainDefinitionResponse

Authorization

basicAuth

HTTP request headers

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

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

RecoverSubdomains

RecoverSubdomains(ctx).Email(email).Execute()

Recover subdomains for a user.

Example

package main

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

func main() {
    email := "email_example" // string | Email address of the user to get subdomain information.

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

Path Parameters

Other Parameters

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

Name Type Description Notes
email string Email address of the user to get subdomain information.

Return type

(empty response body)

Authorization

basicAuth

HTTP request headers

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

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

UpdateSubdomain

SubdomainDefinitionResponse UpdateSubdomain(ctx).ConfigureSubdomainRequest(configureSubdomainRequest).Execute()

Update account subdomain.

Example

package main

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

func main() {
    configureSubdomainRequest := *openapiclient.NewConfigureSubdomainRequest("my-company") // ConfigureSubdomainRequest | The new subdomain.

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

Path Parameters

Other Parameters

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

Name Type Description Notes
configureSubdomainRequest ConfigureSubdomainRequest The new subdomain.

Return type

SubdomainDefinitionResponse

Authorization

basicAuth

HTTP request headers

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

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