Skip to content

Latest commit

 

History

History
174 lines (127 loc) · 5.91 KB

PlatformApi.md

File metadata and controls

174 lines (127 loc) · 5.91 KB
Raw

frontier_api.PlatformApi

All URIs are relative to http://127.0.0.1:7400

Method HTTP request Description
admin_service_add_platform_user POST /v1beta1/admin/platform/users Add platform user
admin_service_list_platform_users GET /v1beta1/admin/platform/users List platform users

admin_service_add_platform_user

object admin_service_add_platform_user(body)

Add platform user

Adds a user to the platform.

Example

  • Basic Authentication (Basic):
import time
import os
import frontier_api
from frontier_api.models.v1beta1_add_platform_user_request import V1beta1AddPlatformUserRequest
from frontier_api.rest import ApiException
from pprint import pprint

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

# 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: Basic
configuration = frontier_api.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with frontier_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = frontier_api.PlatformApi(api_client)
    body = frontier_api.V1beta1AddPlatformUserRequest() # V1beta1AddPlatformUserRequest | 

    try:
        # Add platform user
        api_response = api_instance.admin_service_add_platform_user(body)
        print("The response of PlatformApi->admin_service_add_platform_user:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PlatformApi->admin_service_add_platform_user: %s\n" % e)

Parameters

Name Type Description Notes
body V1beta1AddPlatformUserRequest

Return type

object

Authorization

Basic

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 A successful response. -
400 Bad Request - The request was malformed or contained invalid parameters. -
401 Unauthorized - Authentication is required -
403 Forbidden - User does not have permission to access the resource -
404 Not Found - The requested resource was not found -
500 Internal Server Error. Returned when theres is something wrong with Frontier server. -
0 An unexpected error response. -

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

admin_service_list_platform_users

V1beta1ListPlatformUsersResponse admin_service_list_platform_users()

List platform users

Lists all the users added to the platform.

Example

  • Basic Authentication (Basic):
import time
import os
import frontier_api
from frontier_api.models.v1beta1_list_platform_users_response import V1beta1ListPlatformUsersResponse
from frontier_api.rest import ApiException
from pprint import pprint

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

# 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: Basic
configuration = frontier_api.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

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

    try:
        # List platform users
        api_response = api_instance.admin_service_list_platform_users()
        print("The response of PlatformApi->admin_service_list_platform_users:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PlatformApi->admin_service_list_platform_users: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

V1beta1ListPlatformUsersResponse

Authorization

Basic

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 A successful response. -
400 Bad Request - The request was malformed or contained invalid parameters. -
401 Unauthorized - Authentication is required -
403 Forbidden - User does not have permission to access the resource -
404 Not Found - The requested resource was not found -
500 Internal Server Error. Returned when theres is something wrong with Frontier server. -
0 An unexpected error response. -

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