Skip to content

Latest commit

 

History

History
185 lines (131 loc) · 6.53 KB

SubscriptionGroupsApi.md

File metadata and controls

185 lines (131 loc) · 6.53 KB

fastreport_cloud_sdk.SubscriptionGroupsApi

All URIs are relative to http://localhost

Method HTTP request Description
subscription_groups_count_groups_async GET /api/manage/v1/Subscriptions/{subscriptionId}/count Returns a number of groups in subscription
subscription_groups_get_groups_list GET /api/manage/v1/Subscriptions/{subscriptionId}/groups returns groups of the subscription or subscription user

subscription_groups_count_groups_async

int subscription_groups_count_groups_async(subscription_id)

Returns a number of groups in subscription

Example

  • Basic Authentication (ApiKey):
  • Bearer (JWT) Authentication (JWT):
import fastreport_cloud_sdk
from fastreport_cloud_sdk.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 = fastreport_cloud_sdk.Configuration(
    host = "http://localhost"
)

# 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 HTTP basic authorization: ApiKey
configuration = fastreport_cloud_sdk.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

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

# Enter a context with an instance of the API client
with fastreport_cloud_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = fastreport_cloud_sdk.SubscriptionGroupsApi(api_client)
    subscription_id = 'subscription_id_example' # str | subscripiton id

    try:
        # Returns a number of groups in subscription
        api_response = api_instance.subscription_groups_count_groups_async(subscription_id)
        print("The response of SubscriptionGroupsApi->subscription_groups_count_groups_async:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SubscriptionGroupsApi->subscription_groups_count_groups_async: %s\n" % e)

Parameters

Name Type Description Notes
subscription_id str subscripiton id

Return type

int

Authorization

ApiKey, JWT

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Everything is all right -
400 id is not hex24 -
402 Subscription is blocked -
403 You don't have permission to get groups from this subscription (or in your default (1st) subscription) -
404 there is no subscription with provided id found, or user don't even have a subscription -

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

subscription_groups_get_groups_list

GroupsVM subscription_groups_get_groups_list(subscription_id, user_id=user_id)

returns groups of the subscription or subscription user

Example

  • Basic Authentication (ApiKey):
  • Bearer (JWT) Authentication (JWT):
import fastreport_cloud_sdk
from fastreport_cloud_sdk.models.groups_vm import GroupsVM
from fastreport_cloud_sdk.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 = fastreport_cloud_sdk.Configuration(
    host = "http://localhost"
)

# 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 HTTP basic authorization: ApiKey
configuration = fastreport_cloud_sdk.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

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

# Enter a context with an instance of the API client
with fastreport_cloud_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = fastreport_cloud_sdk.SubscriptionGroupsApi(api_client)
    subscription_id = 'subscription_id_example' # str | subscripiton id
    user_id = 'user_id_example' # str | user Id (optional) (optional)

    try:
        # returns groups of the subscription or subscription user
        api_response = api_instance.subscription_groups_get_groups_list(subscription_id, user_id=user_id)
        print("The response of SubscriptionGroupsApi->subscription_groups_get_groups_list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SubscriptionGroupsApi->subscription_groups_get_groups_list: %s\n" % e)

Parameters

Name Type Description Notes
subscription_id str subscripiton id
user_id str user Id (optional) [optional]

Return type

GroupsVM

Authorization

ApiKey, JWT

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Everything is all right (list of groups may be empty) -
400 id is not hex24 -
402 Subscription is blocked -
403 You don't have permission to get groups from this subscription (or in your default (1st) subscription) -
404 there is no subscription with provided id found, or user don't even have a subscription -

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