stack/components/fctl/membershipclient/docs/DefaultApi.md

\DefaultApi

All URIs are relative to http://localhost:8080

Method	HTTP request	Description
AcceptInvitation	Post /me/invitations/{invitationId}/accept	Accept invitation
CreateInvitation	Post /organizations/{organizationId}/invitations	Create invitation
CreateOrganization	Post /organizations	Create organization
CreatePrivateRegion	Post /organizations/{organizationId}/regions	Create a private region
CreateStack	Post /organizations/{organizationId}/stacks	Create stack
DeclineInvitation	Post /me/invitations/{invitationId}/reject	Decline invitation
DeleteInvitation	Delete /organizations/{organizationId}/invitations/{invitationId}	Delete invitation
DeleteOrganization	Delete /organizations/{organizationId}	Delete organization
DeleteRegion	Delete /organizations/{organizationId}/regions/{regionId}	Delete region
DeleteStack	Delete /organizations/{organizationId}/stacks/{stackId}	Delete stack
DeleteStackUserAccess	Delete /organizations/{organizationId}/stacks/{stackId}/users/{userId}	Delete stack user access role within an organization
DeleteUserFromOrganization	Delete /organizations/{organizationId}/users/{userId}	delete user from organization
DisableModule	Delete /organizations/{organizationId}/stacks/{stackId}/modules	disable module
DisableStack	Put /organizations/{organizationId}/stacks/{stackId}/disable	Disable stack
DisableStargate	Put /organizations/{organizationId}/stacks/{stackId}/stargate/disable	Disable stargate on a stack
EnableModule	Post /organizations/{organizationId}/stacks/{stackId}/modules	enable module
EnableStack	Put /organizations/{organizationId}/stacks/{stackId}/enable	Enable stack
EnableStargate	Put /organizations/{organizationId}/stacks/{stackId}/stargate/enable	Enable stargate on a stack
GetRegion	Get /organizations/{organizationId}/regions/{regionId}	Get region
GetRegionVersions	Get /organizations/{organizationId}/regions/{regionId}/versions	Get region versions
GetServerInfo	Get /_info	Get server info
GetStack	Get /organizations/{organizationId}/stacks/{stackId}	Find stack
ListInvitations	Get /me/invitations	List invitations of the user
ListLogs	Get /organizations/{organizationId}/logs	List logs
ListModules	Get /organizations/{organizationId}/stacks/{stackId}/modules	List modules of a stack
ListOrganizationInvitations	Get /organizations/{organizationId}/invitations	List invitations of the organization
ListOrganizations	Get /organizations	List organizations of the connected user
ListOrganizationsExpanded	Get /organizations/expanded	List organizations of the connected user with expanded data
ListRegions	Get /organizations/{organizationId}/regions	List regions
ListStackUsersAccesses	Get /organizations/{organizationId}/stacks/{stackId}/users	List stack users accesses within an organization
ListStacks	Get /organizations/{organizationId}/stacks	List stacks
ListUsersOfOrganization	Get /organizations/{organizationId}/users	List users of organization
ReadConnectedUser	Get /me	Read user
ReadOrganization	Get /organizations/{organizationId}	Read organization
ReadStackUserAccess	Get /organizations/{organizationId}/stacks/{stackId}/users/{userId}	Read stack user access role within an organization
ReadUserOfOrganization	Get /organizations/{organizationId}/users/{userId}	Read user of organization
RestoreStack	Put /organizations/{organizationId}/stacks/{stackId}/restore	Restore stack
UpdateOrganization	Put /organizations/{organizationId}	Update organization
UpdateStack	Put /organizations/{organizationId}/stacks/{stackId}	Update stack
UpgradeStack	Put /organizations/{organizationId}/stacks/{stackId}/upgrade	Upgrade stack
UpsertOrganizationUser	Put /organizations/{organizationId}/users/{userId}	Update user within an organization
UpsertStackUserAccess	Put /organizations/{organizationId}/stacks/{stackId}/users/{userId}	Update stack user access role within an organization

AcceptInvitation

