OrganizationsAPI.md

\OrganizationsAPI

All URIs are relative to https://dashboard.quantcdn.io

Method	HTTP request	Description
OrganizationsList	Get /api/v2/organizations	Retrieve all organizations
OrganizationsRead	Get /api/v2/organizations/{organization}	Get details of a single organization

OrganizationsList

[]OrganizationsList200ResponseInner OrganizationsList(ctx).Execute()

Retrieve all organizations

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/quantcdn/quant-admin-go"
)

func main() {

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

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

[]OrganizationsList200ResponseInner

Authorization

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]

OrganizationsRead

V2Organization OrganizationsRead(ctx, organization).Execute()

Get details of a single organization

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/quantcdn/quant-admin-go"
)

func main() {
	organization := "test-org" // string | Organization identifier

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

Path Parameters

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

Other Parameters

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

Name	Type	Description	Notes

Return type

V2Organization

Authorization

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]