Skip to content

Latest commit

 

History

History
82 lines (54 loc) · 2.65 KB

OrganizationApi.md

File metadata and controls

82 lines (54 loc) · 2.65 KB

flightctl.OrganizationApi

All URIs are relative to http://localhost

Method HTTP request Description
list_organizations GET /api/v1/organizations List organizations

list_organizations

OrganizationList list_organizations(field_selector=field_selector)

List organizations

Retrieves a list of organizations. Only returns organizations that the user has access to.

Example

import flightctl
from flightctl.models.organization_list import OrganizationList
from flightctl.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = flightctl.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with flightctl.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = flightctl.OrganizationApi(api_client)
    field_selector = 'field_selector_example' # str | A selector to restrict the list of returned objects by their fields, supporting operators like '=', '==', and '!=' (e.g., \"key1=value1,key2!=value2\"). (optional)

    try:
        # List organizations
        api_response = api_instance.list_organizations(field_selector=field_selector)
        print("The response of OrganizationApi->list_organizations:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling OrganizationApi->list_organizations: %s\n" % e)

Parameters

Name Type Description Notes
field_selector str A selector to restrict the list of returned objects by their fields, supporting operators like '=', '==', and '!=' (e.g., "key1=value1,key2!=value2"). [optional]

Return type

OrganizationList

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 OK -
400 Bad Request -
401 Unauthorized -
403 Forbidden -
429 Too Many Requests -
503 Service Unavailable -

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