Skip to content

OrganizationApiTokenAPI.md

Latest commit

 

History

History
228 lines (145 loc) · 7.19 KB

OrganizationApiTokenAPI.md

File metadata and controls

228 lines (145 loc) · 7.19 KB
Raw

\OrganizationApiTokenAPI

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

Method HTTP request Description
CreateOrganizationApiToken Post /organization/{organizationId}/apiToken Create an organization api token
DeleteOrganizationApiToken Delete /organization/{organizationId}/apiToken/{apiTokenId} Delete organization api token
ListOrganizationApiTokens Get /organization/{organizationId}/apiToken List organization api tokens

CreateOrganizationApiToken

OrganizationApiTokenCreate CreateOrganizationApiToken(ctx, organizationId).OrganizationApiTokenCreateRequest(organizationApiTokenCreateRequest).Execute()

Create an organization api token

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
	organizationApiTokenCreateRequest := *openapiclient.NewOrganizationApiTokenCreateRequest("Name_example", "RoleId_example") // OrganizationApiTokenCreateRequest |  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.OrganizationApiTokenAPI.CreateOrganizationApiToken(context.Background(), organizationId).OrganizationApiTokenCreateRequest(organizationApiTokenCreateRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `OrganizationApiTokenAPI.CreateOrganizationApiToken``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `CreateOrganizationApiToken`: OrganizationApiTokenCreate
	fmt.Fprintf(os.Stdout, "Response from `OrganizationApiTokenAPI.CreateOrganizationApiToken`: %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 apiCreateOrganizationApiTokenRequest struct via the builder pattern

Name Type Description Notes

organizationApiTokenCreateRequest | OrganizationApiTokenCreateRequest | |

Return type

OrganizationApiTokenCreate

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]

DeleteOrganizationApiToken

DeleteOrganizationApiToken(ctx, organizationId, apiTokenId).Execute()

Delete organization api token

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
	apiTokenId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Organization Api Token ID

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

Other Parameters

Other parameters are passed through a pointer to a apiDeleteOrganizationApiTokenRequest 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]

ListOrganizationApiTokens

OrganizationApiTokenResponseList ListOrganizationApiTokens(ctx, organizationId).Name(name).CreatorName(creatorName).Execute()

List organization api tokens

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
	name := "name_example" // string | Name of the token to filter results by. (optional)
	creatorName := "creatorName_example" // string | Name of the token creator to filter results by. (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.OrganizationApiTokenAPI.ListOrganizationApiTokens(context.Background(), organizationId).Name(name).CreatorName(creatorName).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `OrganizationApiTokenAPI.ListOrganizationApiTokens``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ListOrganizationApiTokens`: OrganizationApiTokenResponseList
	fmt.Fprintf(os.Stdout, "Response from `OrganizationApiTokenAPI.ListOrganizationApiTokens`: %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 apiListOrganizationApiTokensRequest struct via the builder pattern

Name Type Description Notes

name | string | Name of the token to filter results by. | creatorName | string | Name of the token creator to filter results by. |

Return type

OrganizationApiTokenResponseList

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]