\UserConnections

All URIs are relative to https://pipes.turbot.com/api/v0

Method	HTTP request	Description
Create	Post /user/{user_handle}/connection	Create user connection
CreateDeprecated	Post /user/{user_handle}/conn	Create user connection
Delete	Delete /user/{user_handle}/connection/{connection_handle}	Delete user connection
DeleteDeprecated	Delete /user/{user_handle}/conn/{conn_handle}	Delete user connection
Get	Get /user/{user_handle}/connection/{connection_handle}	Get user connection
GetDeprecated	Get /user/{user_handle}/conn/{conn_handle}	Get user connection
List	Get /user/{user_handle}/connection	List user connections
ListDeprecated	Get /user/{user_handle}/conn	List user connections
ListWorkspaces	Get /user/{user_handle}/connection/{connection_handle}/workspace	List user connection workspaces
ListWorkspacesDeprecated	Get /user/{user_handle}/conn/{conn_handle}/workspace	List user connection workspaces
Test	Post /user/{user_handle}/connection/{connection_handle}/test	Test user connection
TestDeprecated	Post /user/{user_handle}/conn/{conn_handle}/test	Test user connection
Update	Patch /user/{user_handle}/connection/{connection_handle}	Update user connection
UpdateDeprecated	Patch /user/{user_handle}/conn/{conn_handle}	Update user connection

Create

Connection Create(ctx, userHandle).Request(request).Mode(mode).Execute()

Create user connection

Example

package main

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

