Skip to content

Latest commit

 

History

History
163 lines (112 loc) · 5.08 KB

OrganizationsApi.md

File metadata and controls

163 lines (112 loc) · 5.08 KB

quantcdn.OrganizationsApi

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

Method HTTP request Description
organizations_list GET /api/v2/organizations Retrieve all organizations
organizations_read GET /api/v2/organizations/{organization} Get details of a single organization

organizations_list

List[OrganizationsList200ResponseInner] organizations_list()

Retrieve all organizations

Example

  • Bearer (JWT) Authentication (BearerAuth):
import quantcdn
from quantcdn.models.organizations_list200_response_inner import OrganizationsList200ResponseInner
from quantcdn.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://dashboard.quantcdn.io
# See configuration.py for a list of all supported configuration parameters.
configuration = quantcdn.Configuration(
    host = "https://dashboard.quantcdn.io"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): BearerAuth
configuration = quantcdn.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with quantcdn.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = quantcdn.OrganizationsApi(api_client)

    try:
        # Retrieve all organizations
        api_response = api_instance.organizations_list()
        print("The response of OrganizationsApi->organizations_list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling OrganizationsApi->organizations_list: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

List[OrganizationsList200ResponseInner]

Authorization

BearerAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 The request has succeeded. -
400 The server could not understand the request due to invalid syntax. -
403 Access is forbidden. -

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

organizations_read

V2Organization organizations_read(organization)

Get details of a single organization

Example

  • Bearer (JWT) Authentication (BearerAuth):
import quantcdn
from quantcdn.models.v2_organization import V2Organization
from quantcdn.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://dashboard.quantcdn.io
# See configuration.py for a list of all supported configuration parameters.
configuration = quantcdn.Configuration(
    host = "https://dashboard.quantcdn.io"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): BearerAuth
configuration = quantcdn.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with quantcdn.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = quantcdn.OrganizationsApi(api_client)
    organization = 'test-org' # str | Organization identifier

    try:
        # Get details of a single organization
        api_response = api_instance.organizations_read(organization)
        print("The response of OrganizationsApi->organizations_read:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling OrganizationsApi->organizations_read: %s\n" % e)

Parameters

Name Type Description Notes
organization str Organization identifier

Return type

V2Organization

Authorization

BearerAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 The request has succeeded. -
404 Organization not found. -
400 The server could not understand the request due to invalid syntax. -
403 Access is forbidden. -

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