Skip to content

Latest commit

 

History

History
259 lines (180 loc) · 8.58 KB

UserProfileApi.md

File metadata and controls

259 lines (180 loc) · 8.58 KB

fastreport_cloud_sdk.UserProfileApi

All URIs are relative to http://localhost

Method HTTP request Description
user_profile_get_my_profile GET /api/manage/v1/UserProfile Return current profile of the current user
user_profile_get_user_profile GET /api/manage/v1/UserProfile/{userId} Return user profile by user identifier. If the user did not provide information about himself or blocked, then the endpoint will return an empty model. (only id)
user_profile_update_my_profile PUT /api/manage/v1/UserProfile Update profile of the current user

user_profile_get_my_profile

UserProfileVM user_profile_get_my_profile()

Return current profile of the current user

Example

  • Basic Authentication (ApiKey):
  • Bearer (JWT) Authentication (JWT):
import fastreport_cloud_sdk
from fastreport_cloud_sdk.models.user_profile_vm import UserProfileVM
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.UserProfileApi(api_client)

    try:
        # Return current profile of the current user
        api_response = api_instance.user_profile_get_my_profile()
        print("The response of UserProfileApi->user_profile_get_my_profile:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UserProfileApi->user_profile_get_my_profile: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

UserProfileVM

Authorization

ApiKey, JWT

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Succesfully returned -

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

user_profile_get_user_profile

UserProfileVM user_profile_get_user_profile(user_id)

Return user profile by user identifier. If the user did not provide information about himself or blocked, then the endpoint will return an empty model. (only id)

Example

  • Basic Authentication (ApiKey):
  • Bearer (JWT) Authentication (JWT):
import fastreport_cloud_sdk
from fastreport_cloud_sdk.models.user_profile_vm import UserProfileVM
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.UserProfileApi(api_client)
    user_id = 'user_id_example' # str | 

    try:
        # Return user profile by user identifier.  If the user did not provide information about himself or blocked, then the endpoint will return an empty model. (only id)
        api_response = api_instance.user_profile_get_user_profile(user_id)
        print("The response of UserProfileApi->user_profile_get_user_profile:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UserProfileApi->user_profile_get_user_profile: %s\n" % e)

Parameters

Name Type Description Notes
user_id str

Return type

UserProfileVM

Authorization

ApiKey, JWT

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Succesfully returned -
404 User not found -

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

user_profile_update_my_profile

user_profile_update_my_profile(update_user_profile_vm=update_user_profile_vm)

Update profile of the current user

This method is only allowed for local sign in via intranet

Example

  • Basic Authentication (ApiKey):
  • Bearer (JWT) Authentication (JWT):
import fastreport_cloud_sdk
from fastreport_cloud_sdk.models.update_user_profile_vm import UpdateUserProfileVM
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.UserProfileApi(api_client)
    update_user_profile_vm = fastreport_cloud_sdk.UpdateUserProfileVM() # UpdateUserProfileVM |  (optional)

    try:
        # Update profile of the current user
        api_instance.user_profile_update_my_profile(update_user_profile_vm=update_user_profile_vm)
    except Exception as e:
        print("Exception when calling UserProfileApi->user_profile_update_my_profile: %s\n" % e)

Parameters

Name Type Description Notes
update_user_profile_vm UpdateUserProfileVM [optional]

Return type

void (empty response body)

Authorization

ApiKey, JWT

HTTP request headers

  • Content-Type: application/json, text/json, application/*+json
  • Accept: application/json

HTTP response details

Status code Description Response headers
204 No Content -
400 The request is wrong -
200 Succesfully updated -

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