Skip to content

Latest commit

 

History

History
446 lines (317 loc) · 15.2 KB

SubscriptionUsersApi.md

File metadata and controls

446 lines (317 loc) · 15.2 KB

fastreport_cloud_sdk.SubscriptionUsersApi

All URIs are relative to http://localhost

Method HTTP request Description
subscription_users_add_user PUT /api/manage/v1/Subscriptions/{subscriptionId}/users/{userId} Add a user to the subscription, the added users will be displayed in the list of users of the subscription, and these users will also have an active subscription.
subscription_users_count_users_async GET /api/manage/v1/Subscriptions/{subscriptionId}/UsersCount Returns a number of users in subscription
subscription_users_get_users GET /api/manage/v1/Subscriptions/{subscriptionId}/users Returns all users of subscription
subscription_users_leave_subscripiton DELETE /api/manage/v1/Subscriptions/{subscriptionId}/leave Allows user to leave subscription,.
subscription_users_remove_user DELETE /api/manage/v1/Subscriptions/{subscriptionId}/users/{userId} Delete a user from the subscription,

subscription_users_add_user

subscription_users_add_user(subscription_id, user_id)

Add a user to the subscription, the added users will be displayed in the list of users of the subscription, and these users will also have an active 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.SubscriptionUsersApi(api_client)
    subscription_id = 'subscription_id_example' # str | Idenitifier of subscription
    user_id = 'user_id_example' # str | Idenitifier of user

    try:
        # Add a user to the subscription,  the added users will be displayed in the list of users of the subscription,  and these users will also have an active subscription.
        api_instance.subscription_users_add_user(subscription_id, user_id)
    except Exception as e:
        print("Exception when calling SubscriptionUsersApi->subscription_users_add_user: %s\n" % e)

Parameters

Name Type Description Notes
subscription_id str Idenitifier of subscription
user_id str Idenitifier of user

Return type

void (empty response body)

Authorization

ApiKey, JWT

HTTP request headers

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

HTTP response details

Status code Description Response headers
204 Succesfully added -
400 The request is wrong -
402 Subscription is outdated -
403 You don't have permissions for the operation -
404 Subscription or user is not found -

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

subscription_users_count_users_async

int subscription_users_count_users_async(subscription_id)

Returns a number of users 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.SubscriptionUsersApi(api_client)
    subscription_id = 'subscription_id_example' # str | 

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

Parameters

Name Type Description Notes
subscription_id str

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 Succesfully returned -
400 The request is wrong -
402 Subscription is outdated -
403 You don't have permissions for the operation -
404 Subscription is not found -

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

subscription_users_get_users

SubscriptionUsersVM subscription_users_get_users(subscription_id, skip=skip, take=take)

Returns all users of subscription

Example

  • Basic Authentication (ApiKey):
  • Bearer (JWT) Authentication (JWT):
import fastreport_cloud_sdk
from fastreport_cloud_sdk.models.subscription_users_vm import SubscriptionUsersVM
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.SubscriptionUsersApi(api_client)
    subscription_id = 'subscription_id_example' # str | Idenitifier of subscription
    skip = 0 # int | How many entities skip (optional) (default to 0)
    take = 10 # int | How many entities take (optional) (default to 10)

    try:
        # Returns all users of subscription
        api_response = api_instance.subscription_users_get_users(subscription_id, skip=skip, take=take)
        print("The response of SubscriptionUsersApi->subscription_users_get_users:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SubscriptionUsersApi->subscription_users_get_users: %s\n" % e)

Parameters

Name Type Description Notes
subscription_id str Idenitifier of subscription
skip int How many entities skip [optional] [default to 0]
take int How many entities take [optional] [default to 10]

Return type

SubscriptionUsersVM

Authorization

ApiKey, JWT

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Succesfully returned -
400 The request is wrong -
402 Subscription is outdated -
403 You don't have permissions for the operation -
404 Subscription is not found -

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

subscription_users_leave_subscripiton

subscription_users_leave_subscripiton(subscription_id)

Allows user to leave 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.SubscriptionUsersApi(api_client)
    subscription_id = 'subscription_id_example' # str | Idenitifier of subscription

    try:
        # Allows user to leave subscription,.
        api_instance.subscription_users_leave_subscripiton(subscription_id)
    except Exception as e:
        print("Exception when calling SubscriptionUsersApi->subscription_users_leave_subscripiton: %s\n" % e)

Parameters

Name Type Description Notes
subscription_id str Idenitifier of subscription

Return type

void (empty response body)

Authorization

ApiKey, JWT

HTTP request headers

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

HTTP response details

Status code Description Response headers
204 Succesfully deleted -
400 The request is wrong -
401 User is unauthorized -
402 Subscription id outdated -
404 Subscription or user is not found -

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

subscription_users_remove_user

subscription_users_remove_user(subscription_id, user_id)

Delete a user from the 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.SubscriptionUsersApi(api_client)
    subscription_id = 'subscription_id_example' # str | Idenitifier of subscription
    user_id = 'user_id_example' # str | Idenitifier of user

    try:
        # Delete a user from the subscription,
        api_instance.subscription_users_remove_user(subscription_id, user_id)
    except Exception as e:
        print("Exception when calling SubscriptionUsersApi->subscription_users_remove_user: %s\n" % e)

Parameters

Name Type Description Notes
subscription_id str Idenitifier of subscription
user_id str Idenitifier of user

Return type

void (empty response body)

Authorization

ApiKey, JWT

HTTP request headers

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

HTTP response details

Status code Description Response headers
204 Succesfully deleted -
400 The request is wrong -
402 Subscription id outdated -
403 You don't have permissions for the operation -
404 Subscription or user is not found -

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