Skip to content

Latest commit

 

History

History
160 lines (107 loc) · 5.41 KB

ConsoleUserApi.md

File metadata and controls

160 lines (107 loc) · 5.41 KB
Raw

fireblocks.ConsoleUserApi

All URIs are relative to https://api.fireblocks.io/v1

Method HTTP request Description
create_console_user POST /management/users Create console user
get_console_users GET /management/users Get console users

create_console_user

create_console_user(idempotency_key=idempotency_key, create_console_user=create_console_user)

Create console user

Creates console user in your tenant

Example

from fireblocks.models.create_console_user import CreateConsoleUser
from fireblocks.client import Fireblocks
from fireblocks.client_configuration import ClientConfiguration
from fireblocks.exceptions import ApiException
from fireblocks.base_path import BasePath

# load the secret key content from a file
with open('your_secret_key_file_path', 'r') as file:
    secret_key_value = file.read()

# build the configuration
configuration = ClientConfiguration(
        api_key="your_api_key",
        secret_key=secret_key_value,
        base_path=BasePath.Sandbox, # or set it directly to a string "https://sandbox-api.fireblocks.io/v1"
)


# Enter a context with an instance of the API client
with Fireblocks(configuration) as fireblocks:
    idempotency_key = 'idempotency_key_example' # str | A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. (optional)
    create_console_user = fireblocks.CreateConsoleUser() # CreateConsoleUser |  (optional)

    try:
        # Create console user
        fireblocks.console_user.create_console_user(idempotency_key=idempotency_key, create_console_user=create_console_user).result()
    except Exception as e:
        print("Exception when calling ConsoleUserApi->create_console_user: %s\n" % e)

Parameters

Name Type Description Notes
idempotency_key str A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. [optional]
create_console_user CreateConsoleUser [optional]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 User creation approval request has been sent * X-Request-ID -
400 bad request * X-Request-ID -
401 Unauthorized. Missing / invalid JWT token in Authorization header. * X-Request-ID -
403 Lacking permissions. * X-Request-ID -
5XX Internal error. * X-Request-ID -
0 Error Response * X-Request-ID -

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

get_console_users

GetConsoleUsersResponse get_console_users()

Get console users

Get console users for your tenant

Example

from fireblocks.models.get_console_users_response import GetConsoleUsersResponse
from fireblocks.client import Fireblocks
from fireblocks.client_configuration import ClientConfiguration
from fireblocks.exceptions import ApiException
from fireblocks.base_path import BasePath
from pprint import pprint

# load the secret key content from a file
with open('your_secret_key_file_path', 'r') as file:
    secret_key_value = file.read()

# build the configuration
configuration = ClientConfiguration(
        api_key="your_api_key",
        secret_key=secret_key_value,
        base_path=BasePath.Sandbox, # or set it directly to a string "https://sandbox-api.fireblocks.io/v1"
)


# Enter a context with an instance of the API client
with Fireblocks(configuration) as fireblocks:

    try:
        # Get console users
        api_response = fireblocks.console_user.get_console_users().result()
        print("The response of ConsoleUserApi->get_console_users:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ConsoleUserApi->get_console_users: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

GetConsoleUsersResponse

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 got console users * X-Request-ID -
401 Unauthorized. Missing / invalid JWT token in Authorization header. * X-Request-ID -
403 Lacking permissions. * X-Request-ID -
5XX Internal error. * X-Request-ID -
0 Error Response * X-Request-ID -

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