AcceptInvitation(ctx, invitationId).Execute()

Accept invitation

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/formancehq/fctl/membershipclient"
)

func main() {
    invitationId := "invitationId_example" // string | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.DefaultApi.AcceptInvitation(context.Background(), invitationId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `DefaultApi.AcceptInvitation``: %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.
invitationId	string

Other Parameters

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

Name	Type	Description	Notes

Return type

(empty response body)

Authorization

oauth2

HTTP request headers

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

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

CreateInvitation

CreateInvitationResponse CreateInvitation(ctx, organizationId).Email(email).InvitationClaim(invitationClaim).Execute()

Create invitation

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/formancehq/fctl/membershipclient"
)

func main() {
    organizationId := "organizationId_example" // string | 
    email := "email_example" // string | 
    invitationClaim := *openapiclient.NewInvitationClaim([]openapiclient.StackClaim{*openapiclient.NewStackClaim("Id_example", openapiclient.Role(""))}) // InvitationClaim |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.DefaultApi.CreateInvitation(context.Background(), organizationId).Email(email).InvitationClaim(invitationClaim).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `DefaultApi.CreateInvitation``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `CreateInvitation`: CreateInvitationResponse
    fmt.Fprintf(os.Stdout, "Response from `DefaultApi.CreateInvitation`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
organizationId	string

Other Parameters

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

Name	Type	Description	Notes

email | string | | invitationClaim | InvitationClaim | |

Return type

CreateInvitationResponse

Authorization

oauth2

HTTP request headers

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

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

CreateOrganization

CreateOrganizationResponse CreateOrganization(ctx).Body(body).Execute()

Create organization

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/formancehq/fctl/membershipclient"
)

func main() {
    body := OrganizationData(987) // OrganizationData |  (optional)

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

Path Parameters

Other Parameters

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

Name	Type	Description	Notes
body	OrganizationData

Return type

CreateOrganizationResponse

Authorization

oauth2

HTTP request headers

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

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

CreatePrivateRegion

CreatedPrivateRegionResponse CreatePrivateRegion(ctx, organizationId).CreatePrivateRegionRequest(createPrivateRegionRequest).Execute()

Create a private region

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/formancehq/fctl/membershipclient"
)

func main() {
    organizationId := "organizationId_example" // string | 
    createPrivateRegionRequest := *openapiclient.NewCreatePrivateRegionRequest("Name_example") // CreatePrivateRegionRequest |  (optional)

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

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
organizationId	string

Other Parameters

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

Name	Type	Description	Notes

createPrivateRegionRequest | CreatePrivateRegionRequest | |

Return type

CreatedPrivateRegionResponse

Authorization

oauth2

HTTP request headers

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

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

CreateStack

CreateStackResponse CreateStack(ctx, organizationId).CreateStackRequest(createStackRequest).Execute()

Create stack

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/formancehq/fctl/membershipclient"
)

func main() {
    organizationId := "organizationId_example" // string | 
    createStackRequest := *openapiclient.NewCreateStackRequest("Name_example", "RegionID_example") // CreateStackRequest |  (optional)

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

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
organizationId	string

Other Parameters

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

Name	Type	Description	Notes

createStackRequest | CreateStackRequest | |

Return type

CreateStackResponse

Authorization

oauth2

HTTP request headers

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

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

DeclineInvitation

DeclineInvitation(ctx, invitationId).Execute()

Decline invitation

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/formancehq/fctl/membershipclient"
)

func main() {
    invitationId := "invitationId_example" // string | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.DefaultApi.DeclineInvitation(context.Background(), invitationId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `DefaultApi.DeclineInvitation``: %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.
invitationId	string

Other Parameters

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

Name	Type	Description	Notes

Return type

(empty response body)

Authorization

oauth2

HTTP request headers

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

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

DeleteInvitation

DeleteInvitation(ctx, organizationId, invitationId).Execute()

Delete invitation

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/formancehq/fctl/membershipclient"
)

func main() {
    organizationId := "organizationId_example" // string | 
    invitationId := "invitationId_example" // string | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.DefaultApi.DeleteInvitation(context.Background(), organizationId, invitationId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `DefaultApi.DeleteInvitation``: %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.
organizationId	string
invitationId	string

Other Parameters

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

Name	Type	Description	Notes

Return type

(empty response body)

Authorization

oauth2

HTTP request headers

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

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

DeleteOrganization

DeleteOrganization(ctx, organizationId).Execute()

Delete organization

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/formancehq/fctl/membershipclient"
)

func main() {
    organizationId := "organizationId_example" // string | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.DefaultApi.DeleteOrganization(context.Background(), organizationId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `DefaultApi.DeleteOrganization``: %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.
organizationId	string

Other Parameters

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

Name	Type	Description	Notes

Return type

(empty response body)

Authorization

oauth2

HTTP request headers

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

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

DeleteRegion

DeleteRegion(ctx, organizationId, regionId).Execute()

Delete region

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/formancehq/fctl/membershipclient"
)

func main() {
    organizationId := "organizationId_example" // string | 
    regionId := "regionId_example" // string | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.DefaultApi.DeleteRegion(context.Background(), organizationId, regionId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `DefaultApi.DeleteRegion``: %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.
organizationId	string
regionId	string

Other Parameters

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

Name	Type	Description	Notes

Return type

(empty response body)

Authorization

oauth2

HTTP request headers

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

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

DeleteStack

DeleteStack(ctx, organizationId, stackId).Force(force).Execute()

Delete stack

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/formancehq/fctl/membershipclient"
)

func main() {
    organizationId := "organizationId_example" // string | 
    stackId := "stackId_example" // string | 
    force := true // bool |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.DefaultApi.DeleteStack(context.Background(), organizationId, stackId).Force(force).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `DefaultApi.DeleteStack``: %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.
organizationId	string
stackId	string

Other Parameters

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

Name	Type	Description	Notes

force | bool | |

Return type

(empty response body)

Authorization

oauth2

HTTP request headers

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

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

DeleteStackUserAccess

DeleteStackUserAccess(ctx, organizationId, stackId, userId).Execute()

Delete stack user access role within an organization

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/formancehq/fctl/membershipclient"
)

func main() {
    organizationId := "organizationId_example" // string | 
    stackId := "stackId_example" // string | 
    userId := "userId_example" // string | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.DefaultApi.DeleteStackUserAccess(context.Background(), organizationId, stackId, userId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `DefaultApi.DeleteStackUserAccess``: %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.
organizationId	string
stackId	string
userId	string

Other Parameters

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

Name	Type	Description	Notes

Return type

(empty response body)

Authorization

oauth2

HTTP request headers

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

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

DeleteUserFromOrganization

DeleteUserFromOrganization(ctx, organizationId, userId).Execute()

delete user from organization

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/formancehq/fctl/membershipclient"
)

func main() {
    organizationId := "organizationId_example" // string | 
    userId := "userId_example" // string | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.DefaultApi.DeleteUserFromOrganization(context.Background(), organizationId, userId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `DefaultApi.DeleteUserFromOrganization``: %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.
organizationId	string
userId	string

Other Parameters

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

Name	Type	Description	Notes

Return type

(empty response body)

Authorization

oauth2

HTTP request headers

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

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

DisableModule

DisableModule(ctx, organizationId, stackId).Name(name).Execute()

disable module

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/formancehq/fctl/membershipclient"
)

func main() {
    organizationId := "organizationId_example" // string | 
    stackId := "stackId_example" // string | 
    name := "name_example" // string | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.DefaultApi.DisableModule(context.Background(), organizationId, stackId).Name(name).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `DefaultApi.DisableModule``: %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.
organizationId	string
stackId	string

Other Parameters

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

Name	Type	Description	Notes

name | string | |

Return type

(empty response body)

Authorization

oauth2

HTTP request headers

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

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

DisableStack

DisableStack(ctx, organizationId, stackId).Execute()

Disable stack

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/formancehq/fctl/membershipclient"
)

func main() {
    organizationId := "organizationId_example" // string | 
    stackId := "stackId_example" // string | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.DefaultApi.DisableStack(context.Background(), organizationId, stackId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `DefaultApi.DisableStack``: %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.
organizationId	string
stackId	string

Other Parameters

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

Name	Type	Description	Notes

Return type

(empty response body)

Authorization

oauth2

HTTP request headers

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

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

DisableStargate

DisableStargate(ctx, organizationId, stackId).Execute()

Disable stargate on a stack

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/formancehq/fctl/membershipclient"
)

func main() {
    organizationId := "organizationId_example" // string | 
    stackId := "stackId_example" // string | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.DefaultApi.DisableStargate(context.Background(), organizationId, stackId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `DefaultApi.DisableStargate``: %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.
organizationId	string
stackId	string

Other Parameters

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

Name	Type	Description	Notes

Return type

(empty response body)

Authorization

oauth2

HTTP request headers

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

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

EnableModule

EnableModule(ctx, organizationId, stackId).Name(name).Execute()

enable module

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/formancehq/fctl/membershipclient"
)

func main() {
    organizationId := "organizationId_example" // string | 
    stackId := "stackId_example" // string | 
    name := "name_example" // string | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.DefaultApi.EnableModule(context.Background(), organizationId, stackId).Name(name).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `DefaultApi.EnableModule``: %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.
organizationId	string
stackId	string

Other Parameters

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

Name	Type	Description	Notes

name | string | |

Return type

(empty response body)

Authorization

oauth2

HTTP request headers

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

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

EnableStack

EnableStack(ctx, organizationId, stackId).Execute()

Enable stack

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/formancehq/fctl/membershipclient"
)

func main() {
    organizationId := "organizationId_example" // string | 
    stackId := "stackId_example" // string | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.DefaultApi.EnableStack(context.Background(), organizationId, stackId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `DefaultApi.EnableStack``: %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.
organizationId	string
stackId	string

Other Parameters

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

Name	Type	Description	Notes

Return type

(empty response body)

Authorization

oauth2

HTTP request headers

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

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

EnableStargate

EnableStargate(ctx, organizationId, stackId).Execute()

Enable stargate on a stack

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/formancehq/fctl/membershipclient"
)

func main() {
    organizationId := "organizationId_example" // string | 
    stackId := "stackId_example" // string | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.DefaultApi.EnableStargate(context.Background(), organizationId, stackId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `DefaultApi.EnableStargate``: %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.
organizationId	string
stackId	string

Other Parameters

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

Name	Type	Description	Notes

Return type

(empty response body)

Authorization

oauth2

HTTP request headers

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

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

GetRegion

GetRegionResponse GetRegion(ctx, organizationId, regionId).Execute()

Get region

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/formancehq/fctl/membershipclient"
)

func main() {
    organizationId := "organizationId_example" // string | 
    regionId := "regionId_example" // string | 

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

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
organizationId	string
regionId	string

Other Parameters

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

Name	Type	Description	Notes

Return type

GetRegionResponse

Authorization

oauth2

HTTP request headers

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

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

GetRegionVersions

GetRegionVersionsResponse GetRegionVersions(ctx, organizationId, regionId).Execute()

Get region versions

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/formancehq/fctl/membershipclient"
)

func main() {
    organizationId := "organizationId_example" // string | 
    regionId := "regionId_example" // string | 

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

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
organizationId	string
regionId	string

Other Parameters

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

Name	Type	Description	Notes

Return type

GetRegionVersionsResponse

Authorization

oauth2

HTTP request headers

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

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

GetServerInfo

ServerInfo GetServerInfo(ctx).Execute()

Get server info

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/formancehq/fctl/membershipclient"
)

func main() {

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

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

ServerInfo

Authorization

oauth2

HTTP request headers

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

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

GetStack

CreateStackResponse GetStack(ctx, organizationId, stackId).Execute()

Find stack

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/formancehq/fctl/membershipclient"
)

func main() {
    organizationId := "organizationId_example" // string | 
    stackId := "stackId_example" // string | 

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

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
organizationId	string
stackId	string

Other Parameters

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

Name	Type	Description	Notes

Return type

CreateStackResponse

Authorization

oauth2

HTTP request headers

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

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

ListInvitations

ListInvitationsResponse ListInvitations(ctx).Status(status).Organization(organization).Execute()

List invitations of the user

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/formancehq/fctl/membershipclient"
)

func main() {
    status := "status_example" // string | Status of organizations (optional)
    organization := "organization_example" // string | Status of organizations (optional)

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

Path Parameters

Other Parameters

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

Name	Type	Description	Notes
status	string	Status of organizations
organization	string	Status of organizations

Return type

ListInvitationsResponse

Authorization

oauth2

HTTP request headers

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

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

ListLogs

LogCursor ListLogs(ctx, organizationId).StackId(stackId).Cursor(cursor).PageSize(pageSize).Action(action).UserId(userId).Key(key).Value(value).Execute()

List logs

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/formancehq/fctl/membershipclient"
)

func main() {
    organizationId := "organizationId_example" // string | 
    stackId := "stackId_example" // string |  (optional)
    cursor := "cursor_example" // string |  (optional)
    pageSize := int32(56) // int32 |  (optional)
    action := openapiclient.Action("agents.connected") // Action |  (optional)
    userId := "userId_example" // string |  (optional)
    key := "key_example" // string |  (optional)
    value := "value_example" // string |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.DefaultApi.ListLogs(context.Background(), organizationId).StackId(stackId).Cursor(cursor).PageSize(pageSize).Action(action).UserId(userId).Key(key).Value(value).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `DefaultApi.ListLogs``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ListLogs`: LogCursor
    fmt.Fprintf(os.Stdout, "Response from `DefaultApi.ListLogs`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
organizationId	string

Other Parameters

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

Name	Type	Description	Notes

stackId | string | | cursor | string | | pageSize | int32 | | action | Action | | userId | string | | key | string | | value | string | |

Return type

LogCursor

Authorization

oauth2

HTTP request headers

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

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

ListModules

ListModulesResponse ListModules(ctx, organizationId, stackId).Execute()

List modules of a stack

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/formancehq/fctl/membershipclient"
)

func main() {
    organizationId := "organizationId_example" // string | 
    stackId := "stackId_example" // string | 

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

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
organizationId	string
stackId	string

Other Parameters

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

Name	Type	Description	Notes

Return type

ListModulesResponse

Authorization

oauth2

HTTP request headers

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

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

ListOrganizationInvitations

ListInvitationsResponse ListOrganizationInvitations(ctx, organizationId).Status(status).Execute()

List invitations of the organization

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/formancehq/fctl/membershipclient"
)

func main() {
    organizationId := "organizationId_example" // string | 
    status := "status_example" // string | Status of organizations (optional)

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

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
organizationId	string

Other Parameters

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

Name	Type	Description	Notes

status | string | Status of organizations |

Return type

ListInvitationsResponse

Authorization

oauth2

HTTP request headers

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

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

ListOrganizations

ListOrganizationExpandedResponse ListOrganizations(ctx).Expand(expand).Execute()

List organizations of the connected user

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/formancehq/fctl/membershipclient"
)

func main() {
    expand := TODO // bool |  (optional)

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

Path Parameters

Other Parameters

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

Name	Type	Description	Notes
expand	bool

Return type

ListOrganizationExpandedResponse

Authorization

oauth2

HTTP request headers

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

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

ListOrganizationsExpanded

ListOrganizationExpandedResponse ListOrganizationsExpanded(ctx).Execute()

List organizations of the connected user with expanded data

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/formancehq/fctl/membershipclient"
)

func main() {

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

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

ListOrganizationExpandedResponse

Authorization

oauth2

HTTP request headers

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

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

ListRegions

ListRegionsResponse ListRegions(ctx, organizationId).Execute()

List regions

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/formancehq/fctl/membershipclient"
)

func main() {
    organizationId := "organizationId_example" // string | 

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

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
organizationId	string

Other Parameters

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

Name	Type	Description	Notes

Return type

ListRegionsResponse

Authorization

oauth2

HTTP request headers

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

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

ListStackUsersAccesses

StackUserAccessResponse ListStackUsersAccesses(ctx, organizationId, stackId).Execute()

List stack users accesses within an organization

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/formancehq/fctl/membershipclient"
)

func main() {
    organizationId := "organizationId_example" // string | 
    stackId := "stackId_example" // string | 

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

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
organizationId	string
stackId	string

Other Parameters

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

Name	Type	Description	Notes

Return type

StackUserAccessResponse

Authorization

oauth2

HTTP request headers

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

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

ListStacks

ListStacksResponse ListStacks(ctx, organizationId).All(all).Deleted(deleted).Execute()

List stacks

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/formancehq/fctl/membershipclient"
)

func main() {
    organizationId := "organizationId_example" // string | 
    all := true // bool | Include deleted and disabled stacks (optional)
    deleted := true // bool | Include deleted stacks (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.DefaultApi.ListStacks(context.Background(), organizationId).All(all).Deleted(deleted).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `DefaultApi.ListStacks``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ListStacks`: ListStacksResponse
    fmt.Fprintf(os.Stdout, "Response from `DefaultApi.ListStacks`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
organizationId	string

Other Parameters

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

Name	Type	Description	Notes

all | bool | Include deleted and disabled stacks | deleted | bool | Include deleted stacks |

Return type

ListStacksResponse

Authorization

oauth2

HTTP request headers

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

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

ListUsersOfOrganization

ListUsersResponse ListUsersOfOrganization(ctx, organizationId).Execute()

List users of organization

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/formancehq/fctl/membershipclient"
)

func main() {
    organizationId := "organizationId_example" // string | 

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

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
organizationId	string

Other Parameters

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

Name	Type	Description	Notes

Return type

ListUsersResponse

Authorization

oauth2

HTTP request headers

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

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

ReadConnectedUser

ReadUserResponse ReadConnectedUser(ctx).Execute()

Read user

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/formancehq/fctl/membershipclient"
)

func main() {

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

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

ReadUserResponse

Authorization

oauth2

HTTP request headers

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

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

ReadOrganization

ReadOrganizationResponse ReadOrganization(ctx, organizationId).Expand(expand).Execute()

Read organization

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/formancehq/fctl/membershipclient"
)

func main() {
    organizationId := "organizationId_example" // string | 
    expand := TODO // bool |  (optional)

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

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
organizationId	string

Other Parameters

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

Name	Type	Description	Notes

expand | bool | |

Return type

ReadOrganizationResponse

Authorization

oauth2

HTTP request headers

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

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

ReadStackUserAccess

ReadStackUserAccess ReadStackUserAccess(ctx, organizationId, stackId, userId).Execute()

Read stack user access role within an organization

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/formancehq/fctl/membershipclient"
)

func main() {
    organizationId := "organizationId_example" // string | 
    stackId := "stackId_example" // string | 
    userId := "userId_example" // string | 

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

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
organizationId	string
stackId	string
userId	string

Other Parameters

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

Name	Type	Description	Notes

Return type

ReadStackUserAccess

Authorization

oauth2

HTTP request headers

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

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

ReadUserOfOrganization

ReadOrganizationUserResponse ReadUserOfOrganization(ctx, organizationId, userId).Execute()

Read user of organization

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/formancehq/fctl/membershipclient"
)

func main() {
    organizationId := "organizationId_example" // string | 
    userId := "userId_example" // string | 

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

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
organizationId	string
userId	string

Other Parameters

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

Name	Type	Description	Notes

Return type

ReadOrganizationUserResponse

Authorization

oauth2

HTTP request headers

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

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

RestoreStack

CreateStackResponse RestoreStack(ctx, organizationId, stackId).Execute()

Restore stack

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/formancehq/fctl/membershipclient"
)

func main() {
    organizationId := "organizationId_example" // string | 
    stackId := "stackId_example" // string | 

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

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
organizationId	string
stackId	string

Other Parameters

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

Name	Type	Description	Notes

Return type

CreateStackResponse

Authorization

oauth2

HTTP request headers

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

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

UpdateOrganization

ReadOrganizationResponse UpdateOrganization(ctx, organizationId).OrganizationData(organizationData).Execute()

Update organization

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/formancehq/fctl/membershipclient"
)

func main() {
    organizationId := "organizationId_example" // string | 
    organizationData := *openapiclient.NewOrganizationData("Name_example") // OrganizationData |  (optional)

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

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
organizationId	string

Other Parameters

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

Name	Type	Description	Notes

organizationData | OrganizationData | |

Return type

ReadOrganizationResponse

Authorization

oauth2

HTTP request headers

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

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

UpdateStack

CreateStackResponse UpdateStack(ctx, organizationId, stackId).UpdateStackRequest(updateStackRequest).Execute()

Update stack

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/formancehq/fctl/membershipclient"
)

func main() {
    organizationId := "organizationId_example" // string | 
    stackId := "stackId_example" // string | 
    updateStackRequest := *openapiclient.NewUpdateStackRequest("Name_example") // UpdateStackRequest |  (optional)

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

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
organizationId	string
stackId	string

Other Parameters

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

Name	Type	Description	Notes

updateStackRequest | UpdateStackRequest | |

Return type

CreateStackResponse

Authorization

oauth2

HTTP request headers

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

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

UpgradeStack

UpgradeStack(ctx, organizationId, stackId).StackVersion(stackVersion).Execute()

Upgrade stack

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/formancehq/fctl/membershipclient"
)

func main() {
    organizationId := "organizationId_example" // string | 
    stackId := "stackId_example" // string | 
    stackVersion := *openapiclient.NewStackVersion() // StackVersion |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.DefaultApi.UpgradeStack(context.Background(), organizationId, stackId).StackVersion(stackVersion).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `DefaultApi.UpgradeStack``: %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.
organizationId	string
stackId	string

Other Parameters

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

Name	Type	Description	Notes

stackVersion | StackVersion | |

Return type

(empty response body)

Authorization

oauth2

HTTP request headers

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

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

UpsertOrganizationUser

UpsertOrganizationUser(ctx, organizationId, userId).UpdateOrganizationUserRequest(updateOrganizationUserRequest).Execute()

Update user within an organization

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/formancehq/fctl/membershipclient"
)

func main() {
    organizationId := "organizationId_example" // string | 
    userId := "userId_example" // string | 
    updateOrganizationUserRequest := *openapiclient.NewUpdateOrganizationUserRequest(openapiclient.Role("")) // UpdateOrganizationUserRequest |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.DefaultApi.UpsertOrganizationUser(context.Background(), organizationId, userId).UpdateOrganizationUserRequest(updateOrganizationUserRequest).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `DefaultApi.UpsertOrganizationUser``: %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.
organizationId	string
userId	string

Other Parameters

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

Name	Type	Description	Notes

updateOrganizationUserRequest | UpdateOrganizationUserRequest | |

Return type

(empty response body)

Authorization

oauth2

HTTP request headers

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

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

UpsertStackUserAccess

UpsertStackUserAccess(ctx, organizationId, stackId, userId).UpdateStackUserRequest(updateStackUserRequest).Execute()

Update stack user access role within an organization

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/formancehq/fctl/membershipclient"
)

func main() {
    organizationId := "organizationId_example" // string | 
    stackId := "stackId_example" // string | 
    userId := "userId_example" // string | 
    updateStackUserRequest := *openapiclient.NewUpdateStackUserRequest(openapiclient.Role("")) // UpdateStackUserRequest |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.DefaultApi.UpsertStackUserAccess(context.Background(), organizationId, stackId, userId).UpdateStackUserRequest(updateStackUserRequest).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `DefaultApi.UpsertStackUserAccess``: %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.
organizationId	string
stackId	string
userId	string

Other Parameters

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

Name	Type	Description	Notes

updateStackUserRequest | UpdateStackUserRequest | |

Return type

(empty response body)

Authorization

oauth2

HTTP request headers

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

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