func main() {
    userHandle := "userHandle_example" // string | The handle of the user where we want to create the connection.
    request := *openapiclient.NewCreateConnectionRequest("Handle_example", "Plugin_example") // CreateConnectionRequest | The request body for the connection to be created.
    mode := "mode_example" // string | The mode of this request (optional)

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.UserConnections.Create(context.Background(), userHandle).Request(request).Mode(mode).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `UserConnections.Create``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `Create`: Connection
    fmt.Fprintf(os.Stdout, "Response from `UserConnections.Create`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
userHandle	string	The handle of the user where we want to create the connection.

Other Parameters

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

Name	Type	Description	Notes

Return type

Connection

Authorization

No authorization required

HTTP request headers

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

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

CreateDeprecated

Connection CreateDeprecated(ctx, userHandle).Request(request).Mode(mode).Execute()

Create user connection

Example

package main

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

func main() {
    userHandle := "userHandle_example" // string | The handle of the user where we want to create the connection.
    request := *openapiclient.NewCreateConnectionRequest("Handle_example", "Plugin_example") // CreateConnectionRequest | The request body for the connection to be created.
    mode := "mode_example" // string | The mode of this request (optional)

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.UserConnections.CreateDeprecated(context.Background(), userHandle).Request(request).Mode(mode).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `UserConnections.CreateDeprecated``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `CreateDeprecated`: Connection
    fmt.Fprintf(os.Stdout, "Response from `UserConnections.CreateDeprecated`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
userHandle	string	The handle of the user where we want to create the connection.

Other Parameters

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

Name	Type	Description	Notes

Return type

Connection

Authorization

No authorization required

HTTP request headers

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

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

Delete

Connection Delete(ctx, userHandle, connectionHandle).Execute()

Delete user connection

Example

package main

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

func main() {
    userHandle := "userHandle_example" // string | The handle of the user where the connection exists.
    connectionHandle := "connectionHandle_example" // string | The handle of the connection that needs to be deleted.

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

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
userHandle	string	The handle of the user where the connection exists.
connectionHandle	string	The handle of the connection that needs to be deleted.

Other Parameters

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

Name	Type	Description	Notes

Return type

Connection

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

DeleteDeprecated

Connection DeleteDeprecated(ctx, userHandle, connHandle).Execute()

Delete user connection

Example

package main

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

func main() {
    userHandle := "userHandle_example" // string | The handle of the user where the connection exist.
    connHandle := "connHandle_example" // string | The handle of the connection that needs to be deleted.

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

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
userHandle	string	The handle of the user where the connection exist.
connHandle	string	The handle of the connection that needs to be deleted.

Other Parameters

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

Name	Type	Description	Notes

Return type

Connection

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

Get

Connection Get(ctx, userHandle, connectionHandle).Execute()

Get user connection

Example

package main

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

func main() {
    userHandle := "userHandle_example" // string | The handle for the user where the connection exists.
    connectionHandle := "connectionHandle_example" // string | The handle of the connection whose detail needs to be fetched.

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

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
userHandle	string	The handle for the user where the connection exists.
connectionHandle	string	The handle of the connection whose detail needs to be fetched.

Other Parameters

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

Name	Type	Description	Notes

Return type

Connection

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

GetDeprecated

Connection GetDeprecated(ctx, userHandle, connHandle).Execute()

Get user connection

Example

package main

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

func main() {
    userHandle := "userHandle_example" // string | The handle for the user where the connection exist.
    connHandle := "connHandle_example" // string | The handle of the connection whose detail needs to be fetched.

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

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
userHandle	string	The handle for the user where the connection exist.
connHandle	string	The handle of the connection whose detail needs to be fetched.

Other Parameters

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

Name	Type	Description	Notes

Return type

Connection

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

List

ListConnectionsResponse List(ctx, userHandle).Limit(limit).NextToken(nextToken).Execute()

List user connections

Example

package main

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

func main() {
    userHandle := "userHandle_example" // string | The handle of the user for which we want to list connections.
    limit := int32(56) // int32 | The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25. (optional) (default to 25)
    nextToken := "nextToken_example" // string | When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data. (optional)

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.UserConnections.List(context.Background(), userHandle).Limit(limit).NextToken(nextToken).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `UserConnections.List``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `List`: ListConnectionsResponse
    fmt.Fprintf(os.Stdout, "Response from `UserConnections.List`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
userHandle	string	The handle of the user for which we want to list connections.

Other Parameters

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

Name	Type	Description	Notes

limit | int32 | The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25. | [default to 25] nextToken | string | When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data. |

Return type

ListConnectionsResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

ListDeprecated

ListConnectionsResponse ListDeprecated(ctx, userHandle).Limit(limit).NextToken(nextToken).Execute()

List user connections

Example

package main

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

func main() {
    userHandle := "userHandle_example" // string | The handle of the user for which we want to list connections.
    limit := int32(56) // int32 | The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25. (optional) (default to 25)
    nextToken := "nextToken_example" // string | When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data. (optional)

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.UserConnections.ListDeprecated(context.Background(), userHandle).Limit(limit).NextToken(nextToken).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `UserConnections.ListDeprecated``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ListDeprecated`: ListConnectionsResponse
    fmt.Fprintf(os.Stdout, "Response from `UserConnections.ListDeprecated`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
userHandle	string	The handle of the user for which we want to list connections.

Other Parameters

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

Name	Type	Description	Notes

limit | int32 | The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25. | [default to 25] nextToken | string | When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data. |

Return type

ListConnectionsResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

ListWorkspaces

ListWorkspaceConnectionAssociationsResponse ListWorkspaces(ctx, userHandle, connectionHandle).Limit(limit).NextToken(nextToken).Execute()

List user connection workspaces

Example

package main

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

func main() {
    userHandle := "userHandle_example" // string | The handle of the user where the connection exists.
    connectionHandle := "connectionHandle_example" // string | The handle of the connection for which we want to list workspaces.
    limit := int32(56) // int32 | The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25. (optional) (default to 25)
    nextToken := "nextToken_example" // string | When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data. (optional)

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.UserConnections.ListWorkspaces(context.Background(), userHandle, connectionHandle).Limit(limit).NextToken(nextToken).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `UserConnections.ListWorkspaces``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ListWorkspaces`: ListWorkspaceConnectionAssociationsResponse
    fmt.Fprintf(os.Stdout, "Response from `UserConnections.ListWorkspaces`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
userHandle	string	The handle of the user where the connection exists.
connectionHandle	string	The handle of the connection for which we want to list workspaces.

Other Parameters

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

Name	Type	Description	Notes

limit | int32 | The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25. | [default to 25] nextToken | string | When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data. |

Return type

ListWorkspaceConnectionAssociationsResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

ListWorkspacesDeprecated

ListWorkspaceConnResponse ListWorkspacesDeprecated(ctx, userHandle, connHandle).Limit(limit).NextToken(nextToken).Execute()

List user connection workspaces

Example

package main

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

func main() {
    userHandle := "userHandle_example" // string | The handle of the user where the connection exists.
    connHandle := "connHandle_example" // string | The handle of the connection for which we want to list workspaces.
    limit := int32(56) // int32 | The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25. (optional) (default to 25)
    nextToken := "nextToken_example" // string | When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data. (optional)

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.UserConnections.ListWorkspacesDeprecated(context.Background(), userHandle, connHandle).Limit(limit).NextToken(nextToken).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `UserConnections.ListWorkspacesDeprecated``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ListWorkspacesDeprecated`: ListWorkspaceConnResponse
    fmt.Fprintf(os.Stdout, "Response from `UserConnections.ListWorkspacesDeprecated`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
userHandle	string	The handle of the user where the connection exists.
connHandle	string	The handle of the connection for which we want to list workspaces.

Other Parameters

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

Name	Type	Description	Notes

limit | int32 | The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25. | [default to 25] nextToken | string | When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data. |

Return type

ListWorkspaceConnResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

Test

ConnectionTestResult Test(ctx, userHandle, connectionHandle).Request(request).Execute()

Test user connection

Example

package main

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

func main() {
    userHandle := "userHandle_example" // string | The handle of the user where the connection exists / intends to be created.
    connectionHandle := "connectionHandle_example" // string | The handle of the connection to be tested. For connections that are not yet created, use underscore `_` as the handle, else pass the handle of the existing connection.
    request := *openapiclient.NewTestConnectionRequest("Plugin_example") // TestConnectionRequest | The request body for the connection to be tested.

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

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
userHandle	string	The handle of the user where the connection exists / intends to be created.
connectionHandle	string	The handle of the connection to be tested. For connections that are not yet created, use underscore `_` as the handle, else pass the handle of the existing connection.

Other Parameters

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

Name	Type	Description	Notes

request | TestConnectionRequest | The request body for the connection to be tested. |

Return type

ConnectionTestResult

Authorization

No authorization required

HTTP request headers

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

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

TestDeprecated

ConnectionTestResult TestDeprecated(ctx, userHandle, connHandle).Request(request).Execute()

Test user connection

Example

package main

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

func main() {
    userHandle := "userHandle_example" // string | The handle of the user where the connection exists / intends to be created.
    connHandle := "connHandle_example" // string | The handle of the connection to be tested. For connections that are not yet created, use underscore `_` as the handle, else pass the handle of the existing connection.
    request := *openapiclient.NewTestConnectionRequest("Plugin_example") // TestConnectionRequest | The request body for the connection to be tested.

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

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
userHandle	string	The handle of the user where the connection exists / intends to be created.
connHandle	string	The handle of the connection to be tested. For connections that are not yet created, use underscore `_` as the handle, else pass the handle of the existing connection.

Other Parameters

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

Name	Type	Description	Notes

request | TestConnectionRequest | The request body for the connection to be tested. |

Return type

ConnectionTestResult

Authorization

No authorization required

HTTP request headers

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

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

Update

Connection Update(ctx, userHandle, connectionHandle).Request(request).Mode(mode).Execute()

Update user connection

Example

package main

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

func main() {
    userHandle := "userHandle_example" // string | The handle of the user where the connection exists.
    connectionHandle := "connectionHandle_example" // string | The handle of the connection which needs to be updated.
    request := *openapiclient.NewUpdateConnectionRequest() // UpdateConnectionRequest | The request body for the connection which needs to be updated.
    mode := "mode_example" // string | The mode of this request (optional)

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.UserConnections.Update(context.Background(), userHandle, connectionHandle).Request(request).Mode(mode).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `UserConnections.Update``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `Update`: Connection
    fmt.Fprintf(os.Stdout, "Response from `UserConnections.Update`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
userHandle	string	The handle of the user where the connection exists.
connectionHandle	string	The handle of the connection which needs to be updated.

Other Parameters

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

Name	Type	Description	Notes

Return type

Connection

Authorization

No authorization required

HTTP request headers

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

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

UpdateDeprecated

Connection UpdateDeprecated(ctx, userHandle, connHandle).Request(request).Mode(mode).Execute()

Update user connection

Example

package main

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

func main() {
    userHandle := "userHandle_example" // string | The handle of the user where the connection exist.
    connHandle := "connHandle_example" // string | The handle of the connection which needs to be updated.
    request := *openapiclient.NewUpdateConnectionRequest() // UpdateConnectionRequest | The request body for the connection which needs to be updated.
    mode := "mode_example" // string | The mode of this request (optional)

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.UserConnections.UpdateDeprecated(context.Background(), userHandle, connHandle).Request(request).Mode(mode).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `UserConnections.UpdateDeprecated``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `UpdateDeprecated`: Connection
    fmt.Fprintf(os.Stdout, "Response from `UserConnections.UpdateDeprecated`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
userHandle	string	The handle of the user where the connection exist.
connHandle	string	The handle of the connection which needs to be updated.

Other Parameters

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

Name	Type	Description	Notes

Return type

Connection

Authorization

No authorization required

HTTP request headers

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

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

Files

UserConnections.md

Latest commit

History

UserConnections.md

File metadata and controls

\UserConnections

Create

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

CreateDeprecated

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

Delete

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

DeleteDeprecated

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

Get

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetDeprecated

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

List

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ListDeprecated

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ListWorkspaces

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ListWorkspacesDeprecated

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

Test

Example

Path Parameters