\MembersAPI

All URIs are relative to https://api.qovery.com

Method	HTTP request	Description
DeleteInviteMember	Delete /organization/{organizationId}/inviteMember/{inviteId}	Remove an invited member
DeleteMember	Delete /organization/{organizationId}/member	Remove a member
EditOrganizationMemberRole	Put /organization/{organizationId}/member	Edit an organization member role
GetMemberInvitation	Get /organization/{organizationId}/inviteMember/{inviteId}	Get member invitation
GetOrganizationInvitedMembers	Get /organization/{organizationId}/inviteMember	Get invited members
GetOrganizationMembers	Get /organization/{organizationId}/member	Get organization members
PostAcceptInviteMember	Post /organization/{organizationId}/inviteMember/{inviteId}	Accept Invite in the organization
PostInviteMember	Post /organization/{organizationId}/inviteMember	Invite someone in the organization
PostOrganizationTransferOwnership	Post /organization/{organizationId}/transferOwnership	Transfer organization ownership to another user

DeleteInviteMember

DeleteInviteMember(ctx, organizationId, inviteId).Execute()

Remove an invited member

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/qovery/qovery-client-go"
)

func main() {
	organizationId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Organization ID
	inviteId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Invite ID

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

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
organizationId	string	Organization ID
inviteId	string	Invite ID

Other Parameters

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

Name	Type	Description	Notes

Return type

(empty response body)

Authorization

ApiKeyAuth, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

DeleteMember

DeleteMember(ctx, organizationId).DeleteMemberRequest(deleteMemberRequest).Execute()

Remove a member

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/qovery/qovery-client-go"
)

func main() {
	organizationId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Organization ID
	deleteMemberRequest := *openapiclient.NewDeleteMemberRequest("UserId_example") // DeleteMemberRequest |  (optional)

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

Other Parameters

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

Name	Type	Description	Notes

deleteMemberRequest | DeleteMemberRequest | |

Return type

(empty response body)

Authorization

ApiKeyAuth, bearerAuth

HTTP request headers

Content-Type: application/json
Accept: Not defined

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

EditOrganizationMemberRole

EditOrganizationMemberRole(ctx, organizationId).MemberRoleUpdateRequest(memberRoleUpdateRequest).Execute()

Edit an organization member role

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/qovery/qovery-client-go"
)

func main() {
	organizationId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Organization ID
	memberRoleUpdateRequest := *openapiclient.NewMemberRoleUpdateRequest("UserId_example", "RoleId_example") // MemberRoleUpdateRequest |  (optional)

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

Other Parameters

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

Name	Type	Description	Notes

memberRoleUpdateRequest | MemberRoleUpdateRequest | |

Return type

(empty response body)

Authorization

ApiKeyAuth, bearerAuth

HTTP request headers

Content-Type: application/json
Accept: Not defined

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

GetMemberInvitation

InviteMember GetMemberInvitation(ctx, organizationId, inviteId).Execute()

Get member invitation

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/qovery/qovery-client-go"
)

func main() {
	organizationId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Organization ID
	inviteId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Invite ID

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

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
organizationId	string	Organization ID
inviteId	string	Invite ID

Other Parameters

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

Name	Type	Description	Notes

Return type

InviteMember

Authorization

ApiKeyAuth, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

GetOrganizationInvitedMembers

InviteMemberResponseList GetOrganizationInvitedMembers(ctx, organizationId).Execute()

Get invited members

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/qovery/qovery-client-go"
)

func main() {
	organizationId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Organization ID

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

Path Parameters

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

Other Parameters

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

Name	Type	Description	Notes

Return type

InviteMemberResponseList

Authorization

ApiKeyAuth, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

GetOrganizationMembers

MemberResponseList GetOrganizationMembers(ctx, organizationId).Execute()

Get organization members

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/qovery/qovery-client-go"
)

func main() {
	organizationId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Organization ID

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

Path Parameters

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

Other Parameters

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

Name	Type	Description	Notes

Return type

MemberResponseList

Authorization

ApiKeyAuth, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

PostAcceptInviteMember

InviteMember PostAcceptInviteMember(ctx, organizationId, inviteId).Execute()

Accept Invite in the organization

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/qovery/qovery-client-go"
)

func main() {
	organizationId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Organization ID
	inviteId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Invite ID

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

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
organizationId	string	Organization ID
inviteId	string	Invite ID

Other Parameters

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

Name	Type	Description	Notes

Return type

InviteMember

Authorization

ApiKeyAuth, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

PostInviteMember

InviteMember PostInviteMember(ctx, organizationId).InviteMemberRequest(inviteMemberRequest).Execute()

Invite someone in the organization

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/qovery/qovery-client-go"
)

func main() {
	organizationId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Organization ID
	inviteMemberRequest := *openapiclient.NewInviteMemberRequest("Email_example") // InviteMemberRequest |  (optional)

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

Path Parameters

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

Other Parameters

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

Name	Type	Description	Notes

inviteMemberRequest | InviteMemberRequest | |

Return type

InviteMember

Authorization

ApiKeyAuth, bearerAuth

HTTP request headers

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

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

PostOrganizationTransferOwnership

PostOrganizationTransferOwnership(ctx, organizationId).TransferOwnershipRequest(transferOwnershipRequest).Execute()

Transfer organization ownership to another user

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/qovery/qovery-client-go"
)

func main() {
	organizationId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Organization ID
	transferOwnershipRequest := *openapiclient.NewTransferOwnershipRequest("UserId_example") // TransferOwnershipRequest |  (optional)

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

Other Parameters

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

Name	Type	Description	Notes

transferOwnershipRequest | TransferOwnershipRequest | |

Return type

(empty response body)

Authorization

ApiKeyAuth, bearerAuth

HTTP request headers

Content-Type: application/json
Accept: Not defined

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

Files

MembersAPI.md

Latest commit

History

MembersAPI.md

File metadata and controls

\MembersAPI

DeleteInviteMember

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

DeleteMember

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

EditOrganizationMemberRole

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetMemberInvitation

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetOrganizationInvitedMembers

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetOrganizationMembers

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

PostAcceptInviteMember

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

PostInviteMember

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

PostOrganizationTransferOwnership

